001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.bean.html5;
018
019import org.apache.juneau.annotation.*;
020import org.apache.juneau.internal.*;
021
022/**
023 * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/grouping-content.html#the-ol-element">&lt;ol&gt;</a>
024 * element.
025 *
026 * <p>
027 * The ol element represents an ordered list of items. It contains li elements that represent
028 * individual list items. The list items are typically numbered automatically by the browser,
029 * and the numbering can be customized using the type and start attributes.
030 *
031 * <h5 class='section'>Examples:</h5>
032 * <p class='bcode w800'>
033 *    <jk>import static</jk> org.apache.juneau.bean.html5.HtmlBuilder.*;
034 * 
035 *    <jc>// Simple ordered list</jc>
036 *    Ol <jv>ol1</jv> = <jsm>ol</jsm>(
037 *       <jsm>li</jsm>(<js>"First item"</js>),
038 *       <jsm>li</jsm>(<js>"Second item"</js>),
039 *       <jsm>li</jsm>(<js>"Third item"</js>)
040 *    );
041 * 
042 *    <jc>// Ordered list with custom numbering</jc>
043 *    Ol <jv>ol2</jv> = <jsm>ol</jsm>(
044 *       <jsm>li</jsm>(<js>"Item A"</js>),
045 *       <jsm>li</jsm>(<js>"Item B"</js>),
046 *       <jsm>li</jsm>(<js>"Item C"</js>)
047 *    ).type(<js>"A"</js>).start(1);
048 * 
049 *    <jc>// Reversed ordered list</jc>
050 *    Ol <jv>ol3</jv> = <jsm>ol</jsm>(
051 *       <jsm>li</jsm>(<js>"Last item"</js>),
052 *       <jsm>li</jsm>(<js>"Middle item"</js>),
053 *       <jsm>li</jsm>(<js>"First item"</js>)
054 *    ).reversed(<jk>true</jk>);
055 * 
056 *    <jc>// Nested ordered list</jc>
057 *    Ol <jv>ol4</jv> = <jsm>ol</jsm>(
058 *       <jsm>li</jsm>(<js>"Main item 1"</js>),
059 *       <jsm>li</jsm>(
060 *          <jsm>ol</jsm>(
061 *             <jsm>li</jsm>(<js>"Sub item 1.1"</js>),
062 *             <jsm>li</jsm>(<js>"Sub item 1.2"</js>)
063 *          )
064 *       ),
065 *       <jsm>li</jsm>(<js>"Main item 2"</js>)
066 *    );
067 * </p>
068 *
069 * <p>
070 * The following convenience methods are provided for constructing instances of this bean:
071 * <ul class='javatree'>
072 *    <li class='jc'>{@link HtmlBuilder}
073 *    <ul class='javatree'>
074 *       <li class='jm'>{@link HtmlBuilder#ol() ol()}
075 *       <li class='jm'>{@link HtmlBuilder#ol(Object, Object...) ol(Object, Object...)}
076 *    </ul>
077 * </ul>
078 * </p>
079 *
080 * <h5 class='section'>See Also:</h5><ul>
081 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauBeanHtml5">juneau-bean-html5</a>
082 * </ul>
083 */
084@Bean(typeName="ol")
085public class Ol extends HtmlElementContainer {
086
087   /**
088    * Creates an empty {@link Ol} element.
089    */
090   public Ol() {}
091
092   /**
093    * Creates an {@link Ol} element with the specified child nodes.
094    *
095    * @param children The child nodes.
096    */
097   public Ol(Object...children) {
098      children(children);
099   }
100
101   /**
102    * <a class="doclink" href="https://www.w3.org/TR/html5/grouping-content.html#attr-ol-reversed">reversed</a>
103    * attribute.
104    *
105    * <p>
106    * Number the list backwards..
107    *
108    * <p>
109    * This attribute uses deminimized values:
110    * <ul>
111    *    <li><jk>false</jk> - Attribute is not added</li>
112    *    <li><jk>true</jk> - Attribute is added as <js>"reversed"</js></li>
113    *    <li>Other values - Passed through as-is</li>
114    * </ul>
115    *
116    * @param reversed
117    *    The new value for this attribute.
118    *    Typically a {@link Boolean} or {@link String}.
119    * @return This object.
120    */
121   public Ol reversed(Object value) {
122      attr("reversed", deminimize(value, "reversed"));
123      return this;
124   }
125
126   /**
127    * <a class="doclink" href="https://www.w3.org/TR/html5/grouping-content.html#attr-ol-start">start</a> attribute.
128    *
129    * <p>
130    * Ordinal value of the first item.
131    *
132    * @param start
133    *    The new value for this attribute.
134    *    Typically a {@link Number} or {@link String}.
135    * @return This object.
136    */
137   public Ol start(Object value) {
138      attr("start", value);
139      return this;
140   }
141
142   /**
143    * <a class="doclink" href="https://www.w3.org/TR/html5/grouping-content.html#attr-ol-type">type</a> attribute.
144    *
145    * <p>
146    * Specifies the type of numbering to use for the ordered list items.
147    *
148    * <p>
149    * Possible values:
150    * <ul>
151    *    <li><js>"1"</js> - Decimal numbers (1, 2, 3, ...) - default</li>
152    *    <li><js>"a"</js> - Lowercase letters (a, b, c, ...)</li>
153    *    <li><js>"A"</js> - Uppercase letters (A, B, C, ...)</li>
154    *    <li><js>"i"</js> - Lowercase Roman numerals (i, ii, iii, ...)</li>
155    *    <li><js>"I"</js> - Uppercase Roman numerals (I, II, III, ...)</li>
156    * </ul>
157    *
158    * @param type The type of numbering for the ordered list.
159    * @return This object.
160    */
161   public Ol type(String value) {
162      attr("type", value);
163      return this;
164   }
165
166   //-----------------------------------------------------------------------------------------------------------------
167   // Overridden methods
168   //-----------------------------------------------------------------------------------------------------------------
169   @Override /* Overridden from HtmlElement */
170   public Ol _class(String value) {  // NOSONAR - Intentional naming.
171      super._class(value);
172      return this;
173   }
174
175   @Override /* Overridden from HtmlElement */
176   public Ol accesskey(String value) {
177      super.accesskey(value);
178      return this;
179   }
180
181   @Override /* Overridden from HtmlElement */
182   public Ol contenteditable(Object value) {
183      super.contenteditable(value);
184      return this;
185   }
186
187   @Override /* Overridden from HtmlElement */
188   public Ol dir(String value) {
189      super.dir(value);
190      return this;
191   }
192
193   @Override /* Overridden from HtmlElement */
194   public Ol hidden(Object value) {
195      super.hidden(value);
196      return this;
197   }
198
199   @Override /* Overridden from HtmlElement */
200   public Ol id(String value) {
201      super.id(value);
202      return this;
203   }
204
205   @Override /* Overridden from HtmlElement */
206   public Ol lang(String value) {
207      super.lang(value);
208      return this;
209   }
210
211   @Override /* Overridden from HtmlElement */
212   public Ol onabort(String value) {
213      super.onabort(value);
214      return this;
215   }
216
217   @Override /* Overridden from HtmlElement */
218   public Ol onblur(String value) {
219      super.onblur(value);
220      return this;
221   }
222
223   @Override /* Overridden from HtmlElement */
224   public Ol oncancel(String value) {
225      super.oncancel(value);
226      return this;
227   }
228
229   @Override /* Overridden from HtmlElement */
230   public Ol oncanplay(String value) {
231      super.oncanplay(value);
232      return this;
233   }
234
235   @Override /* Overridden from HtmlElement */
236   public Ol oncanplaythrough(String value) {
237      super.oncanplaythrough(value);
238      return this;
239   }
240
241   @Override /* Overridden from HtmlElement */
242   public Ol onchange(String value) {
243      super.onchange(value);
244      return this;
245   }
246
247   @Override /* Overridden from HtmlElement */
248   public Ol onclick(String value) {
249      super.onclick(value);
250      return this;
251   }
252
253   @Override /* Overridden from HtmlElement */
254   public Ol oncuechange(String value) {
255      super.oncuechange(value);
256      return this;
257   }
258
259   @Override /* Overridden from HtmlElement */
260   public Ol ondblclick(String value) {
261      super.ondblclick(value);
262      return this;
263   }
264
265   @Override /* Overridden from HtmlElement */
266   public Ol ondurationchange(String value) {
267      super.ondurationchange(value);
268      return this;
269   }
270
271   @Override /* Overridden from HtmlElement */
272   public Ol onemptied(String value) {
273      super.onemptied(value);
274      return this;
275   }
276
277   @Override /* Overridden from HtmlElement */
278   public Ol onended(String value) {
279      super.onended(value);
280      return this;
281   }
282
283   @Override /* Overridden from HtmlElement */
284   public Ol onerror(String value) {
285      super.onerror(value);
286      return this;
287   }
288
289   @Override /* Overridden from HtmlElement */
290   public Ol onfocus(String value) {
291      super.onfocus(value);
292      return this;
293   }
294
295   @Override /* Overridden from HtmlElement */
296   public Ol oninput(String value) {
297      super.oninput(value);
298      return this;
299   }
300
301   @Override /* Overridden from HtmlElement */
302   public Ol oninvalid(String value) {
303      super.oninvalid(value);
304      return this;
305   }
306
307   @Override /* Overridden from HtmlElement */
308   public Ol onkeydown(String value) {
309      super.onkeydown(value);
310      return this;
311   }
312
313   @Override /* Overridden from HtmlElement */
314   public Ol onkeypress(String value) {
315      super.onkeypress(value);
316      return this;
317   }
318
319   @Override /* Overridden from HtmlElement */
320   public Ol onkeyup(String value) {
321      super.onkeyup(value);
322      return this;
323   }
324
325   @Override /* Overridden from HtmlElement */
326   public Ol onload(String value) {
327      super.onload(value);
328      return this;
329   }
330
331   @Override /* Overridden from HtmlElement */
332   public Ol onloadeddata(String value) {
333      super.onloadeddata(value);
334      return this;
335   }
336
337   @Override /* Overridden from HtmlElement */
338   public Ol onloadedmetadata(String value) {
339      super.onloadedmetadata(value);
340      return this;
341   }
342
343   @Override /* Overridden from HtmlElement */
344   public Ol onloadstart(String value) {
345      super.onloadstart(value);
346      return this;
347   }
348
349   @Override /* Overridden from HtmlElement */
350   public Ol onmousedown(String value) {
351      super.onmousedown(value);
352      return this;
353   }
354
355   @Override /* Overridden from HtmlElement */
356   public Ol onmouseenter(String value) {
357      super.onmouseenter(value);
358      return this;
359   }
360
361   @Override /* Overridden from HtmlElement */
362   public Ol onmouseleave(String value) {
363      super.onmouseleave(value);
364      return this;
365   }
366
367   @Override /* Overridden from HtmlElement */
368   public Ol onmousemove(String value) {
369      super.onmousemove(value);
370      return this;
371   }
372
373   @Override /* Overridden from HtmlElement */
374   public Ol onmouseout(String value) {
375      super.onmouseout(value);
376      return this;
377   }
378
379   @Override /* Overridden from HtmlElement */
380   public Ol onmouseover(String value) {
381      super.onmouseover(value);
382      return this;
383   }
384
385   @Override /* Overridden from HtmlElement */
386   public Ol onmouseup(String value) {
387      super.onmouseup(value);
388      return this;
389   }
390
391   @Override /* Overridden from HtmlElement */
392   public Ol onmousewheel(String value) {
393      super.onmousewheel(value);
394      return this;
395   }
396
397   @Override /* Overridden from HtmlElement */
398   public Ol onpause(String value) {
399      super.onpause(value);
400      return this;
401   }
402
403   @Override /* Overridden from HtmlElement */
404   public Ol onplay(String value) {
405      super.onplay(value);
406      return this;
407   }
408
409   @Override /* Overridden from HtmlElement */
410   public Ol onplaying(String value) {
411      super.onplaying(value);
412      return this;
413   }
414
415   @Override /* Overridden from HtmlElement */
416   public Ol onprogress(String value) {
417      super.onprogress(value);
418      return this;
419   }
420
421   @Override /* Overridden from HtmlElement */
422   public Ol onratechange(String value) {
423      super.onratechange(value);
424      return this;
425   }
426
427   @Override /* Overridden from HtmlElement */
428   public Ol onreset(String value) {
429      super.onreset(value);
430      return this;
431   }
432
433   @Override /* Overridden from HtmlElement */
434   public Ol onresize(String value) {
435      super.onresize(value);
436      return this;
437   }
438
439   @Override /* Overridden from HtmlElement */
440   public Ol onscroll(String value) {
441      super.onscroll(value);
442      return this;
443   }
444
445   @Override /* Overridden from HtmlElement */
446   public Ol onseeked(String value) {
447      super.onseeked(value);
448      return this;
449   }
450
451   @Override /* Overridden from HtmlElement */
452   public Ol onseeking(String value) {
453      super.onseeking(value);
454      return this;
455   }
456
457   @Override /* Overridden from HtmlElement */
458   public Ol onselect(String value) {
459      super.onselect(value);
460      return this;
461   }
462
463   @Override /* Overridden from HtmlElement */
464   public Ol onshow(String value) {
465      super.onshow(value);
466      return this;
467   }
468
469   @Override /* Overridden from HtmlElement */
470   public Ol onstalled(String value) {
471      super.onstalled(value);
472      return this;
473   }
474
475   @Override /* Overridden from HtmlElement */
476   public Ol onsubmit(String value) {
477      super.onsubmit(value);
478      return this;
479   }
480
481   @Override /* Overridden from HtmlElement */
482   public Ol onsuspend(String value) {
483      super.onsuspend(value);
484      return this;
485   }
486
487   @Override /* Overridden from HtmlElement */
488   public Ol ontimeupdate(String value) {
489      super.ontimeupdate(value);
490      return this;
491   }
492
493   @Override /* Overridden from HtmlElement */
494   public Ol ontoggle(String value) {
495      super.ontoggle(value);
496      return this;
497   }
498
499   @Override /* Overridden from HtmlElement */
500   public Ol onvolumechange(String value) {
501      super.onvolumechange(value);
502      return this;
503   }
504
505   @Override /* Overridden from HtmlElement */
506   public Ol onwaiting(String value) {
507      super.onwaiting(value);
508      return this;
509   }
510
511   @Override /* Overridden from HtmlElement */
512   public Ol spellcheck(Object value) {
513      super.spellcheck(value);
514      return this;
515   }
516
517   @Override /* Overridden from HtmlElement */
518   public Ol style(String value) {
519      super.style(value);
520      return this;
521   }
522
523   @Override /* Overridden from HtmlElement */
524   public Ol tabindex(Object value) {
525      super.tabindex(value);
526      return this;
527   }
528
529   @Override /* Overridden from HtmlElement */
530   public Ol title(String value) {
531      super.title(value);
532      return this;
533   }
534
535   @Override /* Overridden from HtmlElement */
536   public Ol translate(Object value) {
537      super.translate(value);
538      return this;
539   }
540
541   @Override /* Overridden from HtmlElementContainer */
542   public Ol child(Object value) {
543      super.child(value);
544      return this;
545   }
546
547   @Override /* Overridden from HtmlElementContainer */
548   public Ol children(Object...value) {
549      super.children(value);
550      return this;
551   }
552}