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.io.PrintWriter;
18 import java.util.Map;
19
20 import org.htmlunit.SgmlPage;
21
22 /**
23 * Wrapper for the HTML element "template".
24 *
25 * @author Ahmed Ashour
26 * @author Ronald Brill
27 * @author Ronny Shapiro
28 */
29 public class HtmlTemplate extends HtmlElement {
30
31 /** The HTML tag represented by this element. */
32 public static final String TAG_NAME = "template";
33
34 private final DomDocumentFragment domDocumentFragment_;
35
36 /**
37 * Creates a new instance.
38 *
39 * @param qualifiedName the qualified name of the element type to instantiate
40 * @param page the page that contains this element
41 * @param attributes the initial attributes
42 */
43 HtmlTemplate(final String qualifiedName, final SgmlPage page,
44 final Map<String, DomAttr> attributes) {
45 super(qualifiedName, page, attributes);
46
47 domDocumentFragment_ = new DomDocumentFragment(page);
48 }
49
50 /**
51 * {@inheritDoc}
52 */
53 @Override
54 public DisplayStyle getDefaultStyleDisplay() {
55 return DisplayStyle.NONE;
56 }
57
58 /**
59 * Return the associated document fragment.
60 *
61 * @return the associated document fragment
62 */
63 public DomDocumentFragment getContent() {
64 return domDocumentFragment_;
65 }
66
67 @Override
68 protected boolean isEmptyXmlTagExpanded() {
69 // Always print expanded tag to force printing of
70 // children if available
71 return true;
72 }
73
74 /**
75 * {@inheritDoc}
76 */
77 @Override
78 protected boolean printXml(final String indent, final boolean indentBefore, final PrintWriter printWriter) {
79 final boolean hasChildren = domDocumentFragment_.getFirstChild() != null;
80
81 if (indentBefore) {
82 printWriter.print("\r\n");
83 printWriter.print(indent);
84 }
85
86 printWriter.print('<');
87 printOpeningTagContentAsXml(printWriter);
88
89 if (hasChildren) {
90 printWriter.print(">");
91 final boolean tag = domDocumentFragment_.printChildrenAsXml(indent, indentBefore, printWriter);
92 if (tag) {
93 printWriter.print("\r\n");
94 printWriter.print(indent);
95 }
96 printWriter.print("</");
97 printWriter.print(getTagName());
98 printWriter.print(">");
99 }
100 else if (isEmptyXmlTagExpanded()) {
101 printWriter.print("></");
102 printWriter.print(getTagName());
103 printWriter.print(">");
104 }
105 else {
106 printWriter.print("/>");
107 }
108
109 return true;
110 }
111 }