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.rest.server.beans;
018
019import org.apache.juneau.bean.html5.*;
020
021/**
022 * Defines a simple hyperlink class.
023 *
024 * <h5 class='figure'>Examples:</h5>
025 * <p class='bjava'>
026 *    <ja>@Rest</ja>
027 *    <jk>public class</jk> MyRest <jk>extends</jk> BasicRestServlet {
028 *
029 *       <jc>// Produces &lt;a href=&quot;/foo&quot;&gt;bar&lt;/a&gt;</jc>
030 *       <ja>@RestGet</ja>
031 *       <jk>public</jk> Hyperlink a01() {
032 *          <jk>return new</jk> Hyperlink(<js>"foo"</js>, <js>"bar"</js>);
033 *       }
034 *
035 *       <jc>// Produces &lt;ul&gt;&lt;li&gt;&lt;a href=&quot;/foo&quot;&gt;bar&lt;/a&gt;&lt;/li&gt;&lt;/ul&gt;</jc>
036 *       <ja>@RestGet</ja>
037 *       <jk>public</jk> Hyperlink[] a02() {
038 *          <jk>return new</jk> Hyperlink[]{a01()};
039 *       }
040 *
041 *       <jc>// Produces &lt;ul&gt;&lt;li&gt;&lt;a href=&quot;/foo&quot;&gt;bar&lt;/a&gt;&lt;/li&gt;&lt;/ul&gt;</jc>
042 *       <ja>@RestGet</ja>
043 *       <jk>public</jk> Collection&lt;Hyperlink&gt; a03() {
044 *          <jk>return</jk> Arrays.<jsm>asList</jsm>(a02());
045 *       }
046 *    }
047 * </p>
048 *
049 * <h5 class='section'>See Also:</h5><ul>
050 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/UtilityBeans">Utility Beans</a>
051 * </ul>
052 */
053public class Hyperlink extends A {
054
055   /**
056    * Static creator.
057    *
058    * @param href The {@link A#href(Object)} attribute.
059    * @param children The {@link A#children(Object[])} nodes.
060    * @return A new {@link Hyperlink} object.
061    */
062   public static Hyperlink create(Object href, Object...children) {
063      return new Hyperlink(href, children);
064   }
065
066   /**
067    * Creates an empty {@link A} element.
068    */
069   public Hyperlink() {}
070
071   /**
072    * Creates an {@link A} element with the specified {@link A#href(Object)} attribute and {@link A#children(Object[])}
073    * nodes.
074    *
075    * @param href The {@link A#href(Object)} attribute.
076    * @param children The {@link A#children(Object[])} nodes.
077    */
078   public Hyperlink(Object href, Object...children) {
079      super(href, children);
080   }
081   // A-specific attributes
082
083   @Override /* Overridden from A */
084   public Hyperlink class_(String value) {
085      super.class_(value);
086      return this;
087   }
088
089   @Override /* Overridden from A */
090   public Hyperlink accesskey(String value) {
091      super.accesskey(value);
092      return this;
093   }
094
095   @Override /* Overridden from A */
096   public Hyperlink attr(String key, Object val) {
097      super.attr(key, val);
098      return this;
099   }
100
101   @Override /* Overridden from A */
102   public Hyperlink attrUri(String key, Object val) {
103      super.attrUri(key, val);
104      return this;
105   }
106
107   @Override /* Overridden from A */
108   public Hyperlink child(Object value) {
109      super.child(value);
110      return this;
111   }
112
113   @Override /* Overridden from A */
114   public Hyperlink children(Object...value) {
115      super.children(value);
116      return this;
117   }
118
119   // Global HTML attributes
120
121   @Override /* Overridden from A */
122   public Hyperlink contenteditable(Object value) {
123      super.contenteditable(value);
124      return this;
125   }
126
127   @Override /* Overridden from A */
128   public Hyperlink dir(String value) {
129      super.dir(value);
130      return this;
131   }
132
133   @Override /* Overridden from A */
134   public Hyperlink download(Object value) {
135      super.download(value);
136      return this;
137   }
138
139   @Override /* Overridden from A */
140   public Hyperlink hidden(Object value) {
141      super.hidden(value);
142      return this;
143   }
144
145   @Override /* Overridden from A */
146   public Hyperlink href(Object value) {
147      super.href(value);
148      return this;
149   }
150
151   @Override /* Overridden from A */
152   public Hyperlink hreflang(String value) {
153      super.hreflang(value);
154      return this;
155   }
156
157   @Override /* Overridden from A */
158   public Hyperlink id(String value) {
159      super.id(value);
160      return this;
161   }
162
163   @Override /* Overridden from A */
164   public Hyperlink lang(String value) {
165      super.lang(value);
166      return this;
167   }
168
169   @Override /* Overridden from A */
170   public Hyperlink onabort(String value) {
171      super.onabort(value);
172      return this;
173   }
174
175   @Override /* Overridden from A */
176   public Hyperlink onblur(String value) {
177      super.onblur(value);
178      return this;
179   }
180
181   @Override /* Overridden from A */
182   public Hyperlink oncancel(String value) {
183      super.oncancel(value);
184      return this;
185   }
186
187   @Override /* Overridden from A */
188   public Hyperlink oncanplay(String value) {
189      super.oncanplay(value);
190      return this;
191   }
192
193   // Event handler attributes
194
195   @Override /* Overridden from A */
196   public Hyperlink oncanplaythrough(String value) {
197      super.oncanplaythrough(value);
198      return this;
199   }
200
201   @Override /* Overridden from A */
202   public Hyperlink onchange(String value) {
203      super.onchange(value);
204      return this;
205   }
206
207   @Override /* Overridden from A */
208   public Hyperlink onclick(String value) {
209      super.onclick(value);
210      return this;
211   }
212
213   @Override /* Overridden from A */
214   public Hyperlink oncuechange(String value) {
215      super.oncuechange(value);
216      return this;
217   }
218
219   @Override /* Overridden from A */
220   public Hyperlink ondblclick(String value) {
221      super.ondblclick(value);
222      return this;
223   }
224
225   @Override /* Overridden from A */
226   public Hyperlink ondurationchange(String value) {
227      super.ondurationchange(value);
228      return this;
229   }
230
231   @Override /* Overridden from A */
232   public Hyperlink onemptied(String value) {
233      super.onemptied(value);
234      return this;
235   }
236
237   @Override /* Overridden from A */
238   public Hyperlink onended(String value) {
239      super.onended(value);
240      return this;
241   }
242
243   @Override /* Overridden from A */
244   public Hyperlink onerror(String value) {
245      super.onerror(value);
246      return this;
247   }
248
249   @Override /* Overridden from A */
250   public Hyperlink onfocus(String value) {
251      super.onfocus(value);
252      return this;
253   }
254
255   @Override /* Overridden from A */
256   public Hyperlink oninput(String value) {
257      super.oninput(value);
258      return this;
259   }
260
261   @Override /* Overridden from A */
262   public Hyperlink oninvalid(String value) {
263      super.oninvalid(value);
264      return this;
265   }
266
267   @Override /* Overridden from A */
268   public Hyperlink onkeydown(String value) {
269      super.onkeydown(value);
270      return this;
271   }
272
273   @Override /* Overridden from A */
274   public Hyperlink onkeypress(String value) {
275      super.onkeypress(value);
276      return this;
277   }
278
279   @Override /* Overridden from A */
280   public Hyperlink onkeyup(String value) {
281      super.onkeyup(value);
282      return this;
283   }
284
285   @Override /* Overridden from A */
286   public Hyperlink onload(String value) {
287      super.onload(value);
288      return this;
289   }
290
291   @Override /* Overridden from A */
292   public Hyperlink onloadeddata(String value) {
293      super.onloadeddata(value);
294      return this;
295   }
296
297   @Override /* Overridden from A */
298   public Hyperlink onloadedmetadata(String value) {
299      super.onloadedmetadata(value);
300      return this;
301   }
302
303   @Override /* Overridden from A */
304   public Hyperlink onloadstart(String value) {
305      super.onloadstart(value);
306      return this;
307   }
308
309   @Override /* Overridden from A */
310   public Hyperlink onmousedown(String value) {
311      super.onmousedown(value);
312      return this;
313   }
314
315   @Override /* Overridden from A */
316   public Hyperlink onmouseenter(String value) {
317      super.onmouseenter(value);
318      return this;
319   }
320
321   @Override /* Overridden from A */
322   public Hyperlink onmouseleave(String value) {
323      super.onmouseleave(value);
324      return this;
325   }
326
327   @Override /* Overridden from A */
328   public Hyperlink onmousemove(String value) {
329      super.onmousemove(value);
330      return this;
331   }
332
333   @Override /* Overridden from A */
334   public Hyperlink onmouseout(String value) {
335      super.onmouseout(value);
336      return this;
337   }
338
339   @Override /* Overridden from A */
340   public Hyperlink onmouseover(String value) {
341      super.onmouseover(value);
342      return this;
343   }
344
345   @Override /* Overridden from A */
346   public Hyperlink onmouseup(String value) {
347      super.onmouseup(value);
348      return this;
349   }
350
351   @Override /* Overridden from A */
352   public Hyperlink onmousewheel(String value) {
353      super.onmousewheel(value);
354      return this;
355   }
356
357   @Override /* Overridden from A */
358   public Hyperlink onpause(String value) {
359      super.onpause(value);
360      return this;
361   }
362
363   @Override /* Overridden from A */
364   public Hyperlink onplay(String value) {
365      super.onplay(value);
366      return this;
367   }
368
369   @Override /* Overridden from A */
370   public Hyperlink onplaying(String value) {
371      super.onplaying(value);
372      return this;
373   }
374
375   @Override /* Overridden from A */
376   public Hyperlink onprogress(String value) {
377      super.onprogress(value);
378      return this;
379   }
380
381   @Override /* Overridden from A */
382   public Hyperlink onratechange(String value) {
383      super.onratechange(value);
384      return this;
385   }
386
387   @Override /* Overridden from A */
388   public Hyperlink onreset(String value) {
389      super.onreset(value);
390      return this;
391   }
392
393   @Override /* Overridden from A */
394   public Hyperlink onresize(String value) {
395      super.onresize(value);
396      return this;
397   }
398
399   @Override /* Overridden from A */
400   public Hyperlink onscroll(String value) {
401      super.onscroll(value);
402      return this;
403   }
404
405   @Override /* Overridden from A */
406   public Hyperlink onseeked(String value) {
407      super.onseeked(value);
408      return this;
409   }
410
411   @Override /* Overridden from A */
412   public Hyperlink onseeking(String value) {
413      super.onseeking(value);
414      return this;
415   }
416
417   @Override /* Overridden from A */
418   public Hyperlink onselect(String value) {
419      super.onselect(value);
420      return this;
421   }
422
423   @Override /* Overridden from A */
424   public Hyperlink onshow(String value) {
425      super.onshow(value);
426      return this;
427   }
428
429   @Override /* Overridden from A */
430   public Hyperlink onstalled(String value) {
431      super.onstalled(value);
432      return this;
433   }
434
435   @Override /* Overridden from A */
436   public Hyperlink onsubmit(String value) {
437      super.onsubmit(value);
438      return this;
439   }
440
441   @Override /* Overridden from A */
442   public Hyperlink onsuspend(String value) {
443      super.onsuspend(value);
444      return this;
445   }
446
447   @Override /* Overridden from A */
448   public Hyperlink ontimeupdate(String value) {
449      super.ontimeupdate(value);
450      return this;
451   }
452
453   @Override /* Overridden from A */
454   public Hyperlink ontoggle(String value) {
455      super.ontoggle(value);
456      return this;
457   }
458
459   @Override /* Overridden from A */
460   public Hyperlink onvolumechange(String value) {
461      super.onvolumechange(value);
462      return this;
463   }
464
465   @Override /* Overridden from A */
466   public Hyperlink onwaiting(String value) {
467      super.onwaiting(value);
468      return this;
469   }
470
471   @Override /* Overridden from A */
472   public Hyperlink rel(String value) {
473      super.rel(value);
474      return this;
475   }
476
477   @Override /* Overridden from A */
478   public Hyperlink spellcheck(Object value) {
479      super.spellcheck(value);
480      return this;
481   }
482
483   @Override /* Overridden from A */
484   public Hyperlink style(String value) {
485      super.style(value);
486      return this;
487   }
488
489   @Override /* Overridden from A */
490   public Hyperlink tabindex(Object value) {
491      super.tabindex(value);
492      return this;
493   }
494
495   // Child/attribute methods
496
497   @Override /* Overridden from A */
498   public Hyperlink target(String value) {
499      super.target(value);
500      return this;
501   }
502
503   @Override /* Overridden from A */
504   public Hyperlink title(String value) {
505      super.title(value);
506      return this;
507   }
508
509   @Override /* Overridden from A */
510   public Hyperlink translate(Object value) {
511      super.translate(value);
512      return this;
513   }
514
515   @Override /* Overridden from A */
516   public Hyperlink type(String value) {
517      super.type(value);
518      return this;
519   }
520}