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.*;
020
021/**
022 * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/sections.html#the-aside-element">&lt;aside&gt;</a>
023 * element.
024 *
025 * <p>
026 * The aside element represents a section of a page that consists of content that is tangentially
027 * related to the content around the aside element, and which could be considered separate from
028 * that content. It is commonly used for sidebars, pull quotes, advertisements, navigation links,
029 * or other content that is related but not essential to the main content.
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>// Sidebar with related links</jc>
036 *    Aside <jv>sidebar</jv> = <jsm>aside</jsm>(
037 *       <jsm>h3</jsm>(<js>"Related Articles"</js>),
038 *       <jsm>ul</jsm>(
039 *          <jsm>li</jsm>(<jsm>a</jsm>(<js>"/article1"</js>, <js>"Article 1"</js>)),
040 *          <jsm>li</jsm>(<jsm>a</jsm>(<js>"/article2"</js>, <js>"Article 2"</js>)),
041 *          <jsm>li</jsm>(<jsm>a</jsm>(<js>"/article3"</js>, <js>"Article 3"</js>))
042 *       )
043 *    )._class(<js>"sidebar"</js>);
044 *
045 *    <jc>// Pull quote</jc>
046 *    Aside <jv>pullQuote</jv> = <jsm>aside</jsm>(
047 *       <jsm>blockquote</jsm>(
048 *          <js>"The best way to predict the future is to create it."</js>,
049 *          <jsm>footer</jsm>(<js>"— Peter Drucker"</js>)
050 *       )
051 *    )._class(<js>"pull-quote"</js>);
052 *
053 *    <jc>// Advertisement</jc>
054 *    Aside <jv>advertisement</jv> = <jsm>aside</jsm>(
055 *       <jsm>h4</jsm>(<js>"Sponsored Content"</js>),
056 *       <jsm>p</jsm>(<js>"Check out our latest product!"</js>),
057 *       <jsm>a</jsm>(<js>"/product"</js>, <js>"Learn More"</js>)
058 *    )._class(<js>"advertisement"</js>);
059 *
060 *    <jc>// Author bio</jc>
061 *    Aside <jv>authorBio</jv> = <jsm>aside</jsm>(
062 *       <jsm>h3</jsm>(<js>"About the Author"</js>),
063 *       <jsm>p</jsm>(<js>"John Doe is a web developer with 10 years of experience..."</js>),
064 *       <jsm>a</jsm>(<js>"/author/john-doe"</js>, <js>"Read more articles"</js>)
065 *    )._class(<js>"author-bio"</js>);
066 *
067 *    <jc>// Navigation menu</jc>
068 *    Aside <jv>navigation</jv> = <jsm>aside</jsm>(
069 *       <jsm>nav</jsm>(
070 *          <jsm>ul</jsm>(
071 *             <jsm>li</jsm>(<jsm>a</jsm>(<js>"/home"</js>, <js>"Home"</js>)),
072 *             <jsm>li</jsm>(<jsm>a</jsm>(<js>"/about"</js>, <js>"About"</js>)),
073 *             <jsm>li</jsm>(<jsm>a</jsm>(<js>"/contact"</js>, <js>"Contact"</js>))
074 *          )
075 *       )
076 *    )._class(<js>"navigation"</js>);
077 *
078 *    <jc>// Glossary or definitions</jc>
079 *    Aside <jv>glossary</jv> = <jsm>aside</jsm>(
080 *       <jsm>h3</jsm>(<js>"Key Terms"</js>),
081 *       <jsm>dl</jsm>(
082 *          <jsm>dt</jsm>(<js>"HTML"</js>),
083 *          <jsm>dd</jsm>(<js>"HyperText Markup Language"</js>),
084 *          <jsm>dt</jsm>(<js>"CSS"</js>),
085 *          <jsm>dd</jsm>(<js>"Cascading Style Sheets"</js>)
086 *       )
087 *    )._class(<js>"glossary"</js>);
088 * </p>
089 *
090 * <p>
091 * The following convenience methods are provided for constructing instances of this bean:
092 * <ul class='javatree'>
093 *    <li class='jc'>{@link HtmlBuilder}
094 *    <ul class='javatree'>
095 *       <li class='jm'>{@link HtmlBuilder#aside() aside()}
096 *       <li class='jm'>{@link HtmlBuilder#aside(Object...) aside(Object...)}
097 *    </ul>
098 * </ul>
099 * </p>
100 *
101 * <h5 class='section'>See Also:</h5><ul>
102 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauBeanHtml5">juneau-bean-html5</a>
103 * </ul>
104 */
105@Bean(typeName = "aside")
106public class Aside extends HtmlElementMixed {
107
108   /**
109    * Creates an empty {@link Aside} element.
110    */
111   public Aside() {}
112
113   /**
114    * Creates an {@link Aside} element with the specified child nodes.
115    *
116    * @param children The child nodes.
117    */
118   public Aside(Object...children) {
119      children(children);
120   }
121
122   @Override /* Overridden from HtmlElement */
123   public Aside _class(String value) { // NOSONAR - Intentional naming.
124      super._class(value);
125      return this;
126   }
127
128   @Override /* Overridden from HtmlElement */
129   public Aside accesskey(String value) {
130      super.accesskey(value);
131      return this;
132   }
133
134   @Override /* Overridden from HtmlElement */
135   public Aside attr(String key, Object val) {
136      super.attr(key, val);
137      return this;
138   }
139
140   @Override /* Overridden from HtmlElement */
141   public Aside attrUri(String key, Object val) {
142      super.attrUri(key, val);
143      return this;
144   }
145
146   @Override /* Overridden from HtmlElementMixed */
147   public Aside child(Object value) {
148      super.child(value);
149      return this;
150   }
151
152   @Override /* Overridden from HtmlElementMixed */
153   public Aside children(Object...value) {
154      super.children(value);
155      return this;
156   }
157
158   @Override /* Overridden from HtmlElement */
159   public Aside contenteditable(Object value) {
160      super.contenteditable(value);
161      return this;
162   }
163
164   @Override /* Overridden from HtmlElement */
165   public Aside dir(String value) {
166      super.dir(value);
167      return this;
168   }
169
170   @Override /* Overridden from HtmlElement */
171   public Aside hidden(Object value) {
172      super.hidden(value);
173      return this;
174   }
175
176   @Override /* Overridden from HtmlElement */
177   public Aside id(String value) {
178      super.id(value);
179      return this;
180   }
181
182   @Override /* Overridden from HtmlElement */
183   public Aside lang(String value) {
184      super.lang(value);
185      return this;
186   }
187
188   @Override /* Overridden from HtmlElement */
189   public Aside onabort(String value) {
190      super.onabort(value);
191      return this;
192   }
193
194   @Override /* Overridden from HtmlElement */
195   public Aside onblur(String value) {
196      super.onblur(value);
197      return this;
198   }
199
200   @Override /* Overridden from HtmlElement */
201   public Aside oncancel(String value) {
202      super.oncancel(value);
203      return this;
204   }
205
206   @Override /* Overridden from HtmlElement */
207   public Aside oncanplay(String value) {
208      super.oncanplay(value);
209      return this;
210   }
211
212   @Override /* Overridden from HtmlElement */
213   public Aside oncanplaythrough(String value) {
214      super.oncanplaythrough(value);
215      return this;
216   }
217
218   @Override /* Overridden from HtmlElement */
219   public Aside onchange(String value) {
220      super.onchange(value);
221      return this;
222   }
223
224   @Override /* Overridden from HtmlElement */
225   public Aside onclick(String value) {
226      super.onclick(value);
227      return this;
228   }
229
230   @Override /* Overridden from HtmlElement */
231   public Aside oncuechange(String value) {
232      super.oncuechange(value);
233      return this;
234   }
235
236   @Override /* Overridden from HtmlElement */
237   public Aside ondblclick(String value) {
238      super.ondblclick(value);
239      return this;
240   }
241
242   @Override /* Overridden from HtmlElement */
243   public Aside ondurationchange(String value) {
244      super.ondurationchange(value);
245      return this;
246   }
247
248   @Override /* Overridden from HtmlElement */
249   public Aside onemptied(String value) {
250      super.onemptied(value);
251      return this;
252   }
253
254   @Override /* Overridden from HtmlElement */
255   public Aside onended(String value) {
256      super.onended(value);
257      return this;
258   }
259
260   @Override /* Overridden from HtmlElement */
261   public Aside onerror(String value) {
262      super.onerror(value);
263      return this;
264   }
265
266   @Override /* Overridden from HtmlElement */
267   public Aside onfocus(String value) {
268      super.onfocus(value);
269      return this;
270   }
271
272   @Override /* Overridden from HtmlElement */
273   public Aside oninput(String value) {
274      super.oninput(value);
275      return this;
276   }
277
278   @Override /* Overridden from HtmlElement */
279   public Aside oninvalid(String value) {
280      super.oninvalid(value);
281      return this;
282   }
283
284   @Override /* Overridden from HtmlElement */
285   public Aside onkeydown(String value) {
286      super.onkeydown(value);
287      return this;
288   }
289
290   @Override /* Overridden from HtmlElement */
291   public Aside onkeypress(String value) {
292      super.onkeypress(value);
293      return this;
294   }
295
296   @Override /* Overridden from HtmlElement */
297   public Aside onkeyup(String value) {
298      super.onkeyup(value);
299      return this;
300   }
301
302   @Override /* Overridden from HtmlElement */
303   public Aside onload(String value) {
304      super.onload(value);
305      return this;
306   }
307
308   @Override /* Overridden from HtmlElement */
309   public Aside onloadeddata(String value) {
310      super.onloadeddata(value);
311      return this;
312   }
313
314   @Override /* Overridden from HtmlElement */
315   public Aside onloadedmetadata(String value) {
316      super.onloadedmetadata(value);
317      return this;
318   }
319
320   @Override /* Overridden from HtmlElement */
321   public Aside onloadstart(String value) {
322      super.onloadstart(value);
323      return this;
324   }
325
326   @Override /* Overridden from HtmlElement */
327   public Aside onmousedown(String value) {
328      super.onmousedown(value);
329      return this;
330   }
331
332   @Override /* Overridden from HtmlElement */
333   public Aside onmouseenter(String value) {
334      super.onmouseenter(value);
335      return this;
336   }
337
338   @Override /* Overridden from HtmlElement */
339   public Aside onmouseleave(String value) {
340      super.onmouseleave(value);
341      return this;
342   }
343
344   @Override /* Overridden from HtmlElement */
345   public Aside onmousemove(String value) {
346      super.onmousemove(value);
347      return this;
348   }
349
350   @Override /* Overridden from HtmlElement */
351   public Aside onmouseout(String value) {
352      super.onmouseout(value);
353      return this;
354   }
355
356   @Override /* Overridden from HtmlElement */
357   public Aside onmouseover(String value) {
358      super.onmouseover(value);
359      return this;
360   }
361
362   @Override /* Overridden from HtmlElement */
363   public Aside onmouseup(String value) {
364      super.onmouseup(value);
365      return this;
366   }
367
368   @Override /* Overridden from HtmlElement */
369   public Aside onmousewheel(String value) {
370      super.onmousewheel(value);
371      return this;
372   }
373
374   @Override /* Overridden from HtmlElement */
375   public Aside onpause(String value) {
376      super.onpause(value);
377      return this;
378   }
379
380   @Override /* Overridden from HtmlElement */
381   public Aside onplay(String value) {
382      super.onplay(value);
383      return this;
384   }
385
386   @Override /* Overridden from HtmlElement */
387   public Aside onplaying(String value) {
388      super.onplaying(value);
389      return this;
390   }
391
392   @Override /* Overridden from HtmlElement */
393   public Aside onprogress(String value) {
394      super.onprogress(value);
395      return this;
396   }
397
398   @Override /* Overridden from HtmlElement */
399   public Aside onratechange(String value) {
400      super.onratechange(value);
401      return this;
402   }
403
404   @Override /* Overridden from HtmlElement */
405   public Aside onreset(String value) {
406      super.onreset(value);
407      return this;
408   }
409
410   @Override /* Overridden from HtmlElement */
411   public Aside onresize(String value) {
412      super.onresize(value);
413      return this;
414   }
415
416   @Override /* Overridden from HtmlElement */
417   public Aside onscroll(String value) {
418      super.onscroll(value);
419      return this;
420   }
421
422   @Override /* Overridden from HtmlElement */
423   public Aside onseeked(String value) {
424      super.onseeked(value);
425      return this;
426   }
427
428   @Override /* Overridden from HtmlElement */
429   public Aside onseeking(String value) {
430      super.onseeking(value);
431      return this;
432   }
433
434   @Override /* Overridden from HtmlElement */
435   public Aside onselect(String value) {
436      super.onselect(value);
437      return this;
438   }
439
440   @Override /* Overridden from HtmlElement */
441   public Aside onshow(String value) {
442      super.onshow(value);
443      return this;
444   }
445
446   @Override /* Overridden from HtmlElement */
447   public Aside onstalled(String value) {
448      super.onstalled(value);
449      return this;
450   }
451
452   @Override /* Overridden from HtmlElement */
453   public Aside onsubmit(String value) {
454      super.onsubmit(value);
455      return this;
456   }
457
458   @Override /* Overridden from HtmlElement */
459   public Aside onsuspend(String value) {
460      super.onsuspend(value);
461      return this;
462   }
463
464   @Override /* Overridden from HtmlElement */
465   public Aside ontimeupdate(String value) {
466      super.ontimeupdate(value);
467      return this;
468   }
469
470   @Override /* Overridden from HtmlElement */
471   public Aside ontoggle(String value) {
472      super.ontoggle(value);
473      return this;
474   }
475
476   @Override /* Overridden from HtmlElement */
477   public Aside onvolumechange(String value) {
478      super.onvolumechange(value);
479      return this;
480   }
481
482   @Override /* Overridden from HtmlElement */
483   public Aside onwaiting(String value) {
484      super.onwaiting(value);
485      return this;
486   }
487
488   @Override /* Overridden from HtmlElement */
489   public Aside spellcheck(Object value) {
490      super.spellcheck(value);
491      return this;
492   }
493
494   @Override /* Overridden from HtmlElement */
495   public Aside style(String value) {
496      super.style(value);
497      return this;
498   }
499
500   @Override /* Overridden from HtmlElement */
501   public Aside tabindex(Object value) {
502      super.tabindex(value);
503      return this;
504   }
505
506   @Override /* Overridden from HtmlElement */
507   public Aside title(String value) {
508      super.title(value);
509      return this;
510   }
511
512   @Override /* Overridden from HtmlElement */
513   public Aside translate(Object value) {
514      super.translate(value);
515      return this;
516   }
517}