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 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-q-element">&lt;q&gt;</a>
024 * element.
025 *
026 * <p>
027 * The q element represents a short inline quotation. It is used for short quotes that are part
028 * of the surrounding text, as opposed to blockquote which is used for longer, standalone quotations.
029 * The cite attribute can be used to provide a link to the source of the quotation.
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>// Simple inline quotation</jc>
036 *    Q <jv>q1</jv> = <jsm>q</jsm>(<js>"To be or not to be, that is the question."</js>);
037 * 
038 *    <jc>// Quotation with citation</jc>
039 *    Q <jv>q2</jv> = <jsm>q</jsm>(<js>"The only way to do great work is to love what you do."</js>)
040 *       .cite(<js>"https://example.com/source"</js>);
041 * 
042 *    <jc>// Quotation in a paragraph</jc>
043 *    P <jv>p1</jv> = <jsm>p</jsm>(
044 *       <js>"As Shakespeare once said, "</js>,
045 *       <jsm>q</jsm>(<js>"All the world's a stage"</js>),
046 *       <js>" and we are merely players."</js>
047 *    );
048 * 
049 *    <jc>// Quotation with styling</jc>
050 *    Q <jv>q3</jv> = <jsm>q</jsm>(<js>"Innovation distinguishes between a leader and a follower."</js>)
051 *       ._class(<js>"highlighted-quote"</js>)
052 *       .cite(<js>"https://example.com/author"</js>);
053 * </p>
054 *
055 * <p>
056 * The following convenience methods are provided for constructing instances of this bean:
057 * <ul class='javatree'>
058 *    <li class='jc'>{@link HtmlBuilder}
059 *    <ul class='javatree'>
060 *       <li class='jm'>{@link HtmlBuilder#q() q()}
061 *       <li class='jm'>{@link HtmlBuilder#q(Object, Object...) q(Object, Object...)}
062 *    </ul>
063 * </ul>
064 * </p>
065 *
066 * <h5 class='section'>See Also:</h5><ul>
067 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauBeanHtml5">juneau-bean-html5</a>
068 * </ul>
069 */
070@Bean(typeName="q")
071public class Q extends HtmlElementMixed {
072
073   /**
074    * Creates an empty {@link Q} element.
075    */
076   public Q() {}
077
078   /**
079    * Creates a {@link Q} element with the specified child nodes.
080    *
081    * @param children The child nodes.
082    */
083   public Q(Object...children) {
084      children(children);
085   }
086
087   /**
088    * <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#attr-q-cite">cite</a> attribute.
089    *
090    * <p>
091    * Specifies the URL of the source document or message from which the quotation was taken.
092    * This provides context and attribution for the quoted content.
093    *
094    * <p>
095    * The URL should point to the original source of the quoted material.
096    *
097    * @param cite The URL of the source document for the quotation.
098    * @return This object.
099    */
100   public Q cite(String value) {
101      attr("cite", value);
102      return this;
103   }
104
105   //-----------------------------------------------------------------------------------------------------------------
106   // Overridden methods
107   //-----------------------------------------------------------------------------------------------------------------
108   @Override /* Overridden from HtmlElement */
109   public Q _class(String value) {  // NOSONAR - Intentional naming.
110      super._class(value);
111      return this;
112   }
113
114   @Override /* Overridden from HtmlElement */
115   public Q accesskey(String value) {
116      super.accesskey(value);
117      return this;
118   }
119
120   @Override /* Overridden from HtmlElement */
121   public Q contenteditable(Object value) {
122      super.contenteditable(value);
123      return this;
124   }
125
126   @Override /* Overridden from HtmlElement */
127   public Q dir(String value) {
128      super.dir(value);
129      return this;
130   }
131
132   @Override /* Overridden from HtmlElement */
133   public Q hidden(Object value) {
134      super.hidden(value);
135      return this;
136   }
137
138   @Override /* Overridden from HtmlElement */
139   public Q id(String value) {
140      super.id(value);
141      return this;
142   }
143
144   @Override /* Overridden from HtmlElement */
145   public Q lang(String value) {
146      super.lang(value);
147      return this;
148   }
149
150   @Override /* Overridden from HtmlElement */
151   public Q onabort(String value) {
152      super.onabort(value);
153      return this;
154   }
155
156   @Override /* Overridden from HtmlElement */
157   public Q onblur(String value) {
158      super.onblur(value);
159      return this;
160   }
161
162   @Override /* Overridden from HtmlElement */
163   public Q oncancel(String value) {
164      super.oncancel(value);
165      return this;
166   }
167
168   @Override /* Overridden from HtmlElement */
169   public Q oncanplay(String value) {
170      super.oncanplay(value);
171      return this;
172   }
173
174   @Override /* Overridden from HtmlElement */
175   public Q oncanplaythrough(String value) {
176      super.oncanplaythrough(value);
177      return this;
178   }
179
180   @Override /* Overridden from HtmlElement */
181   public Q onchange(String value) {
182      super.onchange(value);
183      return this;
184   }
185
186   @Override /* Overridden from HtmlElement */
187   public Q onclick(String value) {
188      super.onclick(value);
189      return this;
190   }
191
192   @Override /* Overridden from HtmlElement */
193   public Q oncuechange(String value) {
194      super.oncuechange(value);
195      return this;
196   }
197
198   @Override /* Overridden from HtmlElement */
199   public Q ondblclick(String value) {
200      super.ondblclick(value);
201      return this;
202   }
203
204   @Override /* Overridden from HtmlElement */
205   public Q ondurationchange(String value) {
206      super.ondurationchange(value);
207      return this;
208   }
209
210   @Override /* Overridden from HtmlElement */
211   public Q onemptied(String value) {
212      super.onemptied(value);
213      return this;
214   }
215
216   @Override /* Overridden from HtmlElement */
217   public Q onended(String value) {
218      super.onended(value);
219      return this;
220   }
221
222   @Override /* Overridden from HtmlElement */
223   public Q onerror(String value) {
224      super.onerror(value);
225      return this;
226   }
227
228   @Override /* Overridden from HtmlElement */
229   public Q onfocus(String value) {
230      super.onfocus(value);
231      return this;
232   }
233
234   @Override /* Overridden from HtmlElement */
235   public Q oninput(String value) {
236      super.oninput(value);
237      return this;
238   }
239
240   @Override /* Overridden from HtmlElement */
241   public Q oninvalid(String value) {
242      super.oninvalid(value);
243      return this;
244   }
245
246   @Override /* Overridden from HtmlElement */
247   public Q onkeydown(String value) {
248      super.onkeydown(value);
249      return this;
250   }
251
252   @Override /* Overridden from HtmlElement */
253   public Q onkeypress(String value) {
254      super.onkeypress(value);
255      return this;
256   }
257
258   @Override /* Overridden from HtmlElement */
259   public Q onkeyup(String value) {
260      super.onkeyup(value);
261      return this;
262   }
263
264   @Override /* Overridden from HtmlElement */
265   public Q onload(String value) {
266      super.onload(value);
267      return this;
268   }
269
270   @Override /* Overridden from HtmlElement */
271   public Q onloadeddata(String value) {
272      super.onloadeddata(value);
273      return this;
274   }
275
276   @Override /* Overridden from HtmlElement */
277   public Q onloadedmetadata(String value) {
278      super.onloadedmetadata(value);
279      return this;
280   }
281
282   @Override /* Overridden from HtmlElement */
283   public Q onloadstart(String value) {
284      super.onloadstart(value);
285      return this;
286   }
287
288   @Override /* Overridden from HtmlElement */
289   public Q onmousedown(String value) {
290      super.onmousedown(value);
291      return this;
292   }
293
294   @Override /* Overridden from HtmlElement */
295   public Q onmouseenter(String value) {
296      super.onmouseenter(value);
297      return this;
298   }
299
300   @Override /* Overridden from HtmlElement */
301   public Q onmouseleave(String value) {
302      super.onmouseleave(value);
303      return this;
304   }
305
306   @Override /* Overridden from HtmlElement */
307   public Q onmousemove(String value) {
308      super.onmousemove(value);
309      return this;
310   }
311
312   @Override /* Overridden from HtmlElement */
313   public Q onmouseout(String value) {
314      super.onmouseout(value);
315      return this;
316   }
317
318   @Override /* Overridden from HtmlElement */
319   public Q onmouseover(String value) {
320      super.onmouseover(value);
321      return this;
322   }
323
324   @Override /* Overridden from HtmlElement */
325   public Q onmouseup(String value) {
326      super.onmouseup(value);
327      return this;
328   }
329
330   @Override /* Overridden from HtmlElement */
331   public Q onmousewheel(String value) {
332      super.onmousewheel(value);
333      return this;
334   }
335
336   @Override /* Overridden from HtmlElement */
337   public Q onpause(String value) {
338      super.onpause(value);
339      return this;
340   }
341
342   @Override /* Overridden from HtmlElement */
343   public Q onplay(String value) {
344      super.onplay(value);
345      return this;
346   }
347
348   @Override /* Overridden from HtmlElement */
349   public Q onplaying(String value) {
350      super.onplaying(value);
351      return this;
352   }
353
354   @Override /* Overridden from HtmlElement */
355   public Q onprogress(String value) {
356      super.onprogress(value);
357      return this;
358   }
359
360   @Override /* Overridden from HtmlElement */
361   public Q onratechange(String value) {
362      super.onratechange(value);
363      return this;
364   }
365
366   @Override /* Overridden from HtmlElement */
367   public Q onreset(String value) {
368      super.onreset(value);
369      return this;
370   }
371
372   @Override /* Overridden from HtmlElement */
373   public Q onresize(String value) {
374      super.onresize(value);
375      return this;
376   }
377
378   @Override /* Overridden from HtmlElement */
379   public Q onscroll(String value) {
380      super.onscroll(value);
381      return this;
382   }
383
384   @Override /* Overridden from HtmlElement */
385   public Q onseeked(String value) {
386      super.onseeked(value);
387      return this;
388   }
389
390   @Override /* Overridden from HtmlElement */
391   public Q onseeking(String value) {
392      super.onseeking(value);
393      return this;
394   }
395
396   @Override /* Overridden from HtmlElement */
397   public Q onselect(String value) {
398      super.onselect(value);
399      return this;
400   }
401
402   @Override /* Overridden from HtmlElement */
403   public Q onshow(String value) {
404      super.onshow(value);
405      return this;
406   }
407
408   @Override /* Overridden from HtmlElement */
409   public Q onstalled(String value) {
410      super.onstalled(value);
411      return this;
412   }
413
414   @Override /* Overridden from HtmlElement */
415   public Q onsubmit(String value) {
416      super.onsubmit(value);
417      return this;
418   }
419
420   @Override /* Overridden from HtmlElement */
421   public Q onsuspend(String value) {
422      super.onsuspend(value);
423      return this;
424   }
425
426   @Override /* Overridden from HtmlElement */
427   public Q ontimeupdate(String value) {
428      super.ontimeupdate(value);
429      return this;
430   }
431
432   @Override /* Overridden from HtmlElement */
433   public Q ontoggle(String value) {
434      super.ontoggle(value);
435      return this;
436   }
437
438   @Override /* Overridden from HtmlElement */
439   public Q onvolumechange(String value) {
440      super.onvolumechange(value);
441      return this;
442   }
443
444   @Override /* Overridden from HtmlElement */
445   public Q onwaiting(String value) {
446      super.onwaiting(value);
447      return this;
448   }
449
450   @Override /* Overridden from HtmlElement */
451   public Q spellcheck(Object value) {
452      super.spellcheck(value);
453      return this;
454   }
455
456   @Override /* Overridden from HtmlElement */
457   public Q style(String value) {
458      super.style(value);
459      return this;
460   }
461
462   @Override /* Overridden from HtmlElement */
463   public Q tabindex(Object value) {
464      super.tabindex(value);
465      return this;
466   }
467
468   @Override /* Overridden from HtmlElement */
469   public Q title(String value) {
470      super.title(value);
471      return this;
472   }
473
474   @Override /* Overridden from HtmlElement */
475   public Q translate(Object value) {
476      super.translate(value);
477      return this;
478   }
479
480   @Override /* Overridden from HtmlElementMixed */
481   public Q child(Object value) {
482      super.child(value);
483      return this;
484   }
485
486   @Override /* Overridden from HtmlElementMixed */
487   public Q children(Object...value) {
488      super.children(value);
489      return this;
490   }
491}