Source code

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