View Javadoc
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.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      public DomDocumentFragment getContent() {
62          return domDocumentFragment_;
63      }
64  
65      @Override
66      protected boolean isEmptyXmlTagExpanded() {
67          // Always print expanded tag to force printing of
68          // children if available
69          return true;
70      }
71  
72      /**
73       * {@inheritDoc}
74       */
75      @Override
76      protected boolean printXml(final String indent, final boolean tagBefore, final PrintWriter printWriter) {
77          final boolean hasChildren = domDocumentFragment_.getFirstChild() != null;
78  
79          if (tagBefore) {
80              printWriter.print("\r\n");
81              printWriter.print(indent);
82          }
83  
84          printWriter.print('<');
85          printOpeningTagContentAsXml(printWriter);
86  
87          if (hasChildren) {
88              printWriter.print(">");
89              final boolean tag = domDocumentFragment_.printChildrenAsXml(indent, tagBefore, printWriter);
90              if (tag) {
91                  printWriter.print("\r\n");
92                  printWriter.print(indent);
93              }
94              printWriter.print("</");
95              printWriter.print(getTagName());
96              printWriter.print(">");
97          }
98          else if (isEmptyXmlTagExpanded()) {
99              printWriter.print("></");
100             printWriter.print(getTagName());
101             printWriter.print(">");
102         }
103         else {
104             printWriter.print("/>");
105         }
106 
107         return true;
108     }
109 }