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