1 /*
2 * Copyright (c) 2002-2026 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 Mike Bowler
25 * @author Christian Sell
26 * @author Chris Erskine
27 * @author Marc Guillemot
28 * @author Ahmed Ashour
29 * @author Frank Danek
30 * @author Ronald Brill
31 */
32 public class HtmlTitle extends HtmlElement {
33
34 /** The HTML tag represented by this element. */
35 public static final String TAG_NAME = "title";
36
37 /**
38 * Creates an instance of HtmlTitle.
39 *
40 * @param qualifiedName the qualified name of the element type to instantiate
41 * @param page the HtmlPage that contains this element
42 * @param attributes the initial attributes
43 */
44 HtmlTitle(final String qualifiedName, final SgmlPage page,
45 final Map<String, DomAttr> attributes) {
46 super(qualifiedName, page, attributes);
47 }
48
49 /**
50 * Allows the text value for the title element be replaced.
51 * {@inheritDoc}
52 */
53 @Override
54 public void setNodeValue(final String message) {
55 final DomNode child = getFirstChild();
56 if (child == null) {
57 final DomNode textNode = new DomText(getPage(), message);
58 appendChild(textNode);
59 }
60 else if (child instanceof DomText text) {
61 text.setData(message);
62 }
63 else {
64 throw new IllegalStateException("For title tag, this should be a text node");
65 }
66 }
67
68 /**
69 * {@inheritDoc}
70 */
71 @Override
72 protected boolean isEmptyXmlTagExpanded() {
73 return true;
74 }
75
76 /**
77 * {@inheritDoc}
78 */
79 @Override
80 public DisplayStyle getDefaultStyleDisplay() {
81 return DisplayStyle.NONE;
82 }
83
84 /**
85 * The child text content: the concatenation of the data of all text node children,
86 * elements and comments are skipped (CDATA sections are text nodes).
87 *
88 * @return the {@code text} attribute
89 */
90 public String getText() {
91 final DomNode firstChild = getFirstChild();
92 if (firstChild == null) {
93 return "";
94 }
95
96 final StringBuilder sb = new StringBuilder();
97 for (final DomNode child : getChildren()) {
98 if (child instanceof DomText text) {
99 sb.append(text.getData());
100 }
101 }
102 return sb.toString();
103 }
104
105 /**
106 * Sets the {@code text} attribute: all children are replaced by a single text node;
107 * an empty string leaves the title without children.
108 * @param text the {@code text} attribute
109 */
110 public void setText(final String text) {
111 removeAllChildren();
112 if (text != null && !text.isEmpty()) {
113 appendChild(new DomText(getPage(), text));
114 }
115 }
116 }