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