com.gargoylesoftware.htmlunit.javascript

Class SimpleScriptable

java.lang.Object

org.mozilla.javascript.ScriptableObject

com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

All Implemented Interfaces:

Serializable, org.mozilla.javascript.ConstProperties, org.mozilla.javascript.debug.DebuggableObject, org.mozilla.javascript.Scriptable

Direct Known Subclasses:

ActiveXObject, Attribute, BoxObject, DOMImplementation, DOMParser, Event, History, HTMLCollection, HTMLOptionsCollection, Location, MimeType, NamedNodeMap, Navigator, Node, Popup, Range, Screen, SimpleArray, Style, Stylesheet, StyleSheetList, TextRectangle, Window, XMLAttribute, XMLDOMParseError, XMLHttpRequest, XMLSerializer, XPathNSResolver, XPathResult, XSLTemplate, XSLTProcessor

public class SimpleScriptable
extends org.mozilla.javascript.ScriptableObject

A javascript object for a Location

Version:

$Revision: 2132 $

Author:

Mike Bowler, David K. Taylor, Marc Guillemot, Chris Erskine, Daniel Gredler, Ahmed Ashour

See Also:

Serialized Form

Field Summary

Fields inherited from class org.mozilla.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
SimpleScriptable()

Method Summary

Methods

Modifier and Type	Method and Description
Object	get(String name, org.mozilla.javascript.Scriptable start) Get a named property from the object.
static boolean	getBooleanArg(int index, Object[] args, boolean defaultValue) Return the boolean value at the specified location in the argument list.
String	getClassName() Return the javascript class name
Object	getDefaultValue(Class hint) Return the javascript default value of this object.
DomNode	getDomNodeOrDie() Return the DOM node that corresponds to this javascript object or throw an exception if one cannot be found.
DomNode	getDomNodeOrNull() Return the DOM node that corresponds to this javascript object or null if a node hasn't been set.
static int	getIntArg(int index, Object[] args, int defaultValue) Return the int value at the specified location in the argument list.
protected org.apache.commons.logging.Log	getLog() Return the log that is being used for all scripting objects
static Object	getObjectArg(int index, Object[] args, Object defaultValue) Return the value at the specified location in the argument list.
protected org.mozilla.javascript.Scriptable	getPrototype(Class javaScriptClass) Get the prototype object for the given host class
protected SimpleScriptable	getScriptableFor(Object object) Return the javascript object that corresponds to the specified object.
protected org.mozilla.javascript.Scriptable	getStartingScope() Gets the scriptable used at starting scope for the execution of current script.
static String	getStringArg(int index, Object[] args, String defaultValue) Return the string value at the specified location in the argument list.
protected org.apache.commons.collections.Transformer	getTransformerScriptableFor() Gets a transformer getting the scriptable element for an HtmlElement
protected Window	getWindow() Gets the window that is the top scope for this object.
protected static Window	getWindow(org.mozilla.javascript.Scriptable s) Gets the window that is the top scope for the specified object.
protected Object	getWithPreemption(String name) Called by get(String, Scriptable) to allow retrieval of the property before the prototype chain is searched.
SimpleScriptable	makeScriptableFor(DomNode domNode) Builds a new the javascript object that corresponds to the specified object.
void	setDomNode(DomNode domNode) Set the DOM node that corresponds to this javascript object
protected void	setDomNode(DomNode domNode, boolean assignScriptObject) Set the DOM node that corresponds to this javascript object
void	setHtmlElement(HtmlElement htmlElement) Set the html element that corresponds to this javascript object

Methods inherited from class org.mozilla.javascript.ScriptableObject

associateValue, callMethod, callMethod, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, equivalentValues, get, getAllIds, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, has, has, hasInstance, hasProperty, hasProperty, isConst, isSealed, put, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setGetterOrSetter, setParentScope, setPrototype

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimpleScriptable

public SimpleScriptable()

Method Detail

get

public Object get(String name,
         org.mozilla.javascript.Scriptable start)

Get a named property from the object. Normally HtmlUnit objects don't need to overwrite this method as properties are defined on the prototypes from the xml configuration. In some cases where "content" of object has priority compared to the properties consider using utility getWithPreemption(String). For fallback case just implement ScriptableWithFallbackGetter.

Specified by:

get in interface org.mozilla.javascript.Scriptable

Overrides:

get in class org.mozilla.javascript.ScriptableObject

getWithPreemption

protected Object getWithPreemption(String name)

Called by get(String, Scriptable) to allow retrieval of the property before the prototype chain is searched.

IMPORTANT: This method is invoked *very* often by Rhino. If you override this method, the implementation needs to be as fast as possible!

Parameters:

name - the property name

Returns:

Scriptable.NOT_FOUND if not found

getClassName

public String getClassName()

Return the javascript class name

Specified by:

getClassName in interface org.mozilla.javascript.Scriptable

Specified by:

getClassName in class org.mozilla.javascript.ScriptableObject

Returns:

The javascript class name

getDomNodeOrDie

public final DomNode getDomNodeOrDie()
                              throws IllegalStateException

Return the DOM node that corresponds to this javascript object or throw an exception if one cannot be found.

Returns:

The DOM node

Throws:

IllegalStateException - If the DOM node could not be found.

getDomNodeOrNull

public final DomNode getDomNodeOrNull()

Return the DOM node that corresponds to this javascript object or null if a node hasn't been set.

Returns:

The DOM node or null

setDomNode

public void setDomNode(DomNode domNode)

Set the DOM node that corresponds to this javascript object

Parameters:

domNode - The DOM node

setDomNode

protected void setDomNode(DomNode domNode,
              boolean assignScriptObject)

Set the DOM node that corresponds to this javascript object

Parameters:

domNode - The DOM node

assignScriptObject - If true, call setScriptObject on domNode

setHtmlElement

public void setHtmlElement(HtmlElement htmlElement)

Set the html element that corresponds to this javascript object

Parameters:

htmlElement - The html element

getLog

protected final org.apache.commons.logging.Log getLog()

Return the log that is being used for all scripting objects

Returns:

The log.

getScriptableFor

protected SimpleScriptable getScriptableFor(Object object)

Return the javascript object that corresponds to the specified object. New javascript objects will be created as needed. If a javascript object cannot be created for a domNode then NOT_FOUND will be returned.

Parameters:

object - a DomNode or a WebWindow

Returns:

The javascript object or NOT_FOUND

makeScriptableFor

public SimpleScriptable makeScriptableFor(DomNode domNode)

Builds a new the javascript object that corresponds to the specified object.

Parameters:

domNode - the dom node for which a JS object should be created

Returns:

The javascript object

getPrototype

protected org.mozilla.javascript.Scriptable getPrototype(Class javaScriptClass)

Get the prototype object for the given host class

Parameters:

javaScriptClass - the host class

Returns:

the prototype

getTransformerScriptableFor

protected org.apache.commons.collections.Transformer getTransformerScriptableFor()

Gets a transformer getting the scriptable element for an HtmlElement

Returns:

the transformer.

getObjectArg

public static Object getObjectArg(int index,
                  Object[] args,
                  Object defaultValue)

Return the value at the specified location in the argument list. If the index is larger than the argument array then return the default value.

Parameters:

index - The index into the argument list.

args - The argument list.

defaultValue - The default value to return if the arg wasn't specified.

Returns:

The specified object or null

getStringArg

public static String getStringArg(int index,
                  Object[] args,
                  String defaultValue)

Return the string value at the specified location in the argument list. If the index is larger than the argument array then return the default value.

Parameters:

index - The index into the argument list.

args - The argument list.

defaultValue - The default value to return if the arg wasn't specified.

Returns:

The specified string or null

getBooleanArg

public static boolean getBooleanArg(int index,
                    Object[] args,
                    boolean defaultValue)

Return the boolean value at the specified location in the argument list. If the index is larger than the argument array then return the default value.

Parameters:

index - The index into the argument list.

args - The argument list.

defaultValue - The default value to be used.

Returns:

The specified boolean or the default value.

getIntArg

public static int getIntArg(int index,
            Object[] args,
            int defaultValue)

Return the int value at the specified location in the argument list. If the index is larger than the argument array then return the default value.

Parameters:

index - The index into the argument list.

args - The argument list.

defaultValue - The default value to be used.

Returns:

The specified int or the default value.

getDefaultValue

public Object getDefaultValue(Class hint)

Return the javascript default value of this object. This is the javascript equivalent of a toString() in java.

Specified by:

getDefaultValue in interface org.mozilla.javascript.Scriptable

Overrides:

getDefaultValue in class org.mozilla.javascript.ScriptableObject

Parameters:

hint - A hint as to the format of the default value. Ignored in this case.

Returns:

The default value.

getWindow

protected Window getWindow()
                    throws RuntimeException

Gets the window that is the top scope for this object.

Returns:

The window associated with this object.

Throws:

RuntimeException - If the window cannot be found, which should never occur.

getWindow

protected static Window getWindow(org.mozilla.javascript.Scriptable s)
                           throws RuntimeException

Gets the window that is the top scope for the specified object.

Parameters:

s - The JavaScript object whose associated window is to be returned.

Returns:

The window associated with the specified JavaScript object.

Throws:

RuntimeException - If the window cannot be found, which should never occur.

getStartingScope

protected org.mozilla.javascript.Scriptable getStartingScope()

Gets the scriptable used at starting scope for the execution of current script.

Returns:

the scope as defined in JavaScriptEngine.callFunction(com.gargoylesoftware.htmlunit.html.HtmlPage, java.lang.Object, java.lang.Object, java.lang.Object[], com.gargoylesoftware.htmlunit.html.DomNode) or JavaScriptEngine.execute(com.gargoylesoftware.htmlunit.html.HtmlPage, java.lang.String, java.lang.String, int).