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