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