001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau.dto.html5;
014
015import java.net.*;
016
017import org.apache.juneau.*;
018import org.apache.juneau.annotation.*;
019import org.apache.juneau.internal.*;
020
021/**
022 * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#the-area-element">&lt;area&gt;</a>
023 * element.
024 *
025 * <h5 class='section'>See Also:</h5><ul>
026 *    <li class='link'><a class="doclink" href="../../../../../index.html#jd.Html5">Overview &gt; juneau-dto &gt; HTML5</a>
027 * </ul>
028 */
029@Bean(typeName="area")
030@FluentSetters
031public class Area extends HtmlElementVoid {
032
033   /**
034    * Creates an empty {@link Area} element.
035    */
036   public Area() {}
037
038   /**
039    * Creates an {@link Area} element with the specified {@link Area#shape(String)}, {@link Area#coords(String)},
040    * and {@link Area#href(Object)} attributes.
041    *
042    * @param shape The {@link Area#shape(String)} attribute.
043    * @param coords The {@link Area#coords(String)} attribute.
044    * @param href The {@link Area#href(Object)} attribute.
045    */
046   public Area(String shape, String coords, Object href) {
047      shape(shape).coords(coords).href(href);
048   }
049
050   /**
051    * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-area-alt">alt</a> attribute.
052    *
053    * <p>
054    * Replacement text for use when images are not available.
055    *
056    * @param alt The new value for this attribute.
057    * @return This object.
058    */
059   public final Area alt(String alt) {
060      attr("alt", alt);
061      return this;
062   }
063
064   /**
065    * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-area-coords">coords</a>
066    * attribute.
067    *
068    * <p>
069    * Coordinates for the shape to be created in an image map.
070    *
071    * @param coords The new value for this attribute.
072    * @return This object.
073    */
074   public final Area coords(String coords) {
075      attr("coords", coords);
076      return this;
077   }
078
079   /**
080    * <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-download">download</a> attribute.
081    *
082    * <p>
083    * Whether to download the resource instead of navigating to it, and its file name if so.
084    *
085    * @param download
086    *    The new value for this attribute.
087    *    Typically a {@link Boolean} or {@link String}.
088    * @return This object.
089    */
090   public final Area download(Object download) {
091      attr("download", download);
092      return this;
093   }
094
095   /**
096    * <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-href">href</a> attribute.
097    *
098    * <p>
099    * Address of the hyperlink.
100    *
101    * <p>
102    * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
103    * Strings must be valid URIs.
104    *
105    * <p>
106    * URIs defined by {@link UriResolver} can be used for values.
107    *
108    * @param href
109    *    The new value for this attribute.
110    *    Typically a {@link URL} or {@link String}.
111    * @return This object.
112    */
113   public final Area href(Object href) {
114      attrUri("href", href);
115      return this;
116   }
117
118   /**
119    * <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-hreflang">hreflang</a> attribute.
120    *
121    * <p>
122    * Language of the linked resource.
123    *
124    * @param hreflang The new value for this attribute.
125    * @return This object.
126    */
127   public final Area hreflang(String hreflang) {
128      attr("hreflang", hreflang);
129      return this;
130   }
131
132   /**
133    * <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-rel">rel</a> attribute.
134    *
135    * <p>
136    * Relationship between the document containing the hyperlink and the destination resource.
137    *
138    * @param rel The new value for this attribute.
139    * @return This object.
140    */
141   public final Area rel(String rel) {
142      attr("rel", rel);
143      return this;
144   }
145
146   /**
147    * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-area-shape">shape</a> attribute.
148    *
149    * <p>
150    * The kind of shape to be created in an image map.
151    *
152    * @param shape The new value for this attribute.
153    * @return This object.
154    */
155   public final Area shape(String shape) {
156      attr("shape", shape);
157      return this;
158   }
159
160   /**
161    * <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-target">target</a> attribute.
162    *
163    * <p>
164    * Browsing context for hyperlink navigation.
165    *
166    * @param target The new value for this attribute.
167    * @return This object.
168    */
169   public final Area target(String target) {
170      attr("target", target);
171      return this;
172   }
173
174   /**
175    * <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-type">type</a> attribute.
176    *
177    * <p>
178    * Hint for the type of the referenced resource.
179    *
180    * @param type The new value for this attribute.
181    * @return This object.
182    */
183   public final Area type(String type) {
184      attr("type", type);
185      return this;
186   }
187
188
189   //-----------------------------------------------------------------------------------------------------------------
190   // Overridden methods
191   //-----------------------------------------------------------------------------------------------------------------
192
193   // <FluentSetters>
194
195   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
196   public Area _class(String _class) {
197      super._class(_class);
198      return this;
199   }
200
201   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
202   public Area accesskey(String accesskey) {
203      super.accesskey(accesskey);
204      return this;
205   }
206
207   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
208   public Area contenteditable(Object contenteditable) {
209      super.contenteditable(contenteditable);
210      return this;
211   }
212
213   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
214   public Area dir(String dir) {
215      super.dir(dir);
216      return this;
217   }
218
219   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
220   public Area hidden(Object hidden) {
221      super.hidden(hidden);
222      return this;
223   }
224
225   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
226   public Area id(String id) {
227      super.id(id);
228      return this;
229   }
230
231   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
232   public Area lang(String lang) {
233      super.lang(lang);
234      return this;
235   }
236
237   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
238   public Area onabort(String onabort) {
239      super.onabort(onabort);
240      return this;
241   }
242
243   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
244   public Area onblur(String onblur) {
245      super.onblur(onblur);
246      return this;
247   }
248
249   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
250   public Area oncancel(String oncancel) {
251      super.oncancel(oncancel);
252      return this;
253   }
254
255   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
256   public Area oncanplay(String oncanplay) {
257      super.oncanplay(oncanplay);
258      return this;
259   }
260
261   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
262   public Area oncanplaythrough(String oncanplaythrough) {
263      super.oncanplaythrough(oncanplaythrough);
264      return this;
265   }
266
267   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
268   public Area onchange(String onchange) {
269      super.onchange(onchange);
270      return this;
271   }
272
273   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
274   public Area onclick(String onclick) {
275      super.onclick(onclick);
276      return this;
277   }
278
279   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
280   public Area oncuechange(String oncuechange) {
281      super.oncuechange(oncuechange);
282      return this;
283   }
284
285   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
286   public Area ondblclick(String ondblclick) {
287      super.ondblclick(ondblclick);
288      return this;
289   }
290
291   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
292   public Area ondurationchange(String ondurationchange) {
293      super.ondurationchange(ondurationchange);
294      return this;
295   }
296
297   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
298   public Area onemptied(String onemptied) {
299      super.onemptied(onemptied);
300      return this;
301   }
302
303   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
304   public Area onended(String onended) {
305      super.onended(onended);
306      return this;
307   }
308
309   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
310   public Area onerror(String onerror) {
311      super.onerror(onerror);
312      return this;
313   }
314
315   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
316   public Area onfocus(String onfocus) {
317      super.onfocus(onfocus);
318      return this;
319   }
320
321   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
322   public Area oninput(String oninput) {
323      super.oninput(oninput);
324      return this;
325   }
326
327   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
328   public Area oninvalid(String oninvalid) {
329      super.oninvalid(oninvalid);
330      return this;
331   }
332
333   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
334   public Area onkeydown(String onkeydown) {
335      super.onkeydown(onkeydown);
336      return this;
337   }
338
339   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
340   public Area onkeypress(String onkeypress) {
341      super.onkeypress(onkeypress);
342      return this;
343   }
344
345   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
346   public Area onkeyup(String onkeyup) {
347      super.onkeyup(onkeyup);
348      return this;
349   }
350
351   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
352   public Area onload(String onload) {
353      super.onload(onload);
354      return this;
355   }
356
357   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
358   public Area onloadeddata(String onloadeddata) {
359      super.onloadeddata(onloadeddata);
360      return this;
361   }
362
363   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
364   public Area onloadedmetadata(String onloadedmetadata) {
365      super.onloadedmetadata(onloadedmetadata);
366      return this;
367   }
368
369   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
370   public Area onloadstart(String onloadstart) {
371      super.onloadstart(onloadstart);
372      return this;
373   }
374
375   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
376   public Area onmousedown(String onmousedown) {
377      super.onmousedown(onmousedown);
378      return this;
379   }
380
381   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
382   public Area onmouseenter(String onmouseenter) {
383      super.onmouseenter(onmouseenter);
384      return this;
385   }
386
387   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
388   public Area onmouseleave(String onmouseleave) {
389      super.onmouseleave(onmouseleave);
390      return this;
391   }
392
393   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
394   public Area onmousemove(String onmousemove) {
395      super.onmousemove(onmousemove);
396      return this;
397   }
398
399   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
400   public Area onmouseout(String onmouseout) {
401      super.onmouseout(onmouseout);
402      return this;
403   }
404
405   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
406   public Area onmouseover(String onmouseover) {
407      super.onmouseover(onmouseover);
408      return this;
409   }
410
411   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
412   public Area onmouseup(String onmouseup) {
413      super.onmouseup(onmouseup);
414      return this;
415   }
416
417   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
418   public Area onmousewheel(String onmousewheel) {
419      super.onmousewheel(onmousewheel);
420      return this;
421   }
422
423   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
424   public Area onpause(String onpause) {
425      super.onpause(onpause);
426      return this;
427   }
428
429   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
430   public Area onplay(String onplay) {
431      super.onplay(onplay);
432      return this;
433   }
434
435   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
436   public Area onplaying(String onplaying) {
437      super.onplaying(onplaying);
438      return this;
439   }
440
441   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
442   public Area onprogress(String onprogress) {
443      super.onprogress(onprogress);
444      return this;
445   }
446
447   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
448   public Area onratechange(String onratechange) {
449      super.onratechange(onratechange);
450      return this;
451   }
452
453   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
454   public Area onreset(String onreset) {
455      super.onreset(onreset);
456      return this;
457   }
458
459   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
460   public Area onresize(String onresize) {
461      super.onresize(onresize);
462      return this;
463   }
464
465   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
466   public Area onscroll(String onscroll) {
467      super.onscroll(onscroll);
468      return this;
469   }
470
471   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
472   public Area onseeked(String onseeked) {
473      super.onseeked(onseeked);
474      return this;
475   }
476
477   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
478   public Area onseeking(String onseeking) {
479      super.onseeking(onseeking);
480      return this;
481   }
482
483   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
484   public Area onselect(String onselect) {
485      super.onselect(onselect);
486      return this;
487   }
488
489   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
490   public Area onshow(String onshow) {
491      super.onshow(onshow);
492      return this;
493   }
494
495   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
496   public Area onstalled(String onstalled) {
497      super.onstalled(onstalled);
498      return this;
499   }
500
501   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
502   public Area onsubmit(String onsubmit) {
503      super.onsubmit(onsubmit);
504      return this;
505   }
506
507   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
508   public Area onsuspend(String onsuspend) {
509      super.onsuspend(onsuspend);
510      return this;
511   }
512
513   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
514   public Area ontimeupdate(String ontimeupdate) {
515      super.ontimeupdate(ontimeupdate);
516      return this;
517   }
518
519   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
520   public Area ontoggle(String ontoggle) {
521      super.ontoggle(ontoggle);
522      return this;
523   }
524
525   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
526   public Area onvolumechange(String onvolumechange) {
527      super.onvolumechange(onvolumechange);
528      return this;
529   }
530
531   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
532   public Area onwaiting(String onwaiting) {
533      super.onwaiting(onwaiting);
534      return this;
535   }
536
537   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
538   public Area spellcheck(Object spellcheck) {
539      super.spellcheck(spellcheck);
540      return this;
541   }
542
543   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
544   public Area style(String style) {
545      super.style(style);
546      return this;
547   }
548
549   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
550   public Area tabindex(Object tabindex) {
551      super.tabindex(tabindex);
552      return this;
553   }
554
555   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
556   public Area title(String title) {
557      super.title(title);
558      return this;
559   }
560
561   @Override /* GENERATED - org.apache.juneau.dto.html5.HtmlElement */
562   public Area translate(Object translate) {
563      super.translate(translate);
564      return this;
565   }
566
567   // </FluentSetters>
568}