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/forms.html#the-output-element"><output></a> 023 * element. 024 * 025 * <p> 026 * The output element represents the result of a calculation or user action. It is typically used 027 * to display the result of form calculations, such as the sum of two numbers or the result of 028 * a mathematical operation. The for attribute can be used to associate the output with specific 029 * form controls that contribute to the calculation. 030 * 031 * <h5 class='section'>Examples:</h5> 032 * <p class='bcode w800'> 033 * <jk>import static</jk> org.apache.juneau.bean.html5.HtmlBuilder.*; 034 * 035 * <jc>// Simple output element</jc> 036 * Output <jv>output1</jv> = <jsm>output</jsm>(<js>"0"</js>) 037 * .name(<js>"result"</js>); 038 * 039 * <jc>// Output with form association</jc> 040 * Output <jv>output2</jv> = <jsm>output</jsm>(<js>"0"</js>) 041 * .name(<js>"sum"</js>) 042 * ._for(<js>"num1 num2"</js>); 043 * 044 * <jc>// Output in a calculation form</jc> 045 * Form <jv>calcForm</jv> = <jsm>form</jsm>( 046 * <jsm>input</jsm>(<js>"number"</js>).name(<js>"num1"</js>).id(<js>"num1"</js>).value(<js>"0"</js>), 047 * <jsm>span</jsm>(<js>" + "</js>), 048 * <jsm>input</jsm>(<js>"number"</js>).name(<js>"num2"</js>).id(<js>"num2"</js>).value(<js>"0"</js>), 049 * <jsm>span</jsm>(<js>" = "</js>), 050 * <jsm>output</jsm>(<js>"0"</js>).name(<js>"sum"</js>)._for(<js>"num1 num2"</js>) 051 * ); 052 * 053 * <jc>// Output with styling</jc> 054 * Output <jv>output3</jv> = <jsm>output</jsm>(<js>"Ready for calculation"</js>) 055 * .name(<js>"display"</js>) 056 * ._class(<js>"result-display"</js>); 057 * </p> 058 * 059 * <p> 060 * The following convenience methods are provided for constructing instances of this bean: 061 * <ul class='javatree'> 062 * <li class='jc'>{@link HtmlBuilder} 063 * <ul class='javatree'> 064 * <li class='jm'>{@link HtmlBuilder#output() output()} 065 * <li class='jm'>{@link HtmlBuilder#output(String) output(String)} 066 * </ul> 067 * </ul> 068 * </p> 069 * 070 * <h5 class='section'>See Also:</h5><ul> 071 * <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauBeanHtml5">juneau-bean-html5</a> 072 * </ul> 073 */ 074@Bean(typeName = "output") 075public class Output extends HtmlElementMixed { 076 077 /** 078 * Creates an empty {@link Output} element. 079 */ 080 public Output() {} 081 082 /** 083 * Creates an {@link Output} element with the specified {@link Output#name(String)} attribute. 084 * 085 * @param name The {@link Output#name(String)} attribute. 086 */ 087 public Output(String name) { 088 name(name); 089 } 090 091 @Override /* Overridden from HtmlElement */ 092 public Output _class(String value) { // NOSONAR - Intentional naming. 093 super._class(value); 094 return this; 095 } 096 097 /** 098 * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-output-for">for</a> attribute. 099 * 100 * <p> 101 * Specifies the IDs of form controls from which the output value was calculated. 102 * This creates a programmatic relationship between the output and its source controls. 103 * 104 * <p> 105 * Multiple IDs can be specified as a space-separated list. 106 * 107 * @param value The IDs of the form controls that contribute to this output. 108 * @return This object. 109 */ 110 public Output _for(String value) { // NOSONAR - Intentional naming. 111 attr("for", value); 112 return this; 113 } 114 115 @Override /* Overridden from HtmlElement */ 116 public Output accesskey(String value) { 117 super.accesskey(value); 118 return this; 119 } 120 121 @Override /* Overridden from HtmlElement */ 122 public Output attr(String key, Object val) { 123 super.attr(key, val); 124 return this; 125 } 126 127 @Override /* Overridden from HtmlElement */ 128 public Output attrUri(String key, Object val) { 129 super.attrUri(key, val); 130 return this; 131 } 132 133 @Override /* Overridden from HtmlElementMixed */ 134 public Output child(Object value) { 135 super.child(value); 136 return this; 137 } 138 139 @Override /* Overridden from HtmlElementMixed */ 140 public Output children(Object...value) { 141 super.children(value); 142 return this; 143 } 144 145 @Override /* Overridden from HtmlElement */ 146 public Output contenteditable(Object value) { 147 super.contenteditable(value); 148 return this; 149 } 150 151 @Override /* Overridden from HtmlElement */ 152 public Output dir(String value) { 153 super.dir(value); 154 return this; 155 } 156 157 /** 158 * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fae-form">form</a> attribute. 159 * 160 * <p> 161 * Associates the output element with a form element by specifying the form's ID. This allows the output 162 * to be placed outside the form element while still being part of the form. 163 * 164 * <p> 165 * The value should match the ID of a form element in the same document. 166 * 167 * @param value The ID of the form element to associate with this output. 168 * @return This object. 169 */ 170 public Output form(String value) { 171 attr("form", value); 172 return this; 173 } 174 175 @Override /* Overridden from HtmlElement */ 176 public Output hidden(Object value) { 177 super.hidden(value); 178 return this; 179 } 180 181 @Override /* Overridden from HtmlElement */ 182 public Output id(String value) { 183 super.id(value); 184 return this; 185 } 186 187 @Override /* Overridden from HtmlElement */ 188 public Output lang(String value) { 189 super.lang(value); 190 return this; 191 } 192 193 /** 194 * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-name">name</a> attribute. 195 * 196 * <p> 197 * Specifies the name of the output element. This name is used when the form is submitted and 198 * can be used to access the element via the form.elements API. 199 * 200 * <p> 201 * The name should be unique within the form and should not contain spaces or special characters. 202 * 203 * @param value The name of the output element for submission and API access. 204 * @return This object. 205 */ 206 public Output name(String value) { 207 attr("name", value); 208 return this; 209 } 210 211 @Override /* Overridden from HtmlElement */ 212 public Output onabort(String value) { 213 super.onabort(value); 214 return this; 215 } 216 217 @Override /* Overridden from HtmlElement */ 218 public Output onblur(String value) { 219 super.onblur(value); 220 return this; 221 } 222 223 @Override /* Overridden from HtmlElement */ 224 public Output oncancel(String value) { 225 super.oncancel(value); 226 return this; 227 } 228 229 @Override /* Overridden from HtmlElement */ 230 public Output oncanplay(String value) { 231 super.oncanplay(value); 232 return this; 233 } 234 235 @Override /* Overridden from HtmlElement */ 236 public Output oncanplaythrough(String value) { 237 super.oncanplaythrough(value); 238 return this; 239 } 240 241 @Override /* Overridden from HtmlElement */ 242 public Output onchange(String value) { 243 super.onchange(value); 244 return this; 245 } 246 247 @Override /* Overridden from HtmlElement */ 248 public Output onclick(String value) { 249 super.onclick(value); 250 return this; 251 } 252 253 @Override /* Overridden from HtmlElement */ 254 public Output oncuechange(String value) { 255 super.oncuechange(value); 256 return this; 257 } 258 259 @Override /* Overridden from HtmlElement */ 260 public Output ondblclick(String value) { 261 super.ondblclick(value); 262 return this; 263 } 264 265 @Override /* Overridden from HtmlElement */ 266 public Output ondurationchange(String value) { 267 super.ondurationchange(value); 268 return this; 269 } 270 271 @Override /* Overridden from HtmlElement */ 272 public Output onemptied(String value) { 273 super.onemptied(value); 274 return this; 275 } 276 277 @Override /* Overridden from HtmlElement */ 278 public Output onended(String value) { 279 super.onended(value); 280 return this; 281 } 282 283 @Override /* Overridden from HtmlElement */ 284 public Output onerror(String value) { 285 super.onerror(value); 286 return this; 287 } 288 289 @Override /* Overridden from HtmlElement */ 290 public Output onfocus(String value) { 291 super.onfocus(value); 292 return this; 293 } 294 295 @Override /* Overridden from HtmlElement */ 296 public Output oninput(String value) { 297 super.oninput(value); 298 return this; 299 } 300 301 @Override /* Overridden from HtmlElement */ 302 public Output oninvalid(String value) { 303 super.oninvalid(value); 304 return this; 305 } 306 307 @Override /* Overridden from HtmlElement */ 308 public Output onkeydown(String value) { 309 super.onkeydown(value); 310 return this; 311 } 312 313 @Override /* Overridden from HtmlElement */ 314 public Output onkeypress(String value) { 315 super.onkeypress(value); 316 return this; 317 } 318 319 @Override /* Overridden from HtmlElement */ 320 public Output onkeyup(String value) { 321 super.onkeyup(value); 322 return this; 323 } 324 325 @Override /* Overridden from HtmlElement */ 326 public Output onload(String value) { 327 super.onload(value); 328 return this; 329 } 330 331 @Override /* Overridden from HtmlElement */ 332 public Output onloadeddata(String value) { 333 super.onloadeddata(value); 334 return this; 335 } 336 337 @Override /* Overridden from HtmlElement */ 338 public Output onloadedmetadata(String value) { 339 super.onloadedmetadata(value); 340 return this; 341 } 342 343 @Override /* Overridden from HtmlElement */ 344 public Output onloadstart(String value) { 345 super.onloadstart(value); 346 return this; 347 } 348 349 @Override /* Overridden from HtmlElement */ 350 public Output onmousedown(String value) { 351 super.onmousedown(value); 352 return this; 353 } 354 355 @Override /* Overridden from HtmlElement */ 356 public Output onmouseenter(String value) { 357 super.onmouseenter(value); 358 return this; 359 } 360 361 @Override /* Overridden from HtmlElement */ 362 public Output onmouseleave(String value) { 363 super.onmouseleave(value); 364 return this; 365 } 366 367 @Override /* Overridden from HtmlElement */ 368 public Output onmousemove(String value) { 369 super.onmousemove(value); 370 return this; 371 } 372 373 @Override /* Overridden from HtmlElement */ 374 public Output onmouseout(String value) { 375 super.onmouseout(value); 376 return this; 377 } 378 379 @Override /* Overridden from HtmlElement */ 380 public Output onmouseover(String value) { 381 super.onmouseover(value); 382 return this; 383 } 384 385 @Override /* Overridden from HtmlElement */ 386 public Output onmouseup(String value) { 387 super.onmouseup(value); 388 return this; 389 } 390 391 @Override /* Overridden from HtmlElement */ 392 public Output onmousewheel(String value) { 393 super.onmousewheel(value); 394 return this; 395 } 396 397 @Override /* Overridden from HtmlElement */ 398 public Output onpause(String value) { 399 super.onpause(value); 400 return this; 401 } 402 403 @Override /* Overridden from HtmlElement */ 404 public Output onplay(String value) { 405 super.onplay(value); 406 return this; 407 } 408 409 @Override /* Overridden from HtmlElement */ 410 public Output onplaying(String value) { 411 super.onplaying(value); 412 return this; 413 } 414 415 @Override /* Overridden from HtmlElement */ 416 public Output onprogress(String value) { 417 super.onprogress(value); 418 return this; 419 } 420 421 @Override /* Overridden from HtmlElement */ 422 public Output onratechange(String value) { 423 super.onratechange(value); 424 return this; 425 } 426 427 @Override /* Overridden from HtmlElement */ 428 public Output onreset(String value) { 429 super.onreset(value); 430 return this; 431 } 432 433 @Override /* Overridden from HtmlElement */ 434 public Output onresize(String value) { 435 super.onresize(value); 436 return this; 437 } 438 439 @Override /* Overridden from HtmlElement */ 440 public Output onscroll(String value) { 441 super.onscroll(value); 442 return this; 443 } 444 445 @Override /* Overridden from HtmlElement */ 446 public Output onseeked(String value) { 447 super.onseeked(value); 448 return this; 449 } 450 451 @Override /* Overridden from HtmlElement */ 452 public Output onseeking(String value) { 453 super.onseeking(value); 454 return this; 455 } 456 457 @Override /* Overridden from HtmlElement */ 458 public Output onselect(String value) { 459 super.onselect(value); 460 return this; 461 } 462 463 @Override /* Overridden from HtmlElement */ 464 public Output onshow(String value) { 465 super.onshow(value); 466 return this; 467 } 468 469 @Override /* Overridden from HtmlElement */ 470 public Output onstalled(String value) { 471 super.onstalled(value); 472 return this; 473 } 474 475 @Override /* Overridden from HtmlElement */ 476 public Output onsubmit(String value) { 477 super.onsubmit(value); 478 return this; 479 } 480 481 @Override /* Overridden from HtmlElement */ 482 public Output onsuspend(String value) { 483 super.onsuspend(value); 484 return this; 485 } 486 487 @Override /* Overridden from HtmlElement */ 488 public Output ontimeupdate(String value) { 489 super.ontimeupdate(value); 490 return this; 491 } 492 493 @Override /* Overridden from HtmlElement */ 494 public Output ontoggle(String value) { 495 super.ontoggle(value); 496 return this; 497 } 498 499 @Override /* Overridden from HtmlElement */ 500 public Output onvolumechange(String value) { 501 super.onvolumechange(value); 502 return this; 503 } 504 505 @Override /* Overridden from HtmlElement */ 506 public Output onwaiting(String value) { 507 super.onwaiting(value); 508 return this; 509 } 510 511 @Override /* Overridden from HtmlElement */ 512 public Output spellcheck(Object value) { 513 super.spellcheck(value); 514 return this; 515 } 516 517 @Override /* Overridden from HtmlElement */ 518 public Output style(String value) { 519 super.style(value); 520 return this; 521 } 522 523 @Override /* Overridden from HtmlElement */ 524 public Output tabindex(Object value) { 525 super.tabindex(value); 526 return this; 527 } 528 529 @Override /* Overridden from HtmlElement */ 530 public Output title(String value) { 531 super.title(value); 532 return this; 533 } 534 535 @Override /* Overridden from HtmlElement */ 536 public Output translate(Object value) { 537 super.translate(value); 538 return this; 539 } 540}