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