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