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/text-level-semantics.html#the-kbd-element">&lt;kbd&gt;</a>
024 * element.
025 *
026 * <p>
027 * The kbd element represents user input, typically keyboard input but can also represent other types
028 * of input such as voice commands or menu selections. It is commonly styled with a monospace font
029 * to distinguish it from regular text and often appears in documentation, tutorials, and help pages.
030 *
031 * <h5 class='section'>Examples:</h5>
032 * <p class='bcode w800'>
033 *    <jc>// Simple keyboard shortcut</jc>
034 *    Kbd <jv>simple</jv> = <jsm>kbd</jsm>(<js>"Ctrl+S"</js>);
035 * 
036 *    <jc>// Keyboard combination with nested kbd elements</jc>
037 *    P <jv>shortcut</jv> = <jsm>p</jsm>(
038 *       <js>"Press "</js>,
039 *       <jsm>kbd</jsm>(<js>"Ctrl"</js>),
040 *       <js>" + "</js>,
041 *       <jsm>kbd</jsm>(<js>"C"</js>),
042 *       <js>" to copy."</js>
043 *    );
044 * 
045 *    <jc>// Menu selection instruction</jc>
046 *    P <jv>menu</jv> = <jsm>p</jsm>(
047 *       <js>"Select "</js>,
048 *       <jsm>kbd</jsm>(<js>"File"</js>),
049 *       <js>" → "</js>,
050 *       <jsm>kbd</jsm>(<js>"Save As..."</js>)
051 *    );
052 * 
053 *    <jc>// Command line input</jc>
054 *    P <jv>command</jv> = <jsm>p</jsm>(
055 *       <js>"Type "</js>,
056 *       <jsm>kbd</jsm>(<js>"npm install"</js>),
057 *       <js>" to install dependencies."</js>
058 *    );
059 * 
060 *    <jc>// With styling</jc>
061 *    Kbd <jv>styled</jv> = <jsm>kbd</jsm>(<js>"Enter"</js>)
062 *       ._class(<js>"key-highlight"</js>)
063 *       .title(<js>"Press Enter to submit"</js>);
064 * 
065 *    <jc>// Multiple key sequence</jc>
066 *    P <jv>sequence</jv> = <jsm>p</jsm>(
067 *       <js>"To exit, press "</js>,
068 *       <jsm>kbd</jsm>(<js>"Esc"</js>),
069 *       <js>" or "</js>,
070 *       <jsm>kbd</jsm>(<js>"Ctrl"</js>),
071 *       <js>" + "</js>,
072 *       <jsm>kbd</jsm>(<js>"Q"</js>)
073 *    );
074 * </p>
075 *
076 * <p>
077 * The following convenience methods are provided for constructing instances of this bean:
078 * <ul class='javatree'>
079 *    <li class='jc'>{@link HtmlBuilder}
080 *    <ul class='javatree'>
081 *       <li class='jm'>{@link HtmlBuilder#kbd() kbd()}
082 *       <li class='jm'>{@link HtmlBuilder#kbd(Object, Object...) kbd(Object, Object...)}
083 *    </ul>
084 * </ul>
085 * </p>
086 *
087 * <h5 class='section'>See Also:</h5><ul>
088 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauBeanHtml5">juneau-bean-html5</a>
089 * </ul>
090 */
091@Bean(typeName="kbd")
092public class Kbd extends HtmlElementMixed {
093
094   /**
095    * Creates an empty {@link Kbd} element.
096    */
097   public Kbd() {}
098
099   /**
100    * Creates a {@link Kbd} element with the specified child nodes.
101    *
102    * @param children The child nodes.
103    */
104   public Kbd(Object...children) {
105      children(children);
106   }
107
108   //-----------------------------------------------------------------------------------------------------------------
109   // Overridden methods
110   //-----------------------------------------------------------------------------------------------------------------
111   @Override /* Overridden from HtmlElement */
112   public Kbd _class(String value) {  // NOSONAR - Intentional naming.
113      super._class(value);
114      return this;
115   }
116
117   @Override /* Overridden from HtmlElement */
118   public Kbd accesskey(String value) {
119      super.accesskey(value);
120      return this;
121   }
122
123   @Override /* Overridden from HtmlElement */
124   public Kbd contenteditable(Object value) {
125      super.contenteditable(value);
126      return this;
127   }
128
129   @Override /* Overridden from HtmlElement */
130   public Kbd dir(String value) {
131      super.dir(value);
132      return this;
133   }
134
135   @Override /* Overridden from HtmlElement */
136   public Kbd hidden(Object value) {
137      super.hidden(value);
138      return this;
139   }
140
141   @Override /* Overridden from HtmlElement */
142   public Kbd id(String value) {
143      super.id(value);
144      return this;
145   }
146
147   @Override /* Overridden from HtmlElement */
148   public Kbd lang(String value) {
149      super.lang(value);
150      return this;
151   }
152
153   @Override /* Overridden from HtmlElement */
154   public Kbd onabort(String value) {
155      super.onabort(value);
156      return this;
157   }
158
159   @Override /* Overridden from HtmlElement */
160   public Kbd onblur(String value) {
161      super.onblur(value);
162      return this;
163   }
164
165   @Override /* Overridden from HtmlElement */
166   public Kbd oncancel(String value) {
167      super.oncancel(value);
168      return this;
169   }
170
171   @Override /* Overridden from HtmlElement */
172   public Kbd oncanplay(String value) {
173      super.oncanplay(value);
174      return this;
175   }
176
177   @Override /* Overridden from HtmlElement */
178   public Kbd oncanplaythrough(String value) {
179      super.oncanplaythrough(value);
180      return this;
181   }
182
183   @Override /* Overridden from HtmlElement */
184   public Kbd onchange(String value) {
185      super.onchange(value);
186      return this;
187   }
188
189   @Override /* Overridden from HtmlElement */
190   public Kbd onclick(String value) {
191      super.onclick(value);
192      return this;
193   }
194
195   @Override /* Overridden from HtmlElement */
196   public Kbd oncuechange(String value) {
197      super.oncuechange(value);
198      return this;
199   }
200
201   @Override /* Overridden from HtmlElement */
202   public Kbd ondblclick(String value) {
203      super.ondblclick(value);
204      return this;
205   }
206
207   @Override /* Overridden from HtmlElement */
208   public Kbd ondurationchange(String value) {
209      super.ondurationchange(value);
210      return this;
211   }
212
213   @Override /* Overridden from HtmlElement */
214   public Kbd onemptied(String value) {
215      super.onemptied(value);
216      return this;
217   }
218
219   @Override /* Overridden from HtmlElement */
220   public Kbd onended(String value) {
221      super.onended(value);
222      return this;
223   }
224
225   @Override /* Overridden from HtmlElement */
226   public Kbd onerror(String value) {
227      super.onerror(value);
228      return this;
229   }
230
231   @Override /* Overridden from HtmlElement */
232   public Kbd onfocus(String value) {
233      super.onfocus(value);
234      return this;
235   }
236
237   @Override /* Overridden from HtmlElement */
238   public Kbd oninput(String value) {
239      super.oninput(value);
240      return this;
241   }
242
243   @Override /* Overridden from HtmlElement */
244   public Kbd oninvalid(String value) {
245      super.oninvalid(value);
246      return this;
247   }
248
249   @Override /* Overridden from HtmlElement */
250   public Kbd onkeydown(String value) {
251      super.onkeydown(value);
252      return this;
253   }
254
255   @Override /* Overridden from HtmlElement */
256   public Kbd onkeypress(String value) {
257      super.onkeypress(value);
258      return this;
259   }
260
261   @Override /* Overridden from HtmlElement */
262   public Kbd onkeyup(String value) {
263      super.onkeyup(value);
264      return this;
265   }
266
267   @Override /* Overridden from HtmlElement */
268   public Kbd onload(String value) {
269      super.onload(value);
270      return this;
271   }
272
273   @Override /* Overridden from HtmlElement */
274   public Kbd onloadeddata(String value) {
275      super.onloadeddata(value);
276      return this;
277   }
278
279   @Override /* Overridden from HtmlElement */
280   public Kbd onloadedmetadata(String value) {
281      super.onloadedmetadata(value);
282      return this;
283   }
284
285   @Override /* Overridden from HtmlElement */
286   public Kbd onloadstart(String value) {
287      super.onloadstart(value);
288      return this;
289   }
290
291   @Override /* Overridden from HtmlElement */
292   public Kbd onmousedown(String value) {
293      super.onmousedown(value);
294      return this;
295   }
296
297   @Override /* Overridden from HtmlElement */
298   public Kbd onmouseenter(String value) {
299      super.onmouseenter(value);
300      return this;
301   }
302
303   @Override /* Overridden from HtmlElement */
304   public Kbd onmouseleave(String value) {
305      super.onmouseleave(value);
306      return this;
307   }
308
309   @Override /* Overridden from HtmlElement */
310   public Kbd onmousemove(String value) {
311      super.onmousemove(value);
312      return this;
313   }
314
315   @Override /* Overridden from HtmlElement */
316   public Kbd onmouseout(String value) {
317      super.onmouseout(value);
318      return this;
319   }
320
321   @Override /* Overridden from HtmlElement */
322   public Kbd onmouseover(String value) {
323      super.onmouseover(value);
324      return this;
325   }
326
327   @Override /* Overridden from HtmlElement */
328   public Kbd onmouseup(String value) {
329      super.onmouseup(value);
330      return this;
331   }
332
333   @Override /* Overridden from HtmlElement */
334   public Kbd onmousewheel(String value) {
335      super.onmousewheel(value);
336      return this;
337   }
338
339   @Override /* Overridden from HtmlElement */
340   public Kbd onpause(String value) {
341      super.onpause(value);
342      return this;
343   }
344
345   @Override /* Overridden from HtmlElement */
346   public Kbd onplay(String value) {
347      super.onplay(value);
348      return this;
349   }
350
351   @Override /* Overridden from HtmlElement */
352   public Kbd onplaying(String value) {
353      super.onplaying(value);
354      return this;
355   }
356
357   @Override /* Overridden from HtmlElement */
358   public Kbd onprogress(String value) {
359      super.onprogress(value);
360      return this;
361   }
362
363   @Override /* Overridden from HtmlElement */
364   public Kbd onratechange(String value) {
365      super.onratechange(value);
366      return this;
367   }
368
369   @Override /* Overridden from HtmlElement */
370   public Kbd onreset(String value) {
371      super.onreset(value);
372      return this;
373   }
374
375   @Override /* Overridden from HtmlElement */
376   public Kbd onresize(String value) {
377      super.onresize(value);
378      return this;
379   }
380
381   @Override /* Overridden from HtmlElement */
382   public Kbd onscroll(String value) {
383      super.onscroll(value);
384      return this;
385   }
386
387   @Override /* Overridden from HtmlElement */
388   public Kbd onseeked(String value) {
389      super.onseeked(value);
390      return this;
391   }
392
393   @Override /* Overridden from HtmlElement */
394   public Kbd onseeking(String value) {
395      super.onseeking(value);
396      return this;
397   }
398
399   @Override /* Overridden from HtmlElement */
400   public Kbd onselect(String value) {
401      super.onselect(value);
402      return this;
403   }
404
405   @Override /* Overridden from HtmlElement */
406   public Kbd onshow(String value) {
407      super.onshow(value);
408      return this;
409   }
410
411   @Override /* Overridden from HtmlElement */
412   public Kbd onstalled(String value) {
413      super.onstalled(value);
414      return this;
415   }
416
417   @Override /* Overridden from HtmlElement */
418   public Kbd onsubmit(String value) {
419      super.onsubmit(value);
420      return this;
421   }
422
423   @Override /* Overridden from HtmlElement */
424   public Kbd onsuspend(String value) {
425      super.onsuspend(value);
426      return this;
427   }
428
429   @Override /* Overridden from HtmlElement */
430   public Kbd ontimeupdate(String value) {
431      super.ontimeupdate(value);
432      return this;
433   }
434
435   @Override /* Overridden from HtmlElement */
436   public Kbd ontoggle(String value) {
437      super.ontoggle(value);
438      return this;
439   }
440
441   @Override /* Overridden from HtmlElement */
442   public Kbd onvolumechange(String value) {
443      super.onvolumechange(value);
444      return this;
445   }
446
447   @Override /* Overridden from HtmlElement */
448   public Kbd onwaiting(String value) {
449      super.onwaiting(value);
450      return this;
451   }
452
453   @Override /* Overridden from HtmlElement */
454   public Kbd spellcheck(Object value) {
455      super.spellcheck(value);
456      return this;
457   }
458
459   @Override /* Overridden from HtmlElement */
460   public Kbd style(String value) {
461      super.style(value);
462      return this;
463   }
464
465   @Override /* Overridden from HtmlElement */
466   public Kbd tabindex(Object value) {
467      super.tabindex(value);
468      return this;
469   }
470
471   @Override /* Overridden from HtmlElement */
472   public Kbd title(String value) {
473      super.title(value);
474      return this;
475   }
476
477   @Override /* Overridden from HtmlElement */
478   public Kbd translate(Object value) {
479      super.translate(value);
480      return this;
481   }
482
483   @Override /* Overridden from HtmlElementMixed */
484   public Kbd child(Object value) {
485      super.child(value);
486      return this;
487   }
488
489   @Override /* Overridden from HtmlElementMixed */
490   public Kbd children(Object...value) {
491      super.children(value);
492      return this;
493   }
494}