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 java.util.*;
020
021import org.apache.juneau.annotation.*;
022
023/**
024 * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#the-map-element">&lt;map&gt;</a>
025 * element.
026 *
027 * <p>
028 * The map element defines an image map, which is an image with clickable areas. It contains area
029 * elements that define the clickable regions within the image. The map element is referenced by
030 * img elements using the usemap attribute to create interactive images.
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 image map with rectangular areas</jc>
037 *    Map <jv>map1</jv> = <jsm>map</jsm>(<js>"navigation"</js>,
038 *       <jsm>area</jsm>(<js>"rect"</js>, <js>"0,0,100,50"</js>, <js>"https://example.com/home"</js>),
039 *       <jsm>area</jsm>(<js>"rect"</js>, <js>"100,0,200,50"</js>, <js>"https://example.com/about"</js>),
040 *       <jsm>area</jsm>(<js>"rect"</js>, <js>"200,0,300,50"</js>, <js>"https://example.com/contact"</js>)
041 *    );
042 *
043 *    <jc>// Image map with different area shapes</jc>
044 *    Map <jv>map2</jv> = <jsm>map</jsm>(<js>"shapes"</js>,
045 *       <jsm>area</jsm>(<js>"circle"</js>, <js>"150,75,50"</js>, <js>"https://example.com/circle"</js>),
046 *       <jsm>area</jsm>(<js>"poly"</js>, <js>"0,0,100,0,50,100"</js>, <js>"https://example.com/triangle"</js>),
047 *       <jsm>area</jsm>(<js>"default"</js>, <jk>null</jk>, <js>"https://example.com/default"</js>)
048 *    );
049 *
050 *    <jc>// Image map with accessibility</jc>
051 *    Map <jv>map3</jv> = <jsm>map</jsm>(<js>"accessible"</js>,
052 *       <jsm>area</jsm>(<js>"rect"</js>, <js>"0,0,100,100"</js>, <js>"https://example.com/region1"</js>)
053 *          .alt(<js>"Click here for region 1"</js>),
054 *       <jsm>area</jsm>(<js>"rect"</js>, <js>"100,0,200,100"</js>, <js>"https://example.com/region2"</js>)
055 *          .alt(<js>"Click here for region 2"</js>)
056 *    );
057 * </p>
058 *
059 * <h5 class='section'>See Also:</h5><ul>
060 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauBeanHtml5">juneau-bean-html5</a>
061 * </ul>
062 */
063@Bean(typeName = "map")
064public class Map extends HtmlElementContainer {
065
066   /**
067    * Creates an empty {@link Map} element.
068    */
069   public Map() {}
070
071   /**
072    * Creates a {@link Map} element with the specified child nodes.
073    *
074    * @param children The child nodes.
075    */
076   public Map(Object...children) {
077      children(children);
078   }
079
080   @Override /* Overridden from HtmlElement */
081   public Map _class(String value) { // NOSONAR - Intentional naming.
082      super._class(value);
083      return this;
084   }
085
086   @Override /* Overridden from HtmlElement */
087   public Map accesskey(String value) {
088      super.accesskey(value);
089      return this;
090   }
091
092   @Override /* Overridden from HtmlElement */
093   public Map attr(String key, Object val) {
094      super.attr(key, val);
095      return this;
096   }
097
098   @Override /* Overridden from HtmlElement */
099   public Map attrUri(String key, Object val) {
100      super.attrUri(key, val);
101      return this;
102   }
103
104   @Override /* Overridden from HtmlElementContainer */
105   public Map child(Object value) {
106      super.child(value);
107      return this;
108   }
109
110   @Override /* Overridden from HtmlElementContainer */
111   public Map children(Object...value) {
112      super.children(value);
113      return this;
114   }
115
116   @Override /* Overridden from HtmlElement */
117   public Map contenteditable(Object value) {
118      super.contenteditable(value);
119      return this;
120   }
121
122   @Override /* Overridden from HtmlElement */
123   public Map dir(String value) {
124      super.dir(value);
125      return this;
126   }
127
128   @Override /* Overridden from HtmlElement */
129   public Map hidden(Object value) {
130      super.hidden(value);
131      return this;
132   }
133
134   @Override /* Overridden from HtmlElement */
135   public Map id(String value) {
136      super.id(value);
137      return this;
138   }
139
140   @Override /* Overridden from HtmlElement */
141   public Map lang(String value) {
142      super.lang(value);
143      return this;
144   }
145
146   /**
147    * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-map-name">name</a> attribute.
148    *
149    * <p>
150    * Specifies the name of the image map. This name is used by img elements with the usemap attribute
151    * to reference this map for defining clickable areas.
152    *
153    * <p>
154    * The name should be unique within the document and should not contain spaces or special characters.
155    *
156    * @param value The name of the image map for referencing from img elements.
157    * @return This object.
158    */
159   public Map name(String value) {
160      attr("name", value);
161      return this;
162   }
163
164   @Override /* Overridden from HtmlElement */
165   public Map onabort(String value) {
166      super.onabort(value);
167      return this;
168   }
169
170   @Override /* Overridden from HtmlElement */
171   public Map onblur(String value) {
172      super.onblur(value);
173      return this;
174   }
175
176   @Override /* Overridden from HtmlElement */
177   public Map oncancel(String value) {
178      super.oncancel(value);
179      return this;
180   }
181
182   @Override /* Overridden from HtmlElement */
183   public Map oncanplay(String value) {
184      super.oncanplay(value);
185      return this;
186   }
187
188   @Override /* Overridden from HtmlElement */
189   public Map oncanplaythrough(String value) {
190      super.oncanplaythrough(value);
191      return this;
192   }
193
194   @Override /* Overridden from HtmlElement */
195   public Map onchange(String value) {
196      super.onchange(value);
197      return this;
198   }
199
200   @Override /* Overridden from HtmlElement */
201   public Map onclick(String value) {
202      super.onclick(value);
203      return this;
204   }
205
206   @Override /* Overridden from HtmlElement */
207   public Map oncuechange(String value) {
208      super.oncuechange(value);
209      return this;
210   }
211
212   @Override /* Overridden from HtmlElement */
213   public Map ondblclick(String value) {
214      super.ondblclick(value);
215      return this;
216   }
217
218   @Override /* Overridden from HtmlElement */
219   public Map ondurationchange(String value) {
220      super.ondurationchange(value);
221      return this;
222   }
223
224   @Override /* Overridden from HtmlElement */
225   public Map onemptied(String value) {
226      super.onemptied(value);
227      return this;
228   }
229
230   @Override /* Overridden from HtmlElement */
231   public Map onended(String value) {
232      super.onended(value);
233      return this;
234   }
235
236   @Override /* Overridden from HtmlElement */
237   public Map onerror(String value) {
238      super.onerror(value);
239      return this;
240   }
241
242   @Override /* Overridden from HtmlElement */
243   public Map onfocus(String value) {
244      super.onfocus(value);
245      return this;
246   }
247
248   @Override /* Overridden from HtmlElement */
249   public Map oninput(String value) {
250      super.oninput(value);
251      return this;
252   }
253
254   @Override /* Overridden from HtmlElement */
255   public Map oninvalid(String value) {
256      super.oninvalid(value);
257      return this;
258   }
259
260   @Override /* Overridden from HtmlElement */
261   public Map onkeydown(String value) {
262      super.onkeydown(value);
263      return this;
264   }
265
266   @Override /* Overridden from HtmlElement */
267   public Map onkeypress(String value) {
268      super.onkeypress(value);
269      return this;
270   }
271
272   @Override /* Overridden from HtmlElement */
273   public Map onkeyup(String value) {
274      super.onkeyup(value);
275      return this;
276   }
277
278   @Override /* Overridden from HtmlElement */
279   public Map onload(String value) {
280      super.onload(value);
281      return this;
282   }
283
284   @Override /* Overridden from HtmlElement */
285   public Map onloadeddata(String value) {
286      super.onloadeddata(value);
287      return this;
288   }
289
290   @Override /* Overridden from HtmlElement */
291   public Map onloadedmetadata(String value) {
292      super.onloadedmetadata(value);
293      return this;
294   }
295
296   @Override /* Overridden from HtmlElement */
297   public Map onloadstart(String value) {
298      super.onloadstart(value);
299      return this;
300   }
301
302   @Override /* Overridden from HtmlElement */
303   public Map onmousedown(String value) {
304      super.onmousedown(value);
305      return this;
306   }
307
308   @Override /* Overridden from HtmlElement */
309   public Map onmouseenter(String value) {
310      super.onmouseenter(value);
311      return this;
312   }
313
314   @Override /* Overridden from HtmlElement */
315   public Map onmouseleave(String value) {
316      super.onmouseleave(value);
317      return this;
318   }
319
320   @Override /* Overridden from HtmlElement */
321   public Map onmousemove(String value) {
322      super.onmousemove(value);
323      return this;
324   }
325
326   @Override /* Overridden from HtmlElement */
327   public Map onmouseout(String value) {
328      super.onmouseout(value);
329      return this;
330   }
331
332   @Override /* Overridden from HtmlElement */
333   public Map onmouseover(String value) {
334      super.onmouseover(value);
335      return this;
336   }
337
338   @Override /* Overridden from HtmlElement */
339   public Map onmouseup(String value) {
340      super.onmouseup(value);
341      return this;
342   }
343
344   @Override /* Overridden from HtmlElement */
345   public Map onmousewheel(String value) {
346      super.onmousewheel(value);
347      return this;
348   }
349
350   @Override /* Overridden from HtmlElement */
351   public Map onpause(String value) {
352      super.onpause(value);
353      return this;
354   }
355
356   @Override /* Overridden from HtmlElement */
357   public Map onplay(String value) {
358      super.onplay(value);
359      return this;
360   }
361
362   @Override /* Overridden from HtmlElement */
363   public Map onplaying(String value) {
364      super.onplaying(value);
365      return this;
366   }
367
368   @Override /* Overridden from HtmlElement */
369   public Map onprogress(String value) {
370      super.onprogress(value);
371      return this;
372   }
373
374   @Override /* Overridden from HtmlElement */
375   public Map onratechange(String value) {
376      super.onratechange(value);
377      return this;
378   }
379
380   @Override /* Overridden from HtmlElement */
381   public Map onreset(String value) {
382      super.onreset(value);
383      return this;
384   }
385
386   @Override /* Overridden from HtmlElement */
387   public Map onresize(String value) {
388      super.onresize(value);
389      return this;
390   }
391
392   @Override /* Overridden from HtmlElement */
393   public Map onscroll(String value) {
394      super.onscroll(value);
395      return this;
396   }
397
398   @Override /* Overridden from HtmlElement */
399   public Map onseeked(String value) {
400      super.onseeked(value);
401      return this;
402   }
403
404   @Override /* Overridden from HtmlElement */
405   public Map onseeking(String value) {
406      super.onseeking(value);
407      return this;
408   }
409
410   @Override /* Overridden from HtmlElement */
411   public Map onselect(String value) {
412      super.onselect(value);
413      return this;
414   }
415
416   @Override /* Overridden from HtmlElement */
417   public Map onshow(String value) {
418      super.onshow(value);
419      return this;
420   }
421
422   @Override /* Overridden from HtmlElement */
423   public Map onstalled(String value) {
424      super.onstalled(value);
425      return this;
426   }
427
428   @Override /* Overridden from HtmlElement */
429   public Map onsubmit(String value) {
430      super.onsubmit(value);
431      return this;
432   }
433
434   @Override /* Overridden from HtmlElement */
435   public Map onsuspend(String value) {
436      super.onsuspend(value);
437      return this;
438   }
439
440   @Override /* Overridden from HtmlElement */
441   public Map ontimeupdate(String value) {
442      super.ontimeupdate(value);
443      return this;
444   }
445
446   @Override /* Overridden from HtmlElement */
447   public Map ontoggle(String value) {
448      super.ontoggle(value);
449      return this;
450   }
451
452   @Override /* Overridden from HtmlElement */
453   public Map onvolumechange(String value) {
454      super.onvolumechange(value);
455      return this;
456   }
457
458   @Override /* Overridden from HtmlElement */
459   public Map onwaiting(String value) {
460      super.onwaiting(value);
461      return this;
462   }
463
464   @Override /* Overridden from HtmlElementContainer */
465   public Map setChildren(List<Object> children) {
466      super.setChildren(children);
467      return this;
468   }
469
470   @Override /* Overridden from HtmlElement */
471   public Map spellcheck(Object value) {
472      super.spellcheck(value);
473      return this;
474   }
475
476   @Override /* Overridden from HtmlElement */
477   public Map style(String value) {
478      super.style(value);
479      return this;
480   }
481
482   @Override /* Overridden from HtmlElement */
483   public Map tabindex(Object value) {
484      super.tabindex(value);
485      return this;
486   }
487
488   @Override /* Overridden from HtmlElement */
489   public Map title(String value) {
490      super.title(value);
491      return this;
492   }
493
494   @Override /* Overridden from HtmlElement */
495   public Map translate(Object value) {
496      super.translate(value);
497      return this;
498   }
499}