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/scripting-1.html#the-canvas-element">&lt;canvas&gt;</a>
023 * element.
024 *
025 * <p>
026 * The canvas element provides a resolution-dependent bitmap canvas that can be used for rendering
027 * graphs, game graphics, or other visual images on the fly. It is used with JavaScript to create
028 * dynamic, scriptable rendering of 2D shapes and bitmap images. The canvas element requires both
029 * width and height attributes to define the canvas size, and the actual drawing is done through
030 * the Canvas API in JavaScript.
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>// Basic canvas</jc>
037 *    Canvas <jv>basic</jv> = <jsm>canvas</jsm>(300, 200);
038 *
039 *    <jc>// Canvas with ID for JavaScript access</jc>
040 *    Canvas <jv>withId</jv> = <jsm>canvas</jsm>(400, 300)
041 *       .id(<js>"myCanvas"</js>);
042 *
043 *    <jc>// Canvas with styling</jc>
044 *    Canvas <jv>styled</jv> = <jsm>canvas</jsm>(500, 400)
045 *       .id(<js>"drawingCanvas"</js>)
046 *       ._class(<js>"canvas-element"</js>)
047 *       .style(<js>"border: 1px solid #ccc;"</js>);
048 *
049 *    <jc>// Canvas with event handlers</jc>
050 *    Canvas <jv>interactive</jv> = <jsm>canvas</jsm>(800, 600)
051 *       .id(<js>"gameCanvas"</js>)
052 *       .onclick(<js>"handleCanvasClick(event)"</js>)
053 *       .onmousemove(<js>"handleMouseMove(event)"</js>);
054 *
055 *    <jc>// Canvas with fallback content</jc>
056 *    Canvas <jv>withFallback</jv> = <jsm>canvas</jsm>(600, 400)
057 *       .id(<js>"chartCanvas"</js>)
058 *       .children(<js>"Your browser does not support the canvas element."</js>);
059 *
060 *    <jc>// Canvas for data visualization</jc>
061 *    Canvas <jv>chart</jv> = <jsm>canvas</jsm>(800, 500)
062 *       .id(<js>"dataChart"</js>)
063 *       .title(<js>"Interactive Data Chart"</js>);
064 *
065 *    <jc>// Canvas with accessibility</jc>
066 *    Canvas <jv>accessible</jv> = <jsm>canvas</jsm>(400, 300)
067 *       .id(<js>"accessibleCanvas"</js>)
068 *       .title(<js>"Interactive drawing canvas"</js>)
069 *       .children(<js>"Use your mouse to draw on this canvas."</js>);
070 * </p>
071 *
072 * <p>
073 * The following convenience methods are provided for constructing instances of this bean:
074 * <ul class='javatree'>
075 *    <li class='jc'>{@link HtmlBuilder}
076 *    <ul class='javatree'>
077 *       <li class='jm'>{@link HtmlBuilder#canvas() canvas()}
078 *       <li class='jm'>{@link HtmlBuilder#canvas(Number, Number) canvas(Number, Number)}
079 *    </ul>
080 * </ul>
081 * </p>
082 *
083 * <h5 class='section'>See Also:</h5><ul>
084 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauBeanHtml5">juneau-bean-html5</a>
085 * </ul>
086 */
087@Bean(typeName = "canvas")
088public class Canvas extends HtmlElementMixed {
089
090   /**
091    * Creates an empty {@link Canvas} element.
092    */
093   public Canvas() {}
094
095   /**
096    * Creates a {@link Canvas} element with the specified {@link Canvas#width(Object)} and
097    * {@link Canvas#height(Object)} attributes.
098    *
099    * @param width The {@link Canvas#width(Object)} attribute.
100    * @param height The {@link Canvas#height(Object)} attribute.
101    */
102   public Canvas(Number width, Number height) {
103      width(width).height(height);
104   }
105
106   @Override /* Overridden from HtmlElement */
107   public Canvas _class(String value) { // NOSONAR - Intentional naming.
108      super._class(value);
109      return this;
110   }
111
112   @Override /* Overridden from HtmlElement */
113   public Canvas accesskey(String value) {
114      super.accesskey(value);
115      return this;
116   }
117
118   @Override /* Overridden from HtmlElement */
119   public Canvas attr(String key, Object val) {
120      super.attr(key, val);
121      return this;
122   }
123
124   @Override /* Overridden from HtmlElement */
125   public Canvas attrUri(String key, Object val) {
126      super.attrUri(key, val);
127      return this;
128   }
129
130   @Override /* Overridden from HtmlElementMixed */
131   public Canvas child(Object value) {
132      super.child(value);
133      return this;
134   }
135
136   @Override /* Overridden from HtmlElementMixed */
137   public Canvas children(Object...value) {
138      super.children(value);
139      return this;
140   }
141
142   @Override /* Overridden from HtmlElement */
143   public Canvas contenteditable(Object value) {
144      super.contenteditable(value);
145      return this;
146   }
147
148   @Override /* Overridden from HtmlElement */
149   public Canvas dir(String value) {
150      super.dir(value);
151      return this;
152   }
153
154   /**
155    * <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#attr-canvas-height">height</a> attribute.
156    *
157    * <p>
158    * Vertical dimension.
159    *
160    * @param value
161    *    The new value for this attribute.
162    *    Typically a {@link Number} or {@link String}.
163    * @return This object.
164    */
165   public Canvas height(Object value) {
166      attr("height", value);
167      return this;
168   }
169
170   @Override /* Overridden from HtmlElement */
171   public Canvas hidden(Object value) {
172      super.hidden(value);
173      return this;
174   }
175
176   @Override /* Overridden from HtmlElement */
177   public Canvas id(String value) {
178      super.id(value);
179      return this;
180   }
181
182   @Override /* Overridden from HtmlElement */
183   public Canvas lang(String value) {
184      super.lang(value);
185      return this;
186   }
187
188   @Override /* Overridden from HtmlElement */
189   public Canvas onabort(String value) {
190      super.onabort(value);
191      return this;
192   }
193
194   @Override /* Overridden from HtmlElement */
195   public Canvas onblur(String value) {
196      super.onblur(value);
197      return this;
198   }
199
200   @Override /* Overridden from HtmlElement */
201   public Canvas oncancel(String value) {
202      super.oncancel(value);
203      return this;
204   }
205
206   @Override /* Overridden from HtmlElement */
207   public Canvas oncanplay(String value) {
208      super.oncanplay(value);
209      return this;
210   }
211
212   @Override /* Overridden from HtmlElement */
213   public Canvas oncanplaythrough(String value) {
214      super.oncanplaythrough(value);
215      return this;
216   }
217
218   @Override /* Overridden from HtmlElement */
219   public Canvas onchange(String value) {
220      super.onchange(value);
221      return this;
222   }
223
224   @Override /* Overridden from HtmlElement */
225   public Canvas onclick(String value) {
226      super.onclick(value);
227      return this;
228   }
229
230   @Override /* Overridden from HtmlElement */
231   public Canvas oncuechange(String value) {
232      super.oncuechange(value);
233      return this;
234   }
235
236   @Override /* Overridden from HtmlElement */
237   public Canvas ondblclick(String value) {
238      super.ondblclick(value);
239      return this;
240   }
241
242   @Override /* Overridden from HtmlElement */
243   public Canvas ondurationchange(String value) {
244      super.ondurationchange(value);
245      return this;
246   }
247
248   @Override /* Overridden from HtmlElement */
249   public Canvas onemptied(String value) {
250      super.onemptied(value);
251      return this;
252   }
253
254   @Override /* Overridden from HtmlElement */
255   public Canvas onended(String value) {
256      super.onended(value);
257      return this;
258   }
259
260   @Override /* Overridden from HtmlElement */
261   public Canvas onerror(String value) {
262      super.onerror(value);
263      return this;
264   }
265
266   @Override /* Overridden from HtmlElement */
267   public Canvas onfocus(String value) {
268      super.onfocus(value);
269      return this;
270   }
271
272   @Override /* Overridden from HtmlElement */
273   public Canvas oninput(String value) {
274      super.oninput(value);
275      return this;
276   }
277
278   @Override /* Overridden from HtmlElement */
279   public Canvas oninvalid(String value) {
280      super.oninvalid(value);
281      return this;
282   }
283
284   @Override /* Overridden from HtmlElement */
285   public Canvas onkeydown(String value) {
286      super.onkeydown(value);
287      return this;
288   }
289
290   @Override /* Overridden from HtmlElement */
291   public Canvas onkeypress(String value) {
292      super.onkeypress(value);
293      return this;
294   }
295
296   @Override /* Overridden from HtmlElement */
297   public Canvas onkeyup(String value) {
298      super.onkeyup(value);
299      return this;
300   }
301
302   @Override /* Overridden from HtmlElement */
303   public Canvas onload(String value) {
304      super.onload(value);
305      return this;
306   }
307
308   @Override /* Overridden from HtmlElement */
309   public Canvas onloadeddata(String value) {
310      super.onloadeddata(value);
311      return this;
312   }
313
314   @Override /* Overridden from HtmlElement */
315   public Canvas onloadedmetadata(String value) {
316      super.onloadedmetadata(value);
317      return this;
318   }
319
320   @Override /* Overridden from HtmlElement */
321   public Canvas onloadstart(String value) {
322      super.onloadstart(value);
323      return this;
324   }
325
326   @Override /* Overridden from HtmlElement */
327   public Canvas onmousedown(String value) {
328      super.onmousedown(value);
329      return this;
330   }
331
332   @Override /* Overridden from HtmlElement */
333   public Canvas onmouseenter(String value) {
334      super.onmouseenter(value);
335      return this;
336   }
337
338   @Override /* Overridden from HtmlElement */
339   public Canvas onmouseleave(String value) {
340      super.onmouseleave(value);
341      return this;
342   }
343
344   @Override /* Overridden from HtmlElement */
345   public Canvas onmousemove(String value) {
346      super.onmousemove(value);
347      return this;
348   }
349
350   @Override /* Overridden from HtmlElement */
351   public Canvas onmouseout(String value) {
352      super.onmouseout(value);
353      return this;
354   }
355
356   @Override /* Overridden from HtmlElement */
357   public Canvas onmouseover(String value) {
358      super.onmouseover(value);
359      return this;
360   }
361
362   @Override /* Overridden from HtmlElement */
363   public Canvas onmouseup(String value) {
364      super.onmouseup(value);
365      return this;
366   }
367
368   @Override /* Overridden from HtmlElement */
369   public Canvas onmousewheel(String value) {
370      super.onmousewheel(value);
371      return this;
372   }
373
374   @Override /* Overridden from HtmlElement */
375   public Canvas onpause(String value) {
376      super.onpause(value);
377      return this;
378   }
379
380   @Override /* Overridden from HtmlElement */
381   public Canvas onplay(String value) {
382      super.onplay(value);
383      return this;
384   }
385
386   @Override /* Overridden from HtmlElement */
387   public Canvas onplaying(String value) {
388      super.onplaying(value);
389      return this;
390   }
391
392   @Override /* Overridden from HtmlElement */
393   public Canvas onprogress(String value) {
394      super.onprogress(value);
395      return this;
396   }
397
398   @Override /* Overridden from HtmlElement */
399   public Canvas onratechange(String value) {
400      super.onratechange(value);
401      return this;
402   }
403
404   @Override /* Overridden from HtmlElement */
405   public Canvas onreset(String value) {
406      super.onreset(value);
407      return this;
408   }
409
410   @Override /* Overridden from HtmlElement */
411   public Canvas onresize(String value) {
412      super.onresize(value);
413      return this;
414   }
415
416   @Override /* Overridden from HtmlElement */
417   public Canvas onscroll(String value) {
418      super.onscroll(value);
419      return this;
420   }
421
422   @Override /* Overridden from HtmlElement */
423   public Canvas onseeked(String value) {
424      super.onseeked(value);
425      return this;
426   }
427
428   @Override /* Overridden from HtmlElement */
429   public Canvas onseeking(String value) {
430      super.onseeking(value);
431      return this;
432   }
433
434   @Override /* Overridden from HtmlElement */
435   public Canvas onselect(String value) {
436      super.onselect(value);
437      return this;
438   }
439
440   @Override /* Overridden from HtmlElement */
441   public Canvas onshow(String value) {
442      super.onshow(value);
443      return this;
444   }
445
446   @Override /* Overridden from HtmlElement */
447   public Canvas onstalled(String value) {
448      super.onstalled(value);
449      return this;
450   }
451
452   @Override /* Overridden from HtmlElement */
453   public Canvas onsubmit(String value) {
454      super.onsubmit(value);
455      return this;
456   }
457
458   @Override /* Overridden from HtmlElement */
459   public Canvas onsuspend(String value) {
460      super.onsuspend(value);
461      return this;
462   }
463
464   @Override /* Overridden from HtmlElement */
465   public Canvas ontimeupdate(String value) {
466      super.ontimeupdate(value);
467      return this;
468   }
469
470   @Override /* Overridden from HtmlElement */
471   public Canvas ontoggle(String value) {
472      super.ontoggle(value);
473      return this;
474   }
475
476   @Override /* Overridden from HtmlElement */
477   public Canvas onvolumechange(String value) {
478      super.onvolumechange(value);
479      return this;
480   }
481
482   @Override /* Overridden from HtmlElement */
483   public Canvas onwaiting(String value) {
484      super.onwaiting(value);
485      return this;
486   }
487
488   @Override /* Overridden from HtmlElement */
489   public Canvas spellcheck(Object value) {
490      super.spellcheck(value);
491      return this;
492   }
493
494   @Override /* Overridden from HtmlElement */
495   public Canvas style(String value) {
496      super.style(value);
497      return this;
498   }
499
500   @Override /* Overridden from HtmlElement */
501   public Canvas tabindex(Object value) {
502      super.tabindex(value);
503      return this;
504   }
505
506   @Override /* Overridden from HtmlElement */
507   public Canvas title(String value) {
508      super.title(value);
509      return this;
510   }
511
512   @Override /* Overridden from HtmlElement */
513   public Canvas translate(Object value) {
514      super.translate(value);
515      return this;
516   }
517
518   /**
519    * <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#attr-canvas-width">width</a> attribute.
520    *
521    * <p>
522    * Horizontal dimension.
523    *
524    * @param value
525    *    The new value for this attribute.
526    *    Typically a {@link Number} or {@link String}.
527    * @return This object.
528    */
529   public Canvas width(Object value) {
530      attr("width", value);
531      return this;
532   }
533}