1 /*
2 * Copyright (c) 2002-2025 Gargoyle Software Inc.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 * https://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15 package org.htmlunit.html;
16
17 import java.util.Map;
18
19 import org.htmlunit.SgmlPage;
20
21 /**
22 * Wrapper for the HTML element "title".
23 *
24 * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
25 * @author <a href="mailto:cse@dynabean.de">Christian Sell</a>
26 * @author Chris Erskine
27 * @author Marc Guillemot
28 * @author Ahmed Ashour
29 * @author Frank Danek
30 */
31 public class HtmlTitle extends HtmlElement {
32
33 /** The HTML tag represented by this element. */
34 public static final String TAG_NAME = "title";
35
36 /**
37 * Creates an instance of HtmlTitle.
38 *
39 * @param qualifiedName the qualified name of the element type to instantiate
40 * @param page the HtmlPage that contains this element
41 * @param attributes the initial attributes
42 */
43 HtmlTitle(final String qualifiedName, final SgmlPage page,
44 final Map<String, DomAttr> attributes) {
45 super(qualifiedName, page, attributes);
46 }
47
48 /**
49 * Allows the text value for the title element be replaced.
50 * {@inheritDoc}
51 */
52 @Override
53 public void setNodeValue(final String message) {
54 final DomNode child = getFirstChild();
55 if (child == null) {
56 final DomNode textNode = new DomText(getPage(), message);
57 appendChild(textNode);
58 }
59 else if (child instanceof DomText) {
60 ((DomText) child).setData(message);
61 }
62 else {
63 throw new IllegalStateException("For title tag, this should be a text node");
64 }
65 }
66
67 /**
68 * {@inheritDoc}
69 */
70 @Override
71 protected boolean isEmptyXmlTagExpanded() {
72 return true;
73 }
74
75 /**
76 * {@inheritDoc}
77 */
78 @Override
79 public DisplayStyle getDefaultStyleDisplay() {
80 return DisplayStyle.NONE;
81 }
82
83 /**
84 * Returns the {@code text} attribute.
85 * @return the {@code text} attribute
86 */
87 public String getText() {
88 final DomNode firstChild = getFirstChild();
89 if (firstChild != null) {
90 return firstChild.getNodeValue();
91 }
92 return "";
93 }
94
95 /**
96 * Sets the {@code text} attribute.
97 * @param text the {@code text} attribute
98 */
99 public void setText(final String text) {
100 DomNode firstChild = getFirstChild();
101 if (firstChild == null) {
102 firstChild = new DomText(getPage(), text);
103 appendChild(firstChild);
104 }
105 else {
106 firstChild.setNodeValue(text);
107 }
108 }
109 }