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