Source code

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 static org.apache.juneau.xml.annotation.XmlFormat.*;
020
021import java.util.*;
022
023import org.apache.juneau.*;
024import org.apache.juneau.annotation.*;
025import org.apache.juneau.internal.*;
026import org.apache.juneau.xml.annotation.*;
027
028/**
029 * A subclass of HTML elements that contain only other elements, not text.
030 *
031 * <h5 class='section'>See Also:</h5><ul>
032 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauBeanHtml5">juneau-bean-html5</a>
033 * </ul>
034 */
035public class HtmlElementContainer extends HtmlElement {
036
037   private List<Object> children;
038
039   @Override /* Overridden from HtmlElement */
040   public HtmlElementContainer _class(String value) { // NOSONAR - Intentional naming.
041      super._class(value);
042      return this;
043   }
044
045   @Override /* Overridden from HtmlElement */
046   public HtmlElementContainer accesskey(String value) {
047      super.accesskey(value);
048      return this;
049   }
050
051   @Override /* Overridden from HtmlElement */
052   public HtmlElementContainer attr(String key, Object val) {
053      super.attr(key, val);
054      return this;
055   }
056
057   @Override /* Overridden from HtmlElement */
058   public HtmlElementContainer attrUri(String key, Object val) {
059      super.attrUri(key, val);
060      return this;
061   }
062
063   /**
064    * Adds a child element to this element.
065    *
066    * @param value The child to add as a child element.
067    * @return This object.
068    */
069   public HtmlElement child(Object value) {
070      if (this.children == null)
071         this.children = new LinkedList<>();
072      this.children.add(value);
073      return this;
074   }
075
076   /**
077    * Adds one or more child elements to this element.
078    *
079    * @param value The children to add as child elements.
080    * @return This object.
081    */
082   public HtmlElement children(Object...value) {
083      if (value.length > 0) {
084         if (this.children == null)
085            this.children = new LinkedList<>();
086         for (var c : value)
087            this.children.add(c);
088      }
089      return this;
090   }
091
092   @Override /* Overridden from HtmlElement */
093   public HtmlElementContainer contenteditable(Object value) {
094      super.contenteditable(value);
095      return this;
096   }
097
098   @Override /* Overridden from HtmlElement */
099   public HtmlElementContainer dir(String value) {
100      super.dir(value);
101      return this;
102   }
103
104   /**
105    * Returns the child node at the specified index.
106    *
107    * @param <T> The class type of the node.
108    * @param type The class type of the node.
109    * @param index The index of the node in the list of children.
110    * @return The child node, or <jk>null</jk> if it doesn't exist.
111    * @throws InvalidDataConversionException If node is not the expected type.
112    */
113   public <T> T getChild(Class<T> type, int index) {
114      return (children == null || children.size() <= index || index < 0 ? null : ConverterUtils.toType(children.get(index), type));
115   }
116
117   /**
118    * Returns the child node at the specified index.
119    *
120    * @param index The index of the node in the list of children.
121    * @return The child node, or <jk>null</jk> if it doesn't exist.
122    */
123   public Object getChild(int index) {
124      return (children == null || children.size() <= index || index < 0 ? null : children.get(index));
125   }
126
127   /**
128    * Returns the child node at the specified address.
129    *
130    * <p>
131    * Indexes are zero-indexed.
132    *
133    * <p>
134    * For example, calling <c>getChild(1,2,3);</c> will return the 4th child of the 3rd child of the 2nd child.
135    *
136    * @param index The child indexes.
137    * @return The child node, or <jk>null</jk> if it doesn't point to a valid child.
138    */
139   public Object getChild(int...index) {
140      if (index.length == 0)
141         return null;
142      if (index.length == 1)
143         return getChild(index[0]);
144      Object c = this;
145      for (var element : index) {
146         if (c instanceof HtmlElementMixed c2)
147            c = c2.getChild(element);
148         else if (c instanceof HtmlElementContainer c2)
149            c = c2.getChild(element);
150         else
151            return null;
152      }
153      return c;
154   }
155
156   /**
157    * The children of this element.
158    *
159    * @return The children of this element.
160    */
161   @Xml(format = ELEMENTS)
162   @Beanp(dictionary = HtmlBeanDictionary.class, name = "c")
163   public List<Object> getChildren() { return children; }
164
165   @Override /* Overridden from HtmlElement */
166   public HtmlElementContainer hidden(Object value) {
167      super.hidden(value);
168      return this;
169   }
170
171   @Override /* Overridden from HtmlElement */
172   public HtmlElementContainer id(String value) {
173      super.id(value);
174      return this;
175   }
176
177   @Override /* Overridden from HtmlElement */
178   public HtmlElementContainer lang(String value) {
179      super.lang(value);
180      return this;
181   }
182
183   @Override /* Overridden from HtmlElement */
184   public HtmlElementContainer onabort(String value) {
185      super.onabort(value);
186      return this;
187   }
188
189   @Override /* Overridden from HtmlElement */
190   public HtmlElementContainer onblur(String value) {
191      super.onblur(value);
192      return this;
193   }
194
195   @Override /* Overridden from HtmlElement */
196   public HtmlElementContainer oncancel(String value) {
197      super.oncancel(value);
198      return this;
199   }
200
201   @Override /* Overridden from HtmlElement */
202   public HtmlElementContainer oncanplay(String value) {
203      super.oncanplay(value);
204      return this;
205   }
206
207   @Override /* Overridden from HtmlElement */
208   public HtmlElementContainer oncanplaythrough(String value) {
209      super.oncanplaythrough(value);
210      return this;
211   }
212
213   @Override /* Overridden from HtmlElement */
214   public HtmlElementContainer onchange(String value) {
215      super.onchange(value);
216      return this;
217   }
218
219   @Override /* Overridden from HtmlElement */
220   public HtmlElementContainer onclick(String value) {
221      super.onclick(value);
222      return this;
223   }
224
225   @Override /* Overridden from HtmlElement */
226   public HtmlElementContainer oncuechange(String value) {
227      super.oncuechange(value);
228      return this;
229   }
230
231   @Override /* Overridden from HtmlElement */
232   public HtmlElementContainer ondblclick(String value) {
233      super.ondblclick(value);
234      return this;
235   }
236
237   @Override /* Overridden from HtmlElement */
238   public HtmlElementContainer ondurationchange(String value) {
239      super.ondurationchange(value);
240      return this;
241   }
242
243   @Override /* Overridden from HtmlElement */
244   public HtmlElementContainer onemptied(String value) {
245      super.onemptied(value);
246      return this;
247   }
248
249   @Override /* Overridden from HtmlElement */
250   public HtmlElementContainer onended(String value) {
251      super.onended(value);
252      return this;
253   }
254
255   @Override /* Overridden from HtmlElement */
256   public HtmlElementContainer onerror(String value) {
257      super.onerror(value);
258      return this;
259   }
260
261   @Override /* Overridden from HtmlElement */
262   public HtmlElementContainer onfocus(String value) {
263      super.onfocus(value);
264      return this;
265   }
266
267   @Override /* Overridden from HtmlElement */
268   public HtmlElementContainer oninput(String value) {
269      super.oninput(value);
270      return this;
271   }
272
273   @Override /* Overridden from HtmlElement */
274   public HtmlElementContainer oninvalid(String value) {
275      super.oninvalid(value);
276      return this;
277   }
278
279   @Override /* Overridden from HtmlElement */
280   public HtmlElementContainer onkeydown(String value) {
281      super.onkeydown(value);
282      return this;
283   }
284
285   @Override /* Overridden from HtmlElement */
286   public HtmlElementContainer onkeypress(String value) {
287      super.onkeypress(value);
288      return this;
289   }
290
291   @Override /* Overridden from HtmlElement */
292   public HtmlElementContainer onkeyup(String value) {
293      super.onkeyup(value);
294      return this;
295   }
296
297   @Override /* Overridden from HtmlElement */
298   public HtmlElementContainer onload(String value) {
299      super.onload(value);
300      return this;
301   }
302
303   @Override /* Overridden from HtmlElement */
304   public HtmlElementContainer onloadeddata(String value) {
305      super.onloadeddata(value);
306      return this;
307   }
308
309   @Override /* Overridden from HtmlElement */
310   public HtmlElementContainer onloadedmetadata(String value) {
311      super.onloadedmetadata(value);
312      return this;
313   }
314
315   @Override /* Overridden from HtmlElement */
316   public HtmlElementContainer onloadstart(String value) {
317      super.onloadstart(value);
318      return this;
319   }
320
321   @Override /* Overridden from HtmlElement */
322   public HtmlElementContainer onmousedown(String value) {
323      super.onmousedown(value);
324      return this;
325   }
326
327   @Override /* Overridden from HtmlElement */
328   public HtmlElementContainer onmouseenter(String value) {
329      super.onmouseenter(value);
330      return this;
331   }
332
333   @Override /* Overridden from HtmlElement */
334   public HtmlElementContainer onmouseleave(String value) {
335      super.onmouseleave(value);
336      return this;
337   }
338
339   @Override /* Overridden from HtmlElement */
340   public HtmlElementContainer onmousemove(String value) {
341      super.onmousemove(value);
342      return this;
343   }
344
345   @Override /* Overridden from HtmlElement */
346   public HtmlElementContainer onmouseout(String value) {
347      super.onmouseout(value);
348      return this;
349   }
350
351   @Override /* Overridden from HtmlElement */
352   public HtmlElementContainer onmouseover(String value) {
353      super.onmouseover(value);
354      return this;
355   }
356
357   @Override /* Overridden from HtmlElement */
358   public HtmlElementContainer onmouseup(String value) {
359      super.onmouseup(value);
360      return this;
361   }
362
363   @Override /* Overridden from HtmlElement */
364   public HtmlElementContainer onmousewheel(String value) {
365      super.onmousewheel(value);
366      return this;
367   }
368
369   @Override /* Overridden from HtmlElement */
370   public HtmlElementContainer onpause(String value) {
371      super.onpause(value);
372      return this;
373   }
374
375   @Override /* Overridden from HtmlElement */
376   public HtmlElementContainer onplay(String value) {
377      super.onplay(value);
378      return this;
379   }
380
381   @Override /* Overridden from HtmlElement */
382   public HtmlElementContainer onplaying(String value) {
383      super.onplaying(value);
384      return this;
385   }
386
387   @Override /* Overridden from HtmlElement */
388   public HtmlElementContainer onprogress(String value) {
389      super.onprogress(value);
390      return this;
391   }
392
393   @Override /* Overridden from HtmlElement */
394   public HtmlElementContainer onratechange(String value) {
395      super.onratechange(value);
396      return this;
397   }
398
399   @Override /* Overridden from HtmlElement */
400   public HtmlElementContainer onreset(String value) {
401      super.onreset(value);
402      return this;
403   }
404
405   @Override /* Overridden from HtmlElement */
406   public HtmlElementContainer onresize(String value) {
407      super.onresize(value);
408      return this;
409   }
410
411   @Override /* Overridden from HtmlElement */
412   public HtmlElementContainer onscroll(String value) {
413      super.onscroll(value);
414      return this;
415   }
416
417   @Override /* Overridden from HtmlElement */
418   public HtmlElementContainer onseeked(String value) {
419      super.onseeked(value);
420      return this;
421   }
422
423   @Override /* Overridden from HtmlElement */
424   public HtmlElementContainer onseeking(String value) {
425      super.onseeking(value);
426      return this;
427   }
428
429   @Override /* Overridden from HtmlElement */
430   public HtmlElementContainer onselect(String value) {
431      super.onselect(value);
432      return this;
433   }
434
435   @Override /* Overridden from HtmlElement */
436   public HtmlElementContainer onshow(String value) {
437      super.onshow(value);
438      return this;
439   }
440
441   @Override /* Overridden from HtmlElement */
442   public HtmlElementContainer onstalled(String value) {
443      super.onstalled(value);
444      return this;
445   }
446
447   @Override /* Overridden from HtmlElement */
448   public HtmlElementContainer onsubmit(String value) {
449      super.onsubmit(value);
450      return this;
451   }
452
453   @Override /* Overridden from HtmlElement */
454   public HtmlElementContainer onsuspend(String value) {
455      super.onsuspend(value);
456      return this;
457   }
458
459   @Override /* Overridden from HtmlElement */
460   public HtmlElementContainer ontimeupdate(String value) {
461      super.ontimeupdate(value);
462      return this;
463   }
464
465   @Override /* Overridden from HtmlElement */
466   public HtmlElementContainer ontoggle(String value) {
467      super.ontoggle(value);
468      return this;
469   }
470
471   @Override /* Overridden from HtmlElement */
472   public HtmlElementContainer onvolumechange(String value) {
473      super.onvolumechange(value);
474      return this;
475   }
476
477   @Override /* Overridden from HtmlElement */
478   public HtmlElementContainer onwaiting(String value) {
479      super.onwaiting(value);
480      return this;
481   }
482
483   /**
484    * Sets the children for this container.
485    *
486    * @param children The new children for this container.
487    * @return This object.
488    */
489   @Beanp("c")
490   public HtmlElementContainer setChildren(List<Object> children) {
491      this.children = children;
492      return this;
493   }
494
495   @Override /* Overridden from HtmlElement */
496   public HtmlElementContainer spellcheck(Object value) {
497      super.spellcheck(value);
498      return this;
499   }
500
501   @Override /* Overridden from HtmlElement */
502   public HtmlElementContainer style(String value) {
503      super.style(value);
504      return this;
505   }
506
507   @Override /* Overridden from HtmlElement */
508   public HtmlElementContainer tabindex(Object value) {
509      super.tabindex(value);
510      return this;
511   }
512
513   @Override /* Overridden from HtmlElement */
514   public HtmlElementContainer title(String value) {
515      super.title(value);
516      return this;
517   }
518
519   @Override /* Overridden from HtmlElement */
520   public HtmlElementContainer translate(Object value) {
521      super.translate(value);
522      return this;
523   }
524}