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