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/forms.html#the-meter-element">&lt;meter&gt;</a>
024 * element.
025 *
026 * <p>
027 * The meter element represents a scalar measurement within a known range, or a fractional value.
028 * It is used to display a gauge or meter showing a value within a defined range, such as disk
029 * usage, memory usage, or progress. The meter element is not suitable for representing a range
030 * of values (use the input element with type="range" for that). It is typically rendered as a
031 * visual gauge or bar that shows the current value relative to the minimum and maximum values.
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 meter</jc>
038 *    Meter <jv>simple</jv> = <jsm>meter</jsm>()
039 *       .value(50)
040 *       .min(0)
041 *       .max(100);
042 *
043 *    <jc>// Meter with styling</jc>
044 *    Meter <jv>styled</jv> = <jsm>meter</jsm>()
045 *       ._class(<js>"progress-meter"</js>)
046 *       .value(75)
047 *       .min(0)
048 *       .max(100);
049 *
050 *    <jc>// Meter with complex content</jc>
051 *    Meter <jv>complex</jv> = <jsm>meter</jsm>()
052 *       .value(60)
053 *       .min(0)
054 *       .max(100)
055 *       .low(25)
056 *       .high(75)
057 *       .optimum(50);
058 *
059 *    <jc>// Meter with ID</jc>
060 *    Meter <jv>withId</jv> = <jsm>meter</jsm>()
061 *       .id(<js>"disk-usage"</js>)
062 *       .value(80)
063 *       .min(0)
064 *       .max(100);
065 *
066 *    <jc>// Meter with styling</jc>
067 *    Meter <jv>styled2</jv> = <jsm>meter</jsm>()
068 *       .style(<js>"width: 200px; height: 20px;"</js>)
069 *       .value(40)
070 *       .min(0)
071 *       .max(100);
072 *
073 *    <jc>// Meter with multiple attributes</jc>
074 *    Meter <jv>multiple</jv> = <jsm>meter</jsm>()
075 *       .value(85)
076 *       .min(0)
077 *       .max(100)
078 *       .low(20)
079 *       .high(80)
080 *       .optimum(50)
081 *       .title(<js>"Disk Usage: 85%"</js>);
082 *
083 *    // Meter with form
084 *    Meter withForm = new Meter()
085 *       .form("usage-form")
086 *       .value(30)
087 *       .min(0)
088 *       .max(100);
089 * </p>
090 *
091 * <h5 class='section'>See Also:</h5><ul>
092 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauBeanHtml5">juneau-bean-html5</a>
093 * </ul>
094 */
095@Bean(typeName="meter")
096public class Meter extends HtmlElementMixed {
097
098   /**
099    * Creates an empty {@link Meter} element.
100    */
101   public Meter() {}
102
103   /**
104    * Creates a {@link Meter} element with the specified child nodes.
105    *
106    * @param children The child nodes.
107    */
108   public Meter(Object...children) {
109      children(children);
110   }
111
112   /**
113    * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-meter-high">high</a> attribute.
114    *
115    * <p>
116    * Low limit of high range.
117    *
118    * @param high
119    *    The new value for this attribute.
120    *    Typically a {@link Number} or {@link String}.
121    * @return This object.
122    */
123   public Meter high(Object value) {
124      attr("high", value);
125      return this;
126   }
127
128   /**
129    * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-meter-low">low</a> attribute.
130    *
131    * <p>
132    * High limit of low range.
133    *
134    * @param low
135    *    The new value for this attribute.
136    *    Typically a {@link Number} or {@link String}.
137    * @return This object.
138    */
139   public Meter low(Object value) {
140      attr("low", value);
141      return this;
142   }
143
144   /**
145    * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-meter-max">max</a> attribute.
146    *
147    * <p>
148    * Upper bound of range.
149    *
150    * @param max
151    *    The new value for this attribute.
152    *    Typically a {@link Number} or {@link String}.
153    * @return This object.
154    */
155   public Meter max(Object value) {
156      attr("max", value);
157      return this;
158   }
159
160   /**
161    * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-meter-min">min</a> attribute.
162    *
163    * <p>
164    * Lower bound of range.
165    *
166    * @param min
167    *    The new value for this attribute.
168    *    Typically a {@link Number} or {@link String}.
169    * @return This object.
170    */
171   public Meter min(Object value) {
172      attr("min", value);
173      return this;
174   }
175
176   /**
177    * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-meter-optimum">optimum</a> attribute.
178    *
179    * <p>
180    * Optimum value in gauge.
181    *
182    * @param optimum
183    *    The new value for this attribute.
184    *    Typically a {@link Number} or {@link String}.
185    * @return This object.
186    */
187   public Meter optimum(Object value) {
188      attr("optimum", value);
189      return this;
190   }
191
192   /**
193    * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-meter-value">value</a> attribute.
194    *
195    * <p>
196    * Current value of the element.
197    *
198    * @param value
199    *    The new value for this attribute.
200    *    Typically a {@link Number} or {@link String}.
201    * @return This object.
202    */
203   public Meter value(Object value) {
204      attr("value", value);
205      return this;
206   }
207
208   //-----------------------------------------------------------------------------------------------------------------
209   // Overridden methods
210   //-----------------------------------------------------------------------------------------------------------------
211   @Override /* Overridden from HtmlElement */
212   public Meter _class(String value) {  // NOSONAR - Intentional naming.
213      super._class(value);
214      return this;
215   }
216
217   @Override /* Overridden from HtmlElement */
218   public Meter accesskey(String value) {
219      super.accesskey(value);
220      return this;
221   }
222
223   @Override /* Overridden from HtmlElement */
224   public Meter contenteditable(Object value) {
225      super.contenteditable(value);
226      return this;
227   }
228
229   @Override /* Overridden from HtmlElement */
230   public Meter dir(String value) {
231      super.dir(value);
232      return this;
233   }
234
235   @Override /* Overridden from HtmlElement */
236   public Meter hidden(Object value) {
237      super.hidden(value);
238      return this;
239   }
240
241   @Override /* Overridden from HtmlElement */
242   public Meter id(String value) {
243      super.id(value);
244      return this;
245   }
246
247   @Override /* Overridden from HtmlElement */
248   public Meter lang(String value) {
249      super.lang(value);
250      return this;
251   }
252
253   @Override /* Overridden from HtmlElement */
254   public Meter onabort(String value) {
255      super.onabort(value);
256      return this;
257   }
258
259   @Override /* Overridden from HtmlElement */
260   public Meter onblur(String value) {
261      super.onblur(value);
262      return this;
263   }
264
265   @Override /* Overridden from HtmlElement */
266   public Meter oncancel(String value) {
267      super.oncancel(value);
268      return this;
269   }
270
271   @Override /* Overridden from HtmlElement */
272   public Meter oncanplay(String value) {
273      super.oncanplay(value);
274      return this;
275   }
276
277   @Override /* Overridden from HtmlElement */
278   public Meter oncanplaythrough(String value) {
279      super.oncanplaythrough(value);
280      return this;
281   }
282
283   @Override /* Overridden from HtmlElement */
284   public Meter onchange(String value) {
285      super.onchange(value);
286      return this;
287   }
288
289   @Override /* Overridden from HtmlElement */
290   public Meter onclick(String value) {
291      super.onclick(value);
292      return this;
293   }
294
295   @Override /* Overridden from HtmlElement */
296   public Meter oncuechange(String value) {
297      super.oncuechange(value);
298      return this;
299   }
300
301   @Override /* Overridden from HtmlElement */
302   public Meter ondblclick(String value) {
303      super.ondblclick(value);
304      return this;
305   }
306
307   @Override /* Overridden from HtmlElement */
308   public Meter ondurationchange(String value) {
309      super.ondurationchange(value);
310      return this;
311   }
312
313   @Override /* Overridden from HtmlElement */
314   public Meter onemptied(String value) {
315      super.onemptied(value);
316      return this;
317   }
318
319   @Override /* Overridden from HtmlElement */
320   public Meter onended(String value) {
321      super.onended(value);
322      return this;
323   }
324
325   @Override /* Overridden from HtmlElement */
326   public Meter onerror(String value) {
327      super.onerror(value);
328      return this;
329   }
330
331   @Override /* Overridden from HtmlElement */
332   public Meter onfocus(String value) {
333      super.onfocus(value);
334      return this;
335   }
336
337   @Override /* Overridden from HtmlElement */
338   public Meter oninput(String value) {
339      super.oninput(value);
340      return this;
341   }
342
343   @Override /* Overridden from HtmlElement */
344   public Meter oninvalid(String value) {
345      super.oninvalid(value);
346      return this;
347   }
348
349   @Override /* Overridden from HtmlElement */
350   public Meter onkeydown(String value) {
351      super.onkeydown(value);
352      return this;
353   }
354
355   @Override /* Overridden from HtmlElement */
356   public Meter onkeypress(String value) {
357      super.onkeypress(value);
358      return this;
359   }
360
361   @Override /* Overridden from HtmlElement */
362   public Meter onkeyup(String value) {
363      super.onkeyup(value);
364      return this;
365   }
366
367   @Override /* Overridden from HtmlElement */
368   public Meter onload(String value) {
369      super.onload(value);
370      return this;
371   }
372
373   @Override /* Overridden from HtmlElement */
374   public Meter onloadeddata(String value) {
375      super.onloadeddata(value);
376      return this;
377   }
378
379   @Override /* Overridden from HtmlElement */
380   public Meter onloadedmetadata(String value) {
381      super.onloadedmetadata(value);
382      return this;
383   }
384
385   @Override /* Overridden from HtmlElement */
386   public Meter onloadstart(String value) {
387      super.onloadstart(value);
388      return this;
389   }
390
391   @Override /* Overridden from HtmlElement */
392   public Meter onmousedown(String value) {
393      super.onmousedown(value);
394      return this;
395   }
396
397   @Override /* Overridden from HtmlElement */
398   public Meter onmouseenter(String value) {
399      super.onmouseenter(value);
400      return this;
401   }
402
403   @Override /* Overridden from HtmlElement */
404   public Meter onmouseleave(String value) {
405      super.onmouseleave(value);
406      return this;
407   }
408
409   @Override /* Overridden from HtmlElement */
410   public Meter onmousemove(String value) {
411      super.onmousemove(value);
412      return this;
413   }
414
415   @Override /* Overridden from HtmlElement */
416   public Meter onmouseout(String value) {
417      super.onmouseout(value);
418      return this;
419   }
420
421   @Override /* Overridden from HtmlElement */
422   public Meter onmouseover(String value) {
423      super.onmouseover(value);
424      return this;
425   }
426
427   @Override /* Overridden from HtmlElement */
428   public Meter onmouseup(String value) {
429      super.onmouseup(value);
430      return this;
431   }
432
433   @Override /* Overridden from HtmlElement */
434   public Meter onmousewheel(String value) {
435      super.onmousewheel(value);
436      return this;
437   }
438
439   @Override /* Overridden from HtmlElement */
440   public Meter onpause(String value) {
441      super.onpause(value);
442      return this;
443   }
444
445   @Override /* Overridden from HtmlElement */
446   public Meter onplay(String value) {
447      super.onplay(value);
448      return this;
449   }
450
451   @Override /* Overridden from HtmlElement */
452   public Meter onplaying(String value) {
453      super.onplaying(value);
454      return this;
455   }
456
457   @Override /* Overridden from HtmlElement */
458   public Meter onprogress(String value) {
459      super.onprogress(value);
460      return this;
461   }
462
463   @Override /* Overridden from HtmlElement */
464   public Meter onratechange(String value) {
465      super.onratechange(value);
466      return this;
467   }
468
469   @Override /* Overridden from HtmlElement */
470   public Meter onreset(String value) {
471      super.onreset(value);
472      return this;
473   }
474
475   @Override /* Overridden from HtmlElement */
476   public Meter onresize(String value) {
477      super.onresize(value);
478      return this;
479   }
480
481   @Override /* Overridden from HtmlElement */
482   public Meter onscroll(String value) {
483      super.onscroll(value);
484      return this;
485   }
486
487   @Override /* Overridden from HtmlElement */
488   public Meter onseeked(String value) {
489      super.onseeked(value);
490      return this;
491   }
492
493   @Override /* Overridden from HtmlElement */
494   public Meter onseeking(String value) {
495      super.onseeking(value);
496      return this;
497   }
498
499   @Override /* Overridden from HtmlElement */
500   public Meter onselect(String value) {
501      super.onselect(value);
502      return this;
503   }
504
505   @Override /* Overridden from HtmlElement */
506   public Meter onshow(String value) {
507      super.onshow(value);
508      return this;
509   }
510
511   @Override /* Overridden from HtmlElement */
512   public Meter onstalled(String value) {
513      super.onstalled(value);
514      return this;
515   }
516
517   @Override /* Overridden from HtmlElement */
518   public Meter onsubmit(String value) {
519      super.onsubmit(value);
520      return this;
521   }
522
523   @Override /* Overridden from HtmlElement */
524   public Meter onsuspend(String value) {
525      super.onsuspend(value);
526      return this;
527   }
528
529   @Override /* Overridden from HtmlElement */
530   public Meter ontimeupdate(String value) {
531      super.ontimeupdate(value);
532      return this;
533   }
534
535   @Override /* Overridden from HtmlElement */
536   public Meter ontoggle(String value) {
537      super.ontoggle(value);
538      return this;
539   }
540
541   @Override /* Overridden from HtmlElement */
542   public Meter onvolumechange(String value) {
543      super.onvolumechange(value);
544      return this;
545   }
546
547   @Override /* Overridden from HtmlElement */
548   public Meter onwaiting(String value) {
549      super.onwaiting(value);
550      return this;
551   }
552
553   @Override /* Overridden from HtmlElement */
554   public Meter spellcheck(Object value) {
555      super.spellcheck(value);
556      return this;
557   }
558
559   @Override /* Overridden from HtmlElement */
560   public Meter style(String value) {
561      super.style(value);
562      return this;
563   }
564
565   @Override /* Overridden from HtmlElement */
566   public Meter tabindex(Object value) {
567      super.tabindex(value);
568      return this;
569   }
570
571   @Override /* Overridden from HtmlElement */
572   public Meter title(String value) {
573      super.title(value);
574      return this;
575   }
576
577   @Override /* Overridden from HtmlElement */
578   public Meter translate(Object value) {
579      super.translate(value);
580      return this;
581   }
582
583   @Override /* Overridden from HtmlElementMixed */
584   public Meter child(Object value) {
585      super.child(value);
586      return this;
587   }
588
589   @Override /* Overridden from HtmlElementMixed */
590   public Meter children(Object...value) {
591      super.children(value);
592      return this;
593   }
594}