com.gargoylesoftware.htmlunit.javascript.host

Class Location

java.lang.Object

org.mozilla.javascript.ScriptableObject

com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

com.gargoylesoftware.htmlunit.javascript.host.Location

All Implemented Interfaces:

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

public class Location
extends SimpleScriptable

A JavaScript object for a Location.

Version:

$Revision: 2132 $

Author:

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

See Also:

MSDN Documentation, 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
Location() Creates an instance.

Method Summary

Methods

Modifier and Type	Method and Description
Object	getDefaultValue(Class hint) Return the javascript default value of this object.
void	initialize(Window window) Initializes the object.
void	jsxFunction_assign(String url) Loads the new HTML document corresponding to the specified URL.
void	jsxFunction_reload(boolean force) Reloads the current page, possibly forcing retrieval from the server even if the browser cache contains the latest version of the document.
void	jsxFunction_replace(String url) Reloads the window using the specified URL.
String	jsxFunction_toString() Returns the location URL.
String	jsxGet_hash() Returns the hash portion of the location URL (the portion following the '#').
String	jsxGet_host() Returns the host portion of the location URL (the '[hostname]:[port]' portion).
String	jsxGet_hostname() Returns the hostname portion of the location URL.
String	jsxGet_href() Returns the location URL.
String	jsxGet_pathname() Returns the pathname portion of the location URL.
String	jsxGet_port() Returns the port portion of the location URL.
String	jsxGet_protocol() Returns the protocol portion of the location URL, including the trailing ':'.
String	jsxGet_search() Returns the search portion of the location URL (the portion following the '?').
void	jsxSet_hash(String hash) Sets the hash portion of the location URL (the portion following the '#').
void	jsxSet_host(String host) Sets the host portion of the location URL (the '[hostname]:[port]' portion).
void	jsxSet_hostname(String hostname) Sets the hostname portion of the location URL.
void	jsxSet_href(String newLocation) Set the location URL to an entirely new value.
void	jsxSet_pathname(String pathname) Sets the pathname portion of the location URL.
void	jsxSet_port(String port) Sets the port portion of the location URL.
void	jsxSet_protocol(String protocol) Sets the protocol portion of the location URL.
void	jsxSet_search(String search) Sets the search portion of the location URL (the portion following the '?').
String	toString() Returns the string value of the location, which is the full URL string.

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

get, getBooleanArg, getClassName, getDomNodeOrDie, getDomNodeOrNull, getIntArg, getLog, getObjectArg, getPrototype, getScriptableFor, getStartingScope, getStringArg, getTransformerScriptableFor, getWindow, getWindow, getWithPreemption, makeScriptableFor, setDomNode, setDomNode, setHtmlElement

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, wait, wait, wait

Constructor Detail

Location

public Location()

Creates an instance. JavaScript objects must have a default constructor.

Method Detail

initialize

public void initialize(Window window)

Initializes the object.

Parameters:

window - The window that this location belongs to.

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 SimpleScriptable

Parameters:

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

Returns:

The default value.

toString

public String toString()

Returns the string value of the location, which is the full URL string.

Overrides:

toString in class Object

Returns:

The full URL string.

jsxFunction_assign

public void jsxFunction_assign(String url)
                        throws IOException

Loads the new HTML document corresponding to the specified URL.

Parameters:

url - The location of the new HTML document to load.

Throws:

IOException - If loading the specified location fails.

See Also:

MSDN Documentation

jsxFunction_reload

public void jsxFunction_reload(boolean force)
                        throws IOException

Reloads the current page, possibly forcing retrieval from the server even if the browser cache contains the latest version of the document.

Parameters:

force - If true, force reload from server; otherwise, may reload from cache.

Throws:

IOException - When there is a problem reloading the page.

See Also:

MSDN Documentation

jsxFunction_replace

public void jsxFunction_replace(String url)
                         throws IOException

Reloads the window using the specified URL.

Parameters:

url - The new URL to use to reload the window.

Throws:

IOException - When there is a problem loading the new page.

See Also:

MSDN Documentation

jsxFunction_toString

public String jsxFunction_toString()

Returns the location URL.

Returns:

the location URL.

jsxGet_href

public String jsxGet_href()

Returns the location URL.

Returns:

The location URL.

See Also:

MSDN Documentation

jsxSet_href

public void jsxSet_href(String newLocation)
                 throws IOException

Set the location URL to an entirely new value.

Parameters:

newLocation - The new location URL.

Throws:

IOException - If loading the specified location fails.

See Also:

MSDN Documentation

jsxGet_search

public String jsxGet_search()

Returns the search portion of the location URL (the portion following the '?').

Returns:

The search portion of the location URL.

See Also:

MSDN Documentation

jsxSet_search

public void jsxSet_search(String search)
                   throws Exception

Sets the search portion of the location URL (the portion following the '?').

Parameters:

search - The new search portion of the location URL.

Throws:

Exception - If an error occurs.

See Also:

MSDN Documentation

jsxGet_hash

public String jsxGet_hash()

Returns the hash portion of the location URL (the portion following the '#').

Returns:

The hash portion of the location URL.

See Also:

MSDN Documentation

jsxSet_hash

public void jsxSet_hash(String hash)
                 throws Exception

Sets the hash portion of the location URL (the portion following the '#').

Parameters:

hash - The new hash portion of the location URL.

Throws:

Exception - If an error occurs.

See Also:

MSDN Documentation

jsxGet_hostname

public String jsxGet_hostname()

Returns the hostname portion of the location URL.

Returns:

The hostname portion of the location URL.

See Also:

MSDN Documentation

jsxSet_hostname

public void jsxSet_hostname(String hostname)
                     throws Exception

Sets the hostname portion of the location URL.

Parameters:

hostname - The new hostname portion of the location URL.

Throws:

Exception - If an error occurs.

See Also:

MSDN Documentation

jsxGet_host

public String jsxGet_host()

Returns the host portion of the location URL (the '[hostname]:[port]' portion).

Returns:

The host portion of the location URL.

See Also:

MSDN Documentation

jsxSet_host

public void jsxSet_host(String host)
                 throws Exception

Sets the host portion of the location URL (the '[hostname]:[port]' portion).

Parameters:

host - The new host portion of the location URL.

Throws:

Exception - If an error occurs.

See Also:

MSDN Documentation

jsxGet_pathname

public String jsxGet_pathname()

Returns the pathname portion of the location URL.

Returns:

The pathname portion of the location URL.

See Also:

MSDN Documentation

jsxSet_pathname

public void jsxSet_pathname(String pathname)
                     throws Exception

Sets the pathname portion of the location URL.

Parameters:

pathname - The new pathname portion of the location URL.

Throws:

Exception - If an error occurs.

See Also:

MSDN Documentation

jsxGet_port

public String jsxGet_port()

Returns the port portion of the location URL.

Returns:

The port portion of the location URL.

See Also:

MSDN Documentation

jsxSet_port

public void jsxSet_port(String port)
                 throws Exception

Sets the port portion of the location URL.

Parameters:

port - The new port portion of the location URL.

Throws:

Exception - If an error occurs.

See Also:

MSDN Documentation

jsxGet_protocol

public String jsxGet_protocol()

Returns the protocol portion of the location URL, including the trailing ':'.

Returns:

The protocol portion of the location URL, including the trailing ':'.

See Also:

MSDN Documentation

jsxSet_protocol

public void jsxSet_protocol(String protocol)
                     throws Exception

Sets the protocol portion of the location URL.

Parameters:

protocol - The new protocol portion of the location URL.

Throws:

Exception - If an error occurs.

See Also:

MSDN Documentation