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