Package org.htmlunit.html
Class BaseFrameElement
- java.lang.Object
-
- org.htmlunit.html.DomNode
-
- org.htmlunit.html.DomNamespaceNode
-
- org.htmlunit.html.DomElement
-
- org.htmlunit.html.HtmlElement
-
- org.htmlunit.html.BaseFrameElement
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,org.w3c.dom.Element
,org.w3c.dom.Node
- Direct Known Subclasses:
HtmlFrame
,HtmlInlineFrame
public abstract class BaseFrameElement extends HtmlElement
Base class for frame and iframe.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.htmlunit.html.HtmlElement
HtmlElement.DisplayStyle
-
Nested classes/interfaces inherited from class org.htmlunit.html.DomElement
DomElement.ChildElementsIterator
-
Nested classes/interfaces inherited from class org.htmlunit.html.DomNode
DomNode.ChildIterator, DomNode.DescendantElementsIterator<T extends DomNode>
-
-
Field Summary
-
Fields inherited from class org.htmlunit.html.HtmlElement
ATTRIBUTE_CHECKED, ATTRIBUTE_REQUIRED, TAB_INDEX_OUT_OF_BOUNDS
-
Fields inherited from class org.htmlunit.html.DomElement
ATTRIBUTE_NOT_DEFINED, ATTRIBUTE_VALUE_EMPTY, ID_ATTRIBUTE, NAME_ATTRIBUTE, SRC_ATTRIBUTE, TYPE_ATTRIBUTE, VALUE_ATTRIBUTE
-
Fields inherited from class org.htmlunit.html.DomNode
PROPERTY_ELEMENT, READY_STATE_COMPLETE, READY_STATE_INTERACTIVE, READY_STATE_LOADED, READY_STATE_LOADING, READY_STATE_UNINITIALIZED
-
Fields inherited from interface org.w3c.dom.Node
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
BaseFrameElement(java.lang.String qualifiedName, SgmlPage page, java.util.Map<java.lang.String,DomAttr> attributes)
Creates an instance of BaseFrame.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DomNode
cloneNode(boolean deep)
Creates a newWebWindow
for the new clone.Page
getEnclosedPage()
Returns the currently loaded page in the enclosed window.FrameWindow
getEnclosedWindow()
Gets the window enclosed in this frame.java.lang.String
getFrameBorderAttribute()
Returns the value of the attributeframeborder
.java.lang.String
getLongDescAttribute()
Returns the value of the attributelongdesc
.java.lang.String
getMarginHeightAttribute()
Returns the value of the attributemarginheight
.java.lang.String
getMarginWidthAttribute()
Returns the value of the attributemarginwidth
.java.lang.String
getNameAttribute()
Returns the value of the attributename
.java.lang.String
getNoResizeAttribute()
Returns the value of the attributenoresize
.java.lang.String
getOnLoadAttribute()
Returns the value of the attributeonload
.java.lang.String
getScrollingAttribute()
Returns the value of the attributescrolling
.java.lang.String
getSrcAttribute()
Returns the value of the attributesrc
.void
loadInnerPage()
INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
Called after the node for theframe
oriframe
has been added to the containing page.protected void
onAddedToPage()
Lifecycle method invoked whenever a node is added to a page.void
remove()
Removes this node from all relationships with other nodes.void
removeAttribute(java.lang.String attributeName)
Removes an attribute specified by name from this element.org.w3c.dom.Attr
setAttributeNode(org.w3c.dom.Attr attribute)
Sets the specified attribute.protected void
setAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName, java.lang.String attributeValue, boolean notifyAttributeChangeListeners, boolean notifyMutationObserver)
Sets the value of the attribute specified by namespace and qualified name.void
setNameAttribute(java.lang.String name)
Sets the value of thename
attribute.void
setSrcAttribute(java.lang.String attribute)
Sets the value of thesrc
attribute.-
Methods inherited from class org.htmlunit.html.HtmlElement
acceptChar, addHtmlAttributeChangeListener, appendChildIfNoneExists, checkChildHierarchy, detach, doType, doType, fireHtmlAttributeAdded, fireHtmlAttributeRemoved, fireHtmlAttributeReplaced, getCanonicalXPath, getDefaultStyleDisplay, getElementsByAttribute, getEnclosingElement, getEnclosingForm, getEnclosingFormOrDie, getLangAttribute, getNodeName, getOnClickAttribute, getOnDblClickAttribute, getOneHtmlElementByAttribute, getOnKeyDownAttribute, getOnKeyPressAttribute, getOnKeyUpAttribute, getOnMouseDownAttribute, getOnMouseMoveAttribute, getOnMouseOutAttribute, getOnMouseOverAttribute, getOnMouseUpAttribute, getSrcAttributeNormalized, getTabIndex, getTextDirectionAttribute, getXmlLangAttribute, handles, hasEventHandlers, isAltPressed, isAttributeCaseSensitive, isCtrlPressed, isDisplayed, isHidden, isOptional, isRequired, isRequiredSupported, isShiftPressed, isSubmittableByEnter, isValid, notifyAttributeChangeListeners, removeChild, removeHtmlAttributeChangeListener, setOwningForm, setRequired, type, type, type, type, typeDone
-
Methods inherited from class org.htmlunit.html.DomElement
blur, click, click, click, click, click, dblClick, dblClick, doClickFireChangeEvent, doClickFireClickEvent, doClickStateUpdate, fireEvent, fireEvent, focus, getAttribute, getAttributeDirect, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributesMap, getChildElementCount, getChildElements, getElementsByTagName, getElementsByTagNameNS, getEventTargetElement, getFirstElementChild, getId, getLastElementChild, getNodeType, getSchemaTypeInfo, getStyleElement, getStyleElementCaseInSensitive, getStyleMap, getTagName, hasAttribute, hasAttributeNS, hasAttributes, isDisabledElementAndDisabled, isEmptyXmlTagExpanded, isMouseOver, isStateUpdateFirst, matches, mouseDown, mouseDown, mouseMove, mouseMove, mouseOut, mouseOut, mouseOver, mouseOver, mouseUp, mouseUp, preventDefault, printOpeningTagContentAsXml, printXml, propagateClickStateUpdateToParent, removeAttributeNode, removeAttributeNS, removeFocus, removeStyleAttribute, replaceStyleAttribute, rightClick, rightClick, setAttribute, setAttributeNodeNS, setAttributeNS, setDefaults, setId, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setInnerHtml, setNodeValue, toString, writeStyleToElement
-
Methods inherited from class org.htmlunit.html.DomNamespaceNode
getLocalName, getLowercaseName, getNamespaceURI, getPrefix, getQualifiedName, processImportNode, setPrefix
-
Methods inherited from class org.htmlunit.html.DomNode
addCharacterDataChangeListener, addDomChangeListener, appendChild, asNormalizedText, asXml, basicRemove, closest, compareDocumentPosition, fireCharacterDataChanged, fireNodeAdded, fireNodeDeleted, getAncestors, getBaseURI, getByXPath, getByXPath, getChildNodes, getChildren, getDescendants, getDomElementDescendants, getEndColumnNumber, getEndLineNumber, getFeature, getFirstByXPath, getFirstByXPath, getFirstChild, getHtmlElementDescendants, getHtmlPageOrNull, getIndex, getLastChild, getNextElementSibling, getNextSibling, getNodeValue, getOwnerDocument, getPage, getParentNode, getPreviousElementSibling, getPreviousSibling, getReadyState, getScriptableObject, getSelectorList, getStartColumnNumber, getStartLineNumber, getTextContent, getUserData, getVisibleText, hasChildNodes, hasFeature, insertBefore, insertBefore, isAncestorOf, isAncestorOfAny, isAttachedToPage, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, mayBeDisplayed, normalize, notifyIncorrectness, onAddedToDocumentFragment, onAllChildrenAddedToPage, parseHtmlSnippet, printChildrenAsXml, querySelector, querySelectorAll, quietlyRemoveAndMoveChildrenTo, removeAllChildren, removeCharacterDataChangeListener, removeChild, removeDomChangeListener, replace, replaceChild, setEndLocation, setParentNode, setReadyState, setScriptableObject, setStartLocation, setTextContent, setUserData
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.w3c.dom.Node
appendChild, compareDocumentPosition, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setPrefix, setTextContent, setUserData
-
-
-
-
Constructor Detail
-
BaseFrameElement
protected BaseFrameElement(java.lang.String qualifiedName, SgmlPage page, java.util.Map<java.lang.String,DomAttr> attributes)
Creates an instance of BaseFrame.- Parameters:
qualifiedName
- the qualified name of the element type to instantiatepage
- the HtmlPage that contains this elementattributes
- the initial attributes
-
-
Method Detail
-
loadInnerPage
public void loadInnerPage() throws FailingHttpStatusCodeException
INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
Called after the node for theframe
oriframe
has been added to the containing page. The node needs to be added first to allow JavaScript in the frame to see the frame in the parent.- Throws:
FailingHttpStatusCodeException
- if the server returns a failing status code AND the propertyWebClientOptions.setThrowExceptionOnFailingStatusCode(boolean)
is set to true
-
getLongDescAttribute
public final java.lang.String getLongDescAttribute()
Returns the value of the attributelongdesc
. Refer to the HTML 4.01 documentation for details on the use of this attribute.- Returns:
- the value of the attribute
longdesc
or an empty string if that attribute isn't defined
-
getNameAttribute
public final java.lang.String getNameAttribute()
Returns the value of the attributename
. Refer to the HTML 4.01 documentation for details on the use of this attribute.- Returns:
- the value of the attribute
name
or an empty string if that attribute isn't defined
-
setNameAttribute
public final void setNameAttribute(java.lang.String name)
Sets the value of thename
attribute.- Parameters:
name
- the new window name
-
getSrcAttribute
public final java.lang.String getSrcAttribute()
Returns the value of the attributesrc
. Refer to the HTML 4.01 documentation for details on the use of this attribute.- Returns:
- the value of the attribute
src
or an empty string if that attribute isn't defined
-
getFrameBorderAttribute
public final java.lang.String getFrameBorderAttribute()
Returns the value of the attributeframeborder
. Refer to the HTML 4.01 documentation for details on the use of this attribute.- Returns:
- the value of the attribute
frameborder
or an empty string if that attribute isn't defined
-
getMarginWidthAttribute
public final java.lang.String getMarginWidthAttribute()
Returns the value of the attributemarginwidth
. Refer to the HTML 4.01 documentation for details on the use of this attribute.- Returns:
- the value of the attribute
marginwidth
or an empty string if that attribute isn't defined
-
getMarginHeightAttribute
public final java.lang.String getMarginHeightAttribute()
Returns the value of the attributemarginheight
. Refer to the HTML 4.01 documentation for details on the use of this attribute.- Returns:
- the value of the attribute
marginheight
or an empty string if that attribute isn't defined
-
getNoResizeAttribute
public final java.lang.String getNoResizeAttribute()
Returns the value of the attributenoresize
. Refer to the HTML 4.01 documentation for details on the use of this attribute.- Returns:
- the value of the attribute
noresize
or an empty string if that attribute isn't defined
-
getScrollingAttribute
public final java.lang.String getScrollingAttribute()
Returns the value of the attributescrolling
. Refer to the HTML 4.01 documentation for details on the use of this attribute.- Returns:
- the value of the attribute
scrolling
or an empty string if that attribute isn't defined
-
getOnLoadAttribute
public final java.lang.String getOnLoadAttribute()
Returns the value of the attributeonload
. This attribute is not actually supported by the HTML specification however it is supported by the popular browsers.- Returns:
- the value of the attribute
onload
or an empty string if that attribute isn't defined
-
getEnclosedPage
public Page getEnclosedPage()
Returns the currently loaded page in the enclosed window. This is a facility method forgetEnclosedWindow().getEnclosedPage()
.- Returns:
- the currently loaded page in the enclosed window, or
null
if no page has been loaded - See Also:
WebWindow.getEnclosedPage()
-
getEnclosedWindow
public FrameWindow getEnclosedWindow()
Gets the window enclosed in this frame.- Returns:
- the window enclosed in this frame
-
setSrcAttribute
public final void setSrcAttribute(java.lang.String attribute)
Sets the value of thesrc
attribute. Also loads the frame with the specified URL, if possible.- Parameters:
attribute
- the new value of thesrc
attribute
-
setAttributeNS
protected void setAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName, java.lang.String attributeValue, boolean notifyAttributeChangeListeners, boolean notifyMutationObserver)
Sets the value of the attribute specified by namespace and qualified name.- Overrides:
setAttributeNS
in classHtmlElement
- Parameters:
namespaceURI
- the URI that identifies an XML namespacequalifiedName
- the qualified name (prefix:local) of the attributeattributeValue
- the value of the attributenotifyAttributeChangeListeners
- to notify the associatedHtmlAttributeChangeListener
snotifyMutationObserver
- to notifyMutationObserver
s or not
-
setAttributeNode
public org.w3c.dom.Attr setAttributeNode(org.w3c.dom.Attr attribute)
Sets the specified attribute. This method may be overridden by subclasses which are interested in specific attribute value changes, but such methods must invokesuper.setAttributeNode()
, and should consider the value of thecloning
parameter when deciding whether or not to execute custom logic.- Specified by:
setAttributeNode
in interfaceorg.w3c.dom.Element
- Overrides:
setAttributeNode
in classHtmlElement
- Parameters:
attribute
- the attribute to set- Returns:
-
cloneNode
public DomNode cloneNode(boolean deep)
Creates a newWebWindow
for the new clone.- Specified by:
cloneNode
in interfaceorg.w3c.dom.Node
- Overrides:
cloneNode
in classHtmlElement
-
onAddedToPage
protected void onAddedToPage()
Description copied from class:DomNode
Lifecycle method invoked whenever a node is added to a page. Intended to be overridden by nodes which need to perform custom logic when they are added to a page. This method is recursive, so if you override it, please be sure to callsuper.onAddedToPage()
.- Overrides:
onAddedToPage
in classDomNode
-
remove
public void remove()
Description copied from class:DomNode
Removes this node from all relationships with other nodes.
-
removeAttribute
public final void removeAttribute(java.lang.String attributeName)
Description copied from class:HtmlElement
Removes an attribute specified by name from this element.- Specified by:
removeAttribute
in interfaceorg.w3c.dom.Element
- Overrides:
removeAttribute
in classHtmlElement
- Parameters:
attributeName
- the attribute attributeName
-
-