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-var-element">&lt;var&gt;</a>
023 * element.
024 *
025 * <p>
026 * The var element represents a variable. It is used to mark up variables in mathematical
027 * expressions, programming code, or other contexts where a variable name needs to be
028 * distinguished from regular text. The var element is typically rendered in italics and
029 * is commonly used in documentation, tutorials, and technical writing to identify
030 * variable names, function parameters, or mathematical variables.
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>// Simple variable</jc>
037 *    Var <jv>simple</jv> = <jsm>var</jsm>(<js>"x"</js>);
038 *
039 *    <jc>// Var with styling</jc>
040 *    Var <jv>styled</jv> = <jsm>var</jsm>(<js>"userName"</js>)
041 *       ._class(<js>"variable"</js>);
042 *
043 *    <jc>// Var with complex content</jc>
044 *    Var <jv>complex</jv> = <jsm>var</jsm>(
045 *       <js>"The variable "</js>,
046 *       <jsm>strong</jsm>(<js>"count"</js>),
047 *       <js>" represents the number of items."</js>
048 *    );
049 *
050 *    <jc>// Var with ID</jc>
051 *    Var <jv>withId</jv> = <jsm>var</jsm>(<js>"totalCount"</js>)
052 *       .id(<js>"variable-name"</js>);
053 *
054 *    <jc>// Var with styling</jc>
055 *    Var <jv>styled2</jv> = <jsm>var</jsm>(<js>"customVariable"</js>)
056 *       .style(<js>"color: #0066cc; font-style: italic;"</js>)
057 *       .children("maxValue");
058 *
059 *    // Var with multiple elements
060 *    Var multiple = var()
061 *       .children(
062 *          "The ",
063 *          var().children("x"),
064 *          " and ",
065 *          var().children("y"),
066 *          " variables are used in the equation."
067 *       );
068 *
069 *    // Var with links
070 *    Var withLinks = var()
071 *       .children(
072 *          "See ",
073 *          a().href("/docs/variables").children("variable documentation"),
074 *          " for more information."
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#var() var()}
084 *       <li class='jm'>{@link HtmlBuilder#var(Object...) var(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 = "var")
094public class Var extends HtmlElementMixed {
095
096   /**
097    * Creates an empty {@link Var} element.
098    */
099   public Var() {}
100
101   /**
102    * Creates a {@link Var} element with the specified child nodes.
103    *
104    * @param children The child nodes.
105    */
106   public Var(Object...children) {
107      children(children);
108   }
109
110   @Override /* Overridden from HtmlElement */
111   public Var _class(String value) { // NOSONAR - Intentional naming.
112      super._class(value);
113      return this;
114   }
115
116   @Override /* Overridden from HtmlElement */
117   public Var accesskey(String value) {
118      super.accesskey(value);
119      return this;
120   }
121
122   @Override /* Overridden from HtmlElement */
123   public Var attr(String key, Object val) {
124      super.attr(key, val);
125      return this;
126   }
127
128   @Override /* Overridden from HtmlElement */
129   public Var attrUri(String key, Object val) {
130      super.attrUri(key, val);
131      return this;
132   }
133
134   @Override /* Overridden from HtmlElementMixed */
135   public Var child(Object value) {
136      super.child(value);
137      return this;
138   }
139
140   @Override /* Overridden from HtmlElementMixed */
141   public Var children(Object...value) {
142      super.children(value);
143      return this;
144   }
145
146   @Override /* Overridden from HtmlElement */
147   public Var contenteditable(Object value) {
148      super.contenteditable(value);
149      return this;
150   }
151
152   @Override /* Overridden from HtmlElement */
153   public Var dir(String value) {
154      super.dir(value);
155      return this;
156   }
157
158   @Override /* Overridden from HtmlElement */
159   public Var hidden(Object value) {
160      super.hidden(value);
161      return this;
162   }
163
164   @Override /* Overridden from HtmlElement */
165   public Var id(String value) {
166      super.id(value);
167      return this;
168   }
169
170   @Override /* Overridden from HtmlElement */
171   public Var lang(String value) {
172      super.lang(value);
173      return this;
174   }
175
176   @Override /* Overridden from HtmlElement */
177   public Var onabort(String value) {
178      super.onabort(value);
179      return this;
180   }
181
182   @Override /* Overridden from HtmlElement */
183   public Var onblur(String value) {
184      super.onblur(value);
185      return this;
186   }
187
188   @Override /* Overridden from HtmlElement */
189   public Var oncancel(String value) {
190      super.oncancel(value);
191      return this;
192   }
193
194   @Override /* Overridden from HtmlElement */
195   public Var oncanplay(String value) {
196      super.oncanplay(value);
197      return this;
198   }
199
200   @Override /* Overridden from HtmlElement */
201   public Var oncanplaythrough(String value) {
202      super.oncanplaythrough(value);
203      return this;
204   }
205
206   @Override /* Overridden from HtmlElement */
207   public Var onchange(String value) {
208      super.onchange(value);
209      return this;
210   }
211
212   @Override /* Overridden from HtmlElement */
213   public Var onclick(String value) {
214      super.onclick(value);
215      return this;
216   }
217
218   @Override /* Overridden from HtmlElement */
219   public Var oncuechange(String value) {
220      super.oncuechange(value);
221      return this;
222   }
223
224   @Override /* Overridden from HtmlElement */
225   public Var ondblclick(String value) {
226      super.ondblclick(value);
227      return this;
228   }
229
230   @Override /* Overridden from HtmlElement */
231   public Var ondurationchange(String value) {
232      super.ondurationchange(value);
233      return this;
234   }
235
236   @Override /* Overridden from HtmlElement */
237   public Var onemptied(String value) {
238      super.onemptied(value);
239      return this;
240   }
241
242   @Override /* Overridden from HtmlElement */
243   public Var onended(String value) {
244      super.onended(value);
245      return this;
246   }
247
248   @Override /* Overridden from HtmlElement */
249   public Var onerror(String value) {
250      super.onerror(value);
251      return this;
252   }
253
254   @Override /* Overridden from HtmlElement */
255   public Var onfocus(String value) {
256      super.onfocus(value);
257      return this;
258   }
259
260   @Override /* Overridden from HtmlElement */
261   public Var oninput(String value) {
262      super.oninput(value);
263      return this;
264   }
265
266   @Override /* Overridden from HtmlElement */
267   public Var oninvalid(String value) {
268      super.oninvalid(value);
269      return this;
270   }
271
272   @Override /* Overridden from HtmlElement */
273   public Var onkeydown(String value) {
274      super.onkeydown(value);
275      return this;
276   }
277
278   @Override /* Overridden from HtmlElement */
279   public Var onkeypress(String value) {
280      super.onkeypress(value);
281      return this;
282   }
283
284   @Override /* Overridden from HtmlElement */
285   public Var onkeyup(String value) {
286      super.onkeyup(value);
287      return this;
288   }
289
290   @Override /* Overridden from HtmlElement */
291   public Var onload(String value) {
292      super.onload(value);
293      return this;
294   }
295
296   @Override /* Overridden from HtmlElement */
297   public Var onloadeddata(String value) {
298      super.onloadeddata(value);
299      return this;
300   }
301
302   @Override /* Overridden from HtmlElement */
303   public Var onloadedmetadata(String value) {
304      super.onloadedmetadata(value);
305      return this;
306   }
307
308   @Override /* Overridden from HtmlElement */
309   public Var onloadstart(String value) {
310      super.onloadstart(value);
311      return this;
312   }
313
314   @Override /* Overridden from HtmlElement */
315   public Var onmousedown(String value) {
316      super.onmousedown(value);
317      return this;
318   }
319
320   @Override /* Overridden from HtmlElement */
321   public Var onmouseenter(String value) {
322      super.onmouseenter(value);
323      return this;
324   }
325
326   @Override /* Overridden from HtmlElement */
327   public Var onmouseleave(String value) {
328      super.onmouseleave(value);
329      return this;
330   }
331
332   @Override /* Overridden from HtmlElement */
333   public Var onmousemove(String value) {
334      super.onmousemove(value);
335      return this;
336   }
337
338   @Override /* Overridden from HtmlElement */
339   public Var onmouseout(String value) {
340      super.onmouseout(value);
341      return this;
342   }
343
344   @Override /* Overridden from HtmlElement */
345   public Var onmouseover(String value) {
346      super.onmouseover(value);
347      return this;
348   }
349
350   @Override /* Overridden from HtmlElement */
351   public Var onmouseup(String value) {
352      super.onmouseup(value);
353      return this;
354   }
355
356   @Override /* Overridden from HtmlElement */
357   public Var onmousewheel(String value) {
358      super.onmousewheel(value);
359      return this;
360   }
361
362   @Override /* Overridden from HtmlElement */
363   public Var onpause(String value) {
364      super.onpause(value);
365      return this;
366   }
367
368   @Override /* Overridden from HtmlElement */
369   public Var onplay(String value) {
370      super.onplay(value);
371      return this;
372   }
373
374   @Override /* Overridden from HtmlElement */
375   public Var onplaying(String value) {
376      super.onplaying(value);
377      return this;
378   }
379
380   @Override /* Overridden from HtmlElement */
381   public Var onprogress(String value) {
382      super.onprogress(value);
383      return this;
384   }
385
386   @Override /* Overridden from HtmlElement */
387   public Var onratechange(String value) {
388      super.onratechange(value);
389      return this;
390   }
391
392   @Override /* Overridden from HtmlElement */
393   public Var onreset(String value) {
394      super.onreset(value);
395      return this;
396   }
397
398   @Override /* Overridden from HtmlElement */
399   public Var onresize(String value) {
400      super.onresize(value);
401      return this;
402   }
403
404   @Override /* Overridden from HtmlElement */
405   public Var onscroll(String value) {
406      super.onscroll(value);
407      return this;
408   }
409
410   @Override /* Overridden from HtmlElement */
411   public Var onseeked(String value) {
412      super.onseeked(value);
413      return this;
414   }
415
416   @Override /* Overridden from HtmlElement */
417   public Var onseeking(String value) {
418      super.onseeking(value);
419      return this;
420   }
421
422   @Override /* Overridden from HtmlElement */
423   public Var onselect(String value) {
424      super.onselect(value);
425      return this;
426   }
427
428   @Override /* Overridden from HtmlElement */
429   public Var onshow(String value) {
430      super.onshow(value);
431      return this;
432   }
433
434   @Override /* Overridden from HtmlElement */
435   public Var onstalled(String value) {
436      super.onstalled(value);
437      return this;
438   }
439
440   @Override /* Overridden from HtmlElement */
441   public Var onsubmit(String value) {
442      super.onsubmit(value);
443      return this;
444   }
445
446   @Override /* Overridden from HtmlElement */
447   public Var onsuspend(String value) {
448      super.onsuspend(value);
449      return this;
450   }
451
452   @Override /* Overridden from HtmlElement */
453   public Var ontimeupdate(String value) {
454      super.ontimeupdate(value);
455      return this;
456   }
457
458   @Override /* Overridden from HtmlElement */
459   public Var ontoggle(String value) {
460      super.ontoggle(value);
461      return this;
462   }
463
464   @Override /* Overridden from HtmlElement */
465   public Var onvolumechange(String value) {
466      super.onvolumechange(value);
467      return this;
468   }
469
470   @Override /* Overridden from HtmlElement */
471   public Var onwaiting(String value) {
472      super.onwaiting(value);
473      return this;
474   }
475
476   @Override /* Overridden from HtmlElement */
477   public Var spellcheck(Object value) {
478      super.spellcheck(value);
479      return this;
480   }
481
482   @Override /* Overridden from HtmlElement */
483   public Var style(String value) {
484      super.style(value);
485      return this;
486   }
487
488   @Override /* Overridden from HtmlElement */
489   public Var tabindex(Object value) {
490      super.tabindex(value);
491      return this;
492   }
493
494   @Override /* Overridden from HtmlElement */
495   public Var title(String value) {
496      super.title(value);
497      return this;
498   }
499
500   @Override /* Overridden from HtmlElement */
501   public Var translate(Object value) {
502      super.translate(value);
503      return this;
504   }
505}