com.gargoylesoftware.htmlunit.html

Class HtmlScript

java.lang.Object

com.gargoylesoftware.htmlunit.html.DomNode

com.gargoylesoftware.htmlunit.html.DomNamespaceNode

com.gargoylesoftware.htmlunit.html.DomElement

com.gargoylesoftware.htmlunit.html.HtmlElement

com.gargoylesoftware.htmlunit.html.HtmlScript

All Implemented Interfaces:

ScriptElement, Serializable, Cloneable, Element, Node

public class HtmlScript
extends HtmlElement
implements ScriptElement

Wrapper for the HTML element "script".
When a script tag references an external script (with attribute src) it gets executed when the node is added to the DOM tree. When the script code is nested, it gets executed when the text node containing the script is added to the HtmlScript.
The ScriptFilter feature of NekoHtml can't be used because it doesn't allow immediate access to the DOM (i.e. document.write("<span id='mySpan'/>"); document.getElementById("mySpan").tagName; can't work with a filter).

Author:

Mike Bowler, Christian Sell, Marc Guillemot, David K. Taylor, Ahmed Ashour, Daniel Gredler, Dmitri Zoubkov, Sudhan Moghe, Ronald Brill, Daniel Wagner-Hall, Frank Danek

See Also:

DOM Level 1, DOM Level 2, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.gargoylesoftware.htmlunit.html.HtmlElement

HtmlElement.DisplayStyle

Nested classes/interfaces inherited from class com.gargoylesoftware.htmlunit.html.DomElement

DomElement.ChildElementsIterator

Nested classes/interfaces inherited from class com.gargoylesoftware.htmlunit.html.DomNode

DomNode.ChildIterator, DomNode.DescendantElementsIterator<T extends DomNode>

Field Summary

Fields

Modifier and Type	Field and Description
static String	TAG_NAME The HTML tag represented by this element.

Fields inherited from class com.gargoylesoftware.htmlunit.html.HtmlElement

TAB_INDEX_OUT_OF_BOUNDS

Fields inherited from class com.gargoylesoftware.htmlunit.html.DomElement

ATTRIBUTE_NOT_DEFINED, ATTRIBUTE_VALUE_EMPTY

Fields inherited from class com.gargoylesoftware.htmlunit.html.DomNode

AS_TEXT_BLANK, AS_TEXT_BLOCK_SEPARATOR, AS_TEXT_NEW_LINE, AS_TEXT_TAB, 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

Method Summary

Modifier and Type	Method and Description
String	asText() Returns a textual representation of this element that represents what would be visible to the user if this page was shown in a web browser.
void	executeScriptIfNeeded() INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK. Executes this script node if necessary and/or possible.
Charset	getCharset() Deprecated. as of 2.27, not used
String	getCharsetAttribute() Returns the value of the attribute charset.
HtmlElement.DisplayStyle	getDefaultStyleDisplay() INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK. Returns the default display style.
String	getDeferAttribute() Returns the value of the attribute defer.
String	getEventAttribute() Returns the value of the attribute event.
String	getHtmlForAttribute() Returns the value of the attribute for.
String	getLanguageAttribute() Returns the value of the attribute language.
String	getSrcAttribute() Returns the value of the attribute src.
String	getTypeAttribute() Returns the value of the attribute type.
protected boolean	isDeferred() Returns true if this script is deferred.
protected boolean	isEmptyXmlTagExpanded() Indicates if a node without children should be written in expanded form as XML (i.e.
boolean	isExecuted() Returns if executed.
void	markAsCreatedByJavascript() INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK. Marks this frame as created by javascript.
boolean	mayBeDisplayed() Returns true if nodes of this type can ever be displayed, false otherwise.
protected void	onAllChildrenAddedToPage(boolean postponed) Executes the onreadystatechange handler when simulating IE, as well as executing the script itself, if necessary.
protected void	printChildrenAsXml(String indent, PrintWriter printWriter) Recursively writes the XML data for the node tree starting at node.
void	processImportNode(Document doc) INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK. Lifecycle method to support special processing for js method importNode.
void	resetExecuted() INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK. Resets the executed flag.
protected void	setAndExecuteReadyState(String state) Sets the readyState to the specified state and executes the onreadystatechange handler when simulating IE.
protected void	setAttributeNS(String namespaceURI, String qualifiedName, String attributeValue, boolean notifyAttributeChangeListeners, boolean notifyMutationObservers) If setting the src attribute, this method executes the new JavaScript if necessary (behavior varies by browser version).
void	setExecuted(boolean executed) Sets if executed.
String	toString() Returns a string representation of this object.
boolean	wasCreatedByJavascript() INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK. Returns true if this frame was created by javascript.

Methods inherited from class com.gargoylesoftware.htmlunit.html.HtmlElement

acceptChar, addHtmlAttributeChangeListener, appendChildIfNoneExists, checkChildHierarchy, detach, doType, doType, fireHtmlAttributeAdded, fireHtmlAttributeRemoved, fireHtmlAttributeReplaced, getCanonicalXPath, 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, isRequired, isRequiredSupported, isShiftPressed, isSubmittableByEnter, isValid, notifyAttributeChangeListeners, removeAttribute, removeChild, removeHtmlAttributeChangeListener, setAttributeNode, setRequired, type, type, type, type, typeDone

Methods inherited from class com.gargoylesoftware.htmlunit.html.DomElement

blur, click, click, click, click, cloneNode, dblClick, dblClick, doClickFireChangeEvent, doClickFireClickEvent, doClickStateUpdate, fireEvent, fireEvent, focus, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributesMap, getChildElementCount, getChildElements, getElementsByTagName, getElementsByTagNameNS, getEventTargetElement, getFirstElementChild, getId, getLastElementChild, getNodeType, getSchemaTypeInfo, getStyleElement, getStyleElementCaseInSensitive, getStyleMap, getTagName, hasAttribute, hasAttributeNS, hasAttributes, 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, setId, setIdAttribute, setIdAttributeNode, setIdAttributeNS, writeStyleToElement

Methods inherited from class com.gargoylesoftware.htmlunit.html.DomNamespaceNode

getLocalName, getNamespaceURI, getPrefix, getQualifiedName, setPrefix

Methods inherited from class com.gargoylesoftware.htmlunit.html.DomNode

addCharacterDataChangeListener, addDomChangeListener, appendChild, asXml, basicRemove, 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, hasChildNodes, hasFeature, insertBefore, insertBefore, isAncestorOf, isAncestorOfAny, isAttachedToPage, isDefaultNamespace, isEqualNode, isSameNode, isSupported, isTrimmedText, lookupNamespaceURI, lookupPrefix, normalize, notifyIncorrectness, onAddedToDocumentFragment, onAddedToPage, querySelector, querySelectorAll, remove, removeAllChildren, removeCharacterDataChangeListener, removeChild, removeDomChangeListener, replace, replaceChild, setNextSibling, setNodeValue, setParentNode, setPreviousSibling, setReadyState, setScriptableObject, 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, setNodeValue, setPrefix, setTextContent, setUserData

Field Detail

TAG_NAME

public static final String TAG_NAME

The HTML tag represented by this element.

See Also:

Constant Field Values

Method Detail

getCharsetAttribute

public final String getCharsetAttribute()

Returns the value of the attribute charset. Refer to the HTML 4.01 documentation for details on the use of this attribute.

Specified by:

getCharsetAttribute in interface ScriptElement

Returns:

the value of the attribute charset or an empty string if that attribute isn't defined.

getCharset

@Deprecated
public final Charset getCharset()

Deprecated. as of 2.27, not used

Returns the Charset.

Specified by:

getCharset in interface ScriptElement

Returns:

the Charset

getTypeAttribute

public final String getTypeAttribute()

Returns the value of the attribute type. Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

the value of the attribute type or an empty string if that attribute isn't defined.

getLanguageAttribute

public final String getLanguageAttribute()

Returns the value of the attribute language. Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

the value of the attribute language or an empty string if that attribute isn't defined.

getSrcAttribute

public final String getSrcAttribute()

Returns the value of the attribute src. Refer to the HTML 4.01 documentation for details on the use of this attribute.

Specified by:

getSrcAttribute in interface ScriptElement

Returns:

the value of the attribute src or an empty string if that attribute isn't defined.

getEventAttribute

public final String getEventAttribute()

Returns the value of the attribute event.

Returns:

the value of the attribute event

getHtmlForAttribute

public final String getHtmlForAttribute()

Returns the value of the attribute for.

Returns:

the value of the attribute for

getDeferAttribute

public final String getDeferAttribute()

Returns the value of the attribute defer. Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

the value of the attribute defer or an empty string if that attribute isn't defined.

isDeferred

protected boolean isDeferred()

Returns true if this script is deferred.

Returns:

true if this script is deferred

mayBeDisplayed

public boolean mayBeDisplayed()

Returns true if nodes of this type can ever be displayed, false otherwise. Examples of nodes that can never be displayed are <head>, <meta>, <script>, etc.

Overrides:

mayBeDisplayed in class DomNode

Returns:

true if nodes of this type can ever be displayed, false otherwise

See Also:

DomNode.isDisplayed()

setAttributeNS

protected void setAttributeNS(String namespaceURI,
                              String qualifiedName,
                              String attributeValue,
                              boolean notifyAttributeChangeListeners,
                              boolean notifyMutationObservers)

If setting the src attribute, this method executes the new JavaScript if necessary (behavior varies by browser version). Sets the value of the attribute specified by namespace and qualified name.

Overrides:

setAttributeNS in class HtmlElement

Parameters:

namespaceURI - the URI that identifies an XML namespace

qualifiedName - the qualified name (prefix:local) of the attribute

attributeValue - the value of the attribute

notifyAttributeChangeListeners - to notify the associated HtmlAttributeChangeListeners

notifyMutationObservers - to notify MutationObservers or not

onAllChildrenAddedToPage

protected void onAllChildrenAddedToPage(boolean postponed)

Executes the onreadystatechange handler when simulating IE, as well as executing the script itself, if necessary. Lifecycle method invoked after a node and all its children have been added to a page, during parsing of the HTML. Intended to be overridden by nodes which need to perform custom logic after they and all their child nodes have been processed by the HTML parser. This method is not recursive, and the default implementation is empty, so there is no need to call super.onAllChildrenAddedToPage() if you implement this method.

Overrides:

onAllChildrenAddedToPage in class DomNode

Parameters:

postponed - whether to use PostponedAction or no

executeScriptIfNeeded

public void executeScriptIfNeeded()

INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
Executes this script node if necessary and/or possible.

setAndExecuteReadyState

protected void setAndExecuteReadyState(String state)

Sets the readyState to the specified state and executes the onreadystatechange handler when simulating IE.

Parameters:

state - this script ready state

asText

public String asText()

Description copied from class: DomNode

Returns a textual representation of this element that represents what would be visible to the user if this page was shown in a web browser. For example, a single-selection select element would return the currently selected value as text.

Overrides:

asText in class DomNode

Returns:

an empty string as the content of script is not visible by itself

See Also:

DomNode.asText()

isEmptyXmlTagExpanded

protected boolean isEmptyXmlTagExpanded()

Indicates if a node without children should be written in expanded form as XML (i.e. with closing tag rather than with "/>")

Overrides:

isEmptyXmlTagExpanded in class DomElement

Returns:

true to make generated XML readable as HTML

printChildrenAsXml

protected void printChildrenAsXml(String indent,
                                  PrintWriter printWriter)

Recursively writes the XML data for the node tree starting at node.

Overrides:

printChildrenAsXml in class DomNode

Parameters:

indent - white space to indent child nodes

printWriter - writer where child nodes are written

resetExecuted

public void resetExecuted()

INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
Resets the executed flag.

See Also:

processImportNode(Document)

processImportNode

public void processImportNode(Document doc)

Description copied from class: DomNamespaceNode

INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
Lifecycle method to support special processing for js method importNode.

Overrides:

processImportNode in class DomNamespaceNode

Parameters:

doc - the import target document

See Also:

Document.importNode( com.gargoylesoftware.htmlunit.javascript.host.dom.Node, boolean), processImportNode(com.gargoylesoftware.htmlunit.javascript.host.dom.Document)

toString

public String toString()

Returns a string representation of this object.

Overrides:

toString in class DomElement

Returns:

a string representation of this object

getDefaultStyleDisplay

public HtmlElement.DisplayStyle getDefaultStyleDisplay()

INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
Returns the default display style.

Overrides:

getDefaultStyleDisplay in class HtmlElement

Returns:

the default display style

markAsCreatedByJavascript

public void markAsCreatedByJavascript()

INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
Marks this frame as created by javascript. This is needed to handle some special IE behavior.

wasCreatedByJavascript

public boolean wasCreatedByJavascript()

INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
Returns true if this frame was created by javascript. This is needed to handle some special IE behavior.

Returns:

true or false

isExecuted

public boolean isExecuted()

Returns if executed.

Specified by:

isExecuted in interface ScriptElement

Returns:

if executed

setExecuted

public void setExecuted(boolean executed)

Sets if executed.

Specified by:

setExecuted in interface ScriptElement

Parameters:

executed - if executed