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.util.Map;
18  
19  import org.htmlunit.SgmlPage;
20  
21  /**
22   * Wrapper for the HTML element "frameset".
23   *
24   * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
25   * @author David K. Taylor
26   * @author <a href="mailto:cse@dynabean.de">Christian Sell</a>
27   * @author Ahmed Ashour
28   * @author Frank Danek
29   * @author Ronny Shapiro
30   */
31  public class HtmlFrameSet extends HtmlElement {
32  
33      /** The HTML tag represented by this element. */
34      public static final String TAG_NAME = "frameset";
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      HtmlFrameSet(final String qualifiedName, final SgmlPage page,
44              final Map<String, DomAttr> attributes) {
45          super(qualifiedName, page, attributes);
46  
47          // force script object creation now to forward onXXX handlers to window
48          if (getPage().getWebClient().isJavaScriptEngineEnabled()) {
49              getScriptableObject();
50          }
51      }
52  
53      /**
54       * Returns the value of the attribute {@code rows}. Refer to the
55       * <a href="http://www.w3.org/TR/html401/">HTML 4.01</a>
56       * documentation for details on the use of this attribute.
57       *
58       * @return the value of the attribute {@code rows} or an empty string if that attribute isn't defined
59       */
60      public final String getRowsAttribute() {
61          return getAttributeDirect("rows");
62      }
63  
64      /**
65       * Returns the value of the attribute {@code cols}. Refer to the
66       * <a href="http://www.w3.org/TR/html401/">HTML 4.01</a>
67       * documentation for details on the use of this attribute.
68       *
69       * @return the value of the attribute {@code cols} or an empty string if that attribute isn't defined
70       */
71      public final String getColsAttribute() {
72          return getAttributeDirect("cols");
73      }
74  
75      /**
76       * Returns the value of the attribute {@code onload}. Refer to the
77       * <a href="http://www.w3.org/TR/html401/">HTML 4.01</a>
78       * documentation for details on the use of this attribute.
79       *
80       * @return the value of the attribute {@code onload} or an empty string if that attribute isn't defined
81       */
82      public final String getOnLoadAttribute() {
83          return getAttributeDirect("onload");
84      }
85  
86      /**
87       * Returns the value of the attribute {@code onunload}. Refer to the
88       * <a href="http://www.w3.org/TR/html401/">HTML 4.01</a>
89       * documentation for details on the use of this attribute.
90       *
91       * @return the value of the attribute {@code onunload} or an empty string if that attribute isn't defined
92       */
93      public final String getOnUnloadAttribute() {
94          return getAttributeDirect("onunload");
95      }
96  }