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/text-level-semantics.html#the-cite-element">&lt;cite&gt;</a>
023 * element.
024 *
025 * <p>
026 * The cite element represents the title of a work (e.g., a book, a paper, an essay, a poem, a score,
027 * a song, a script, a film, a TV show, a game, a sculpture, a painting, a theatre production, a play,
028 * an opera, a musical, an exhibition, a legal case report, a computer program, a web site, a web page,
029 * a blog post or comment, a forum post or comment, a tweet, a written or oral statement, etc.). It is
030 * used to mark up the title of a referenced work, making it clear to both users and search engines
031 * what is being cited.
032 *
033 * <h5 class='section'>Examples:</h5>
034 * <p class='bcode w800'>
035 *    <jk>import static</jk> org.apache.juneau.bean.html5.HtmlBuilder.*;
036 *
037 *    <jc>// Simple citation</jc>
038 *    Cite <jv>simple</jv> = <jsm>cite</jsm>(<js>"The Great Gatsby"</js>);
039 *
040 *    <jc>// Citation with styling</jc>
041 *    Cite <jv>styled</jv> = <jsm>cite</jsm>(<js>"To Kill a Mockingbird"</js>)
042 *       ._class(<js>"book-title"</js>);
043 *
044 *    <jc>// Citation in a sentence</jc>
045 *    P <jv>sentence</jv> = <jsm>p</jsm>(
046 *       <js>"As mentioned in "</js>,
047 *       <jsm>cite</jsm>(<js>"The Art of War"</js>),
048 *       <js>", strategy is key to success."</js>
049 *    );
050 *
051 *    <jc>// Citation with link</jc>
052 *    Cite <jv>withLink</jv> = <jsm>cite</jsm>(
053 *       <jsm>a</jsm>(<js>"/books/1984"</js>, <js>"1984"</js>)
054 *    );
055 *
056 *    <jc>// Multiple citations</jc>
057 *    P <jv>multiple</jv> = <jsm>p</jsm>(
058 *       <js>"Several works discuss this topic: "</js>,
059 *       <jsm>cite</jsm>(<js>"Book A"</js>),
060 *       <js>", "</js>,
061 *       <jsm>cite</jsm>(<js>"Book B"</js>),
062 *       <js>", and "</js>,
063 *       <jsm>cite</jsm>(<js>"Book C"</js>),
064 *       <js>"."</js>
065 *    );
066 *
067 *    <jc>// Citation with author</jc>
068 *    P <jv>withAuthor</jv> = <jsm>p</jsm>(
069 *       <js>"According to "</js>,
070 *       <jsm>strong</jsm>(<js>"John Doe"</js>),
071 *       <js>" in "</js>,
072 *       <jsm>cite</jsm>(<js>"The Future of Technology"</js>),
073 *       <js>", we are entering a new era."</js>
074 *    );
075 * </p>
076 *
077 * <p>
078 * The following convenience methods are provided for constructing instances of this bean:
079 * <ul class='javatree'>
080 *    <li class='jc'>{@link HtmlBuilder}
081 *    <ul class='javatree'>
082 *       <li class='jm'>{@link HtmlBuilder#cite() cite()}
083 *       <li class='jm'>{@link HtmlBuilder#cite(Object...) cite(Object...)}
084 *    </ul>
085 * </ul>
086 * </p>
087 *
088 * <h5 class='section'>See Also:</h5><ul>
089 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauBeanHtml5">juneau-bean-html5</a>
090 * </ul>
091 */
092@Bean(typeName = "cite")
093public class Cite extends HtmlElementMixed {
094
095   /**
096    * Creates an empty {@link Cite} element.
097    */
098   public Cite() {}
099
100   /**
101    * Creates a {@link Cite} element with the specified child nodes.
102    *
103    * @param children The child nodes.
104    */
105   public Cite(Object...children) {
106      children(children);
107   }
108
109   @Override /* Overridden from HtmlElement */
110   public Cite _class(String value) { // NOSONAR - Intentional naming.
111      super._class(value);
112      return this;
113   }
114
115   @Override /* Overridden from HtmlElement */
116   public Cite accesskey(String value) {
117      super.accesskey(value);
118      return this;
119   }
120
121   @Override /* Overridden from HtmlElement */
122   public Cite attr(String key, Object val) {
123      super.attr(key, val);
124      return this;
125   }
126
127   @Override /* Overridden from HtmlElement */
128   public Cite attrUri(String key, Object val) {
129      super.attrUri(key, val);
130      return this;
131   }
132
133   @Override /* Overridden from HtmlElementMixed */
134   public Cite child(Object value) {
135      super.child(value);
136      return this;
137   }
138
139   @Override /* Overridden from HtmlElementMixed */
140   public Cite children(Object...value) {
141      super.children(value);
142      return this;
143   }
144
145   @Override /* Overridden from HtmlElement */
146   public Cite contenteditable(Object value) {
147      super.contenteditable(value);
148      return this;
149   }
150
151   @Override /* Overridden from HtmlElement */
152   public Cite dir(String value) {
153      super.dir(value);
154      return this;
155   }
156
157   @Override /* Overridden from HtmlElement */
158   public Cite hidden(Object value) {
159      super.hidden(value);
160      return this;
161   }
162
163   @Override /* Overridden from HtmlElement */
164   public Cite id(String value) {
165      super.id(value);
166      return this;
167   }
168
169   @Override /* Overridden from HtmlElement */
170   public Cite lang(String value) {
171      super.lang(value);
172      return this;
173   }
174
175   @Override /* Overridden from HtmlElement */
176   public Cite onabort(String value) {
177      super.onabort(value);
178      return this;
179   }
180
181   @Override /* Overridden from HtmlElement */
182   public Cite onblur(String value) {
183      super.onblur(value);
184      return this;
185   }
186
187   @Override /* Overridden from HtmlElement */
188   public Cite oncancel(String value) {
189      super.oncancel(value);
190      return this;
191   }
192
193   @Override /* Overridden from HtmlElement */
194   public Cite oncanplay(String value) {
195      super.oncanplay(value);
196      return this;
197   }
198
199   @Override /* Overridden from HtmlElement */
200   public Cite oncanplaythrough(String value) {
201      super.oncanplaythrough(value);
202      return this;
203   }
204
205   @Override /* Overridden from HtmlElement */
206   public Cite onchange(String value) {
207      super.onchange(value);
208      return this;
209   }
210
211   @Override /* Overridden from HtmlElement */
212   public Cite onclick(String value) {
213      super.onclick(value);
214      return this;
215   }
216
217   @Override /* Overridden from HtmlElement */
218   public Cite oncuechange(String value) {
219      super.oncuechange(value);
220      return this;
221   }
222
223   @Override /* Overridden from HtmlElement */
224   public Cite ondblclick(String value) {
225      super.ondblclick(value);
226      return this;
227   }
228
229   @Override /* Overridden from HtmlElement */
230   public Cite ondurationchange(String value) {
231      super.ondurationchange(value);
232      return this;
233   }
234
235   @Override /* Overridden from HtmlElement */
236   public Cite onemptied(String value) {
237      super.onemptied(value);
238      return this;
239   }
240
241   @Override /* Overridden from HtmlElement */
242   public Cite onended(String value) {
243      super.onended(value);
244      return this;
245   }
246
247   @Override /* Overridden from HtmlElement */
248   public Cite onerror(String value) {
249      super.onerror(value);
250      return this;
251   }
252
253   @Override /* Overridden from HtmlElement */
254   public Cite onfocus(String value) {
255      super.onfocus(value);
256      return this;
257   }
258
259   @Override /* Overridden from HtmlElement */
260   public Cite oninput(String value) {
261      super.oninput(value);
262      return this;
263   }
264
265   @Override /* Overridden from HtmlElement */
266   public Cite oninvalid(String value) {
267      super.oninvalid(value);
268      return this;
269   }
270
271   @Override /* Overridden from HtmlElement */
272   public Cite onkeydown(String value) {
273      super.onkeydown(value);
274      return this;
275   }
276
277   @Override /* Overridden from HtmlElement */
278   public Cite onkeypress(String value) {
279      super.onkeypress(value);
280      return this;
281   }
282
283   @Override /* Overridden from HtmlElement */
284   public Cite onkeyup(String value) {
285      super.onkeyup(value);
286      return this;
287   }
288
289   @Override /* Overridden from HtmlElement */
290   public Cite onload(String value) {
291      super.onload(value);
292      return this;
293   }
294
295   @Override /* Overridden from HtmlElement */
296   public Cite onloadeddata(String value) {
297      super.onloadeddata(value);
298      return this;
299   }
300
301   @Override /* Overridden from HtmlElement */
302   public Cite onloadedmetadata(String value) {
303      super.onloadedmetadata(value);
304      return this;
305   }
306
307   @Override /* Overridden from HtmlElement */
308   public Cite onloadstart(String value) {
309      super.onloadstart(value);
310      return this;
311   }
312
313   @Override /* Overridden from HtmlElement */
314   public Cite onmousedown(String value) {
315      super.onmousedown(value);
316      return this;
317   }
318
319   @Override /* Overridden from HtmlElement */
320   public Cite onmouseenter(String value) {
321      super.onmouseenter(value);
322      return this;
323   }
324
325   @Override /* Overridden from HtmlElement */
326   public Cite onmouseleave(String value) {
327      super.onmouseleave(value);
328      return this;
329   }
330
331   @Override /* Overridden from HtmlElement */
332   public Cite onmousemove(String value) {
333      super.onmousemove(value);
334      return this;
335   }
336
337   @Override /* Overridden from HtmlElement */
338   public Cite onmouseout(String value) {
339      super.onmouseout(value);
340      return this;
341   }
342
343   @Override /* Overridden from HtmlElement */
344   public Cite onmouseover(String value) {
345      super.onmouseover(value);
346      return this;
347   }
348
349   @Override /* Overridden from HtmlElement */
350   public Cite onmouseup(String value) {
351      super.onmouseup(value);
352      return this;
353   }
354
355   @Override /* Overridden from HtmlElement */
356   public Cite onmousewheel(String value) {
357      super.onmousewheel(value);
358      return this;
359   }
360
361   @Override /* Overridden from HtmlElement */
362   public Cite onpause(String value) {
363      super.onpause(value);
364      return this;
365   }
366
367   @Override /* Overridden from HtmlElement */
368   public Cite onplay(String value) {
369      super.onplay(value);
370      return this;
371   }
372
373   @Override /* Overridden from HtmlElement */
374   public Cite onplaying(String value) {
375      super.onplaying(value);
376      return this;
377   }
378
379   @Override /* Overridden from HtmlElement */
380   public Cite onprogress(String value) {
381      super.onprogress(value);
382      return this;
383   }
384
385   @Override /* Overridden from HtmlElement */
386   public Cite onratechange(String value) {
387      super.onratechange(value);
388      return this;
389   }
390
391   @Override /* Overridden from HtmlElement */
392   public Cite onreset(String value) {
393      super.onreset(value);
394      return this;
395   }
396
397   @Override /* Overridden from HtmlElement */
398   public Cite onresize(String value) {
399      super.onresize(value);
400      return this;
401   }
402
403   @Override /* Overridden from HtmlElement */
404   public Cite onscroll(String value) {
405      super.onscroll(value);
406      return this;
407   }
408
409   @Override /* Overridden from HtmlElement */
410   public Cite onseeked(String value) {
411      super.onseeked(value);
412      return this;
413   }
414
415   @Override /* Overridden from HtmlElement */
416   public Cite onseeking(String value) {
417      super.onseeking(value);
418      return this;
419   }
420
421   @Override /* Overridden from HtmlElement */
422   public Cite onselect(String value) {
423      super.onselect(value);
424      return this;
425   }
426
427   @Override /* Overridden from HtmlElement */
428   public Cite onshow(String value) {
429      super.onshow(value);
430      return this;
431   }
432
433   @Override /* Overridden from HtmlElement */
434   public Cite onstalled(String value) {
435      super.onstalled(value);
436      return this;
437   }
438
439   @Override /* Overridden from HtmlElement */
440   public Cite onsubmit(String value) {
441      super.onsubmit(value);
442      return this;
443   }
444
445   @Override /* Overridden from HtmlElement */
446   public Cite onsuspend(String value) {
447      super.onsuspend(value);
448      return this;
449   }
450
451   @Override /* Overridden from HtmlElement */
452   public Cite ontimeupdate(String value) {
453      super.ontimeupdate(value);
454      return this;
455   }
456
457   @Override /* Overridden from HtmlElement */
458   public Cite ontoggle(String value) {
459      super.ontoggle(value);
460      return this;
461   }
462
463   @Override /* Overridden from HtmlElement */
464   public Cite onvolumechange(String value) {
465      super.onvolumechange(value);
466      return this;
467   }
468
469   @Override /* Overridden from HtmlElement */
470   public Cite onwaiting(String value) {
471      super.onwaiting(value);
472      return this;
473   }
474
475   @Override /* Overridden from HtmlElement */
476   public Cite spellcheck(Object value) {
477      super.spellcheck(value);
478      return this;
479   }
480
481   @Override /* Overridden from HtmlElement */
482   public Cite style(String value) {
483      super.style(value);
484      return this;
485   }
486
487   @Override /* Overridden from HtmlElement */
488   public Cite tabindex(Object value) {
489      super.tabindex(value);
490      return this;
491   }
492
493   @Override /* Overridden from HtmlElement */
494   public Cite title(String value) {
495      super.title(value);
496      return this;
497   }
498
499   @Override /* Overridden from HtmlElement */
500   public Cite translate(Object value) {
501      super.translate(value);
502      return this;
503   }
504}