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 org.apache.juneau.annotation.*;
020import org.apache.juneau.internal.*;
021
022/**
023 * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#the-title-element">&lt;title&gt;</a>
024 * element.
025 *
026 * <p>
027 * The title element represents the document's title or name. It is used to provide a title
028 * for the document that appears in the browser's title bar, bookmarks, and search engine
029 * results. The title element should be placed within the head element and should be descriptive
030 * and unique for each page. It is important for SEO, accessibility, and user experience as
031 * it helps users identify the page content and purpose.
032 *
033 * <h5 class='section'>Examples:</h5>
034 * <p class='bcode w800'>
035 *    <jk>import static</jk> org.apache.juneau.bean.html5.HtmlBuilder.*;
036 * 
037 *    <jc>// Simple page title</jc>
038 *    Title <jv>simple</jv> = <jsm>title</jsm>(<js>"Welcome to My Website"</js>);
039 * 
040 *    <jc>// Title with dynamic content</jc>
041 *    Title <jv>dynamic</jv> = <jsm>title</jsm>(<js>"User Dashboard - "</js> + <jv>username</jv>);
042 * 
043 *    <jc>// Title with branding</jc>
044 *    Title <jv>branded</jv> = <jsm>title</jsm>(<js>"About Us | My Company"</js>);
045 * 
046 *    <jc>// Title with SEO keywords</jc>
047 *    Title <jv>seo</jv> = <jsm>title</jsm>(<js>"Best Coffee Shops in Seattle - 2024 Guide"</js>);
048 * 
049 *    <jc>// Title with separator</jc>
050 *    Title <jv>separated</jv> = <jsm>title</jsm>(<js>"Contact Us - Get in Touch"</js>);
051 * 
052 *    <jc>// Title with emoji</jc>
053 *    Title <jv>emoji</jv> = <jsm>title</jsm>(<js>"🎉 Welcome to Our Store!"</js>);
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="title")
061public class Title extends HtmlElementRawText {
062
063   /**
064    * Creates an empty {@link Title} element.
065    */
066   public Title() {}
067
068   /**
069    * Creates a {@link Title} element with the specified {@link Title#text(Object)} node.
070    *
071    * @param text The {@link Title#text(Object)} node.
072    */
073   public Title(String text) {
074      text(text);
075   }
076
077   //-----------------------------------------------------------------------------------------------------------------
078   // Overridden methods
079   //-----------------------------------------------------------------------------------------------------------------
080   @Override /* Overridden from HtmlElement */
081   public Title _class(String value) {  // NOSONAR - Intentional naming.
082      super._class(value);
083      return this;
084   }
085
086   @Override /* Overridden from HtmlElement */
087   public Title accesskey(String value) {
088      super.accesskey(value);
089      return this;
090   }
091
092   @Override /* Overridden from HtmlElement */
093   public Title contenteditable(Object value) {
094      super.contenteditable(value);
095      return this;
096   }
097
098   @Override /* Overridden from HtmlElement */
099   public Title dir(String value) {
100      super.dir(value);
101      return this;
102   }
103
104   @Override /* Overridden from HtmlElement */
105   public Title hidden(Object value) {
106      super.hidden(value);
107      return this;
108   }
109
110   @Override /* Overridden from HtmlElement */
111   public Title id(String value) {
112      super.id(value);
113      return this;
114   }
115
116   @Override /* Overridden from HtmlElement */
117   public Title lang(String value) {
118      super.lang(value);
119      return this;
120   }
121
122   @Override /* Overridden from HtmlElement */
123   public Title onabort(String value) {
124      super.onabort(value);
125      return this;
126   }
127
128   @Override /* Overridden from HtmlElement */
129   public Title onblur(String value) {
130      super.onblur(value);
131      return this;
132   }
133
134   @Override /* Overridden from HtmlElement */
135   public Title oncancel(String value) {
136      super.oncancel(value);
137      return this;
138   }
139
140   @Override /* Overridden from HtmlElement */
141   public Title oncanplay(String value) {
142      super.oncanplay(value);
143      return this;
144   }
145
146   @Override /* Overridden from HtmlElement */
147   public Title oncanplaythrough(String value) {
148      super.oncanplaythrough(value);
149      return this;
150   }
151
152   @Override /* Overridden from HtmlElement */
153   public Title onchange(String value) {
154      super.onchange(value);
155      return this;
156   }
157
158   @Override /* Overridden from HtmlElement */
159   public Title onclick(String value) {
160      super.onclick(value);
161      return this;
162   }
163
164   @Override /* Overridden from HtmlElement */
165   public Title oncuechange(String value) {
166      super.oncuechange(value);
167      return this;
168   }
169
170   @Override /* Overridden from HtmlElement */
171   public Title ondblclick(String value) {
172      super.ondblclick(value);
173      return this;
174   }
175
176   @Override /* Overridden from HtmlElement */
177   public Title ondurationchange(String value) {
178      super.ondurationchange(value);
179      return this;
180   }
181
182   @Override /* Overridden from HtmlElement */
183   public Title onemptied(String value) {
184      super.onemptied(value);
185      return this;
186   }
187
188   @Override /* Overridden from HtmlElement */
189   public Title onended(String value) {
190      super.onended(value);
191      return this;
192   }
193
194   @Override /* Overridden from HtmlElement */
195   public Title onerror(String value) {
196      super.onerror(value);
197      return this;
198   }
199
200   @Override /* Overridden from HtmlElement */
201   public Title onfocus(String value) {
202      super.onfocus(value);
203      return this;
204   }
205
206   @Override /* Overridden from HtmlElement */
207   public Title oninput(String value) {
208      super.oninput(value);
209      return this;
210   }
211
212   @Override /* Overridden from HtmlElement */
213   public Title oninvalid(String value) {
214      super.oninvalid(value);
215      return this;
216   }
217
218   @Override /* Overridden from HtmlElement */
219   public Title onkeydown(String value) {
220      super.onkeydown(value);
221      return this;
222   }
223
224   @Override /* Overridden from HtmlElement */
225   public Title onkeypress(String value) {
226      super.onkeypress(value);
227      return this;
228   }
229
230   @Override /* Overridden from HtmlElement */
231   public Title onkeyup(String value) {
232      super.onkeyup(value);
233      return this;
234   }
235
236   @Override /* Overridden from HtmlElement */
237   public Title onload(String value) {
238      super.onload(value);
239      return this;
240   }
241
242   @Override /* Overridden from HtmlElement */
243   public Title onloadeddata(String value) {
244      super.onloadeddata(value);
245      return this;
246   }
247
248   @Override /* Overridden from HtmlElement */
249   public Title onloadedmetadata(String value) {
250      super.onloadedmetadata(value);
251      return this;
252   }
253
254   @Override /* Overridden from HtmlElement */
255   public Title onloadstart(String value) {
256      super.onloadstart(value);
257      return this;
258   }
259
260   @Override /* Overridden from HtmlElement */
261   public Title onmousedown(String value) {
262      super.onmousedown(value);
263      return this;
264   }
265
266   @Override /* Overridden from HtmlElement */
267   public Title onmouseenter(String value) {
268      super.onmouseenter(value);
269      return this;
270   }
271
272   @Override /* Overridden from HtmlElement */
273   public Title onmouseleave(String value) {
274      super.onmouseleave(value);
275      return this;
276   }
277
278   @Override /* Overridden from HtmlElement */
279   public Title onmousemove(String value) {
280      super.onmousemove(value);
281      return this;
282   }
283
284   @Override /* Overridden from HtmlElement */
285   public Title onmouseout(String value) {
286      super.onmouseout(value);
287      return this;
288   }
289
290   @Override /* Overridden from HtmlElement */
291   public Title onmouseover(String value) {
292      super.onmouseover(value);
293      return this;
294   }
295
296   @Override /* Overridden from HtmlElement */
297   public Title onmouseup(String value) {
298      super.onmouseup(value);
299      return this;
300   }
301
302   @Override /* Overridden from HtmlElement */
303   public Title onmousewheel(String value) {
304      super.onmousewheel(value);
305      return this;
306   }
307
308   @Override /* Overridden from HtmlElement */
309   public Title onpause(String value) {
310      super.onpause(value);
311      return this;
312   }
313
314   @Override /* Overridden from HtmlElement */
315   public Title onplay(String value) {
316      super.onplay(value);
317      return this;
318   }
319
320   @Override /* Overridden from HtmlElement */
321   public Title onplaying(String value) {
322      super.onplaying(value);
323      return this;
324   }
325
326   @Override /* Overridden from HtmlElement */
327   public Title onprogress(String value) {
328      super.onprogress(value);
329      return this;
330   }
331
332   @Override /* Overridden from HtmlElement */
333   public Title onratechange(String value) {
334      super.onratechange(value);
335      return this;
336   }
337
338   @Override /* Overridden from HtmlElement */
339   public Title onreset(String value) {
340      super.onreset(value);
341      return this;
342   }
343
344   @Override /* Overridden from HtmlElement */
345   public Title onresize(String value) {
346      super.onresize(value);
347      return this;
348   }
349
350   @Override /* Overridden from HtmlElement */
351   public Title onscroll(String value) {
352      super.onscroll(value);
353      return this;
354   }
355
356   @Override /* Overridden from HtmlElement */
357   public Title onseeked(String value) {
358      super.onseeked(value);
359      return this;
360   }
361
362   @Override /* Overridden from HtmlElement */
363   public Title onseeking(String value) {
364      super.onseeking(value);
365      return this;
366   }
367
368   @Override /* Overridden from HtmlElement */
369   public Title onselect(String value) {
370      super.onselect(value);
371      return this;
372   }
373
374   @Override /* Overridden from HtmlElement */
375   public Title onshow(String value) {
376      super.onshow(value);
377      return this;
378   }
379
380   @Override /* Overridden from HtmlElement */
381   public Title onstalled(String value) {
382      super.onstalled(value);
383      return this;
384   }
385
386   @Override /* Overridden from HtmlElement */
387   public Title onsubmit(String value) {
388      super.onsubmit(value);
389      return this;
390   }
391
392   @Override /* Overridden from HtmlElement */
393   public Title onsuspend(String value) {
394      super.onsuspend(value);
395      return this;
396   }
397
398   @Override /* Overridden from HtmlElement */
399   public Title ontimeupdate(String value) {
400      super.ontimeupdate(value);
401      return this;
402   }
403
404   @Override /* Overridden from HtmlElement */
405   public Title ontoggle(String value) {
406      super.ontoggle(value);
407      return this;
408   }
409
410   @Override /* Overridden from HtmlElement */
411   public Title onvolumechange(String value) {
412      super.onvolumechange(value);
413      return this;
414   }
415
416   @Override /* Overridden from HtmlElement */
417   public Title onwaiting(String value) {
418      super.onwaiting(value);
419      return this;
420   }
421
422   @Override /* Overridden from HtmlElement */
423   public Title spellcheck(Object value) {
424      super.spellcheck(value);
425      return this;
426   }
427
428   @Override /* Overridden from HtmlElement */
429   public Title style(String value) {
430      super.style(value);
431      return this;
432   }
433
434   @Override /* Overridden from HtmlElement */
435   public Title tabindex(Object value) {
436      super.tabindex(value);
437      return this;
438   }
439
440   @Override /* Overridden from HtmlElement */
441   public Title title(String value) {
442      super.title(value);
443      return this;
444   }
445
446   @Override /* Overridden from HtmlElement */
447   public Title translate(Object value) {
448      super.translate(value);
449      return this;
450   }
451
452   @Override /* Overridden from HtmlElementRawText */
453   public Title text(Object value) {
454      super.text(value);
455      return this;
456   }
457}