com.gargoylesoftware.htmlunit.javascript.host

Class Range

java.lang.Object

org.mozilla.javascript.ScriptableObject

com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

com.gargoylesoftware.htmlunit.javascript.host.Range

All Implemented Interfaces:

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

public class Range
extends SimpleScriptable

The javascript object that represents a Range.

Version:

$Revision: 2155 $

Author:

Marc Guillemot

See Also:

XULPlanet, DOM-Level-2-Traversal-Range, 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
Range() Create an instance.

Method Summary

Methods

Modifier and Type	Method and Description
protected List	getAncestorsAndSelf(Node node) Gets the ancestors of the node
void	jsxFunction_collapse(boolean toStart) Collapse a Range onto one of its boundary-points
Object	jsxFunction_createContextualFragment(String fragment) Parses an html snippet.
void	jsxFunction_selectNode(Node refNode) Select a node and its contents
void	jsxFunction_selectNodeContents(Node refNode) Select the contents within a node
void	jsxFunction_setEnd(Node refNode, int offset) Sets the attributes describing the end of a Range.
void	jsxFunction_setEndAfter(Node refNode) Sets the end of the range to be after the node
void	jsxFunction_setEndBefore(Node refNode) Sets the end of the range to be before the node
void	jsxFunction_setStart(Node refNode, int offset) Sets the attributes describing the start of a Range.
void	jsxFunction_setStartAfter(Node refNode) Sets the start of the range to be after the node
void	jsxFunction_setStartBefore(Node refNode) Sets the start of the range to be before the node
boolean	jsxGet_collapsed() Indicates if the range is collapsed
Object	jsxGet_commonAncestorContainer() Gets the deepest common ancestor container of the Range's two boundary-points.
Object	jsxGet_endContainer() Gets the node within which the Range ends.
int	jsxGet_endOffset() Gets the offset within the end node of the Range.
Object	jsxGet_startContainer() Gets the node within which the Range begins.
int	jsxGet_startOffset() Gets the offset within the starting node of the Range.

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

get, getBooleanArg, getClassName, getDefaultValue, 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, toString, wait, wait, wait

Constructor Detail

Range

public Range()

Create an instance.

Method Detail

jsxGet_startContainer

public Object jsxGet_startContainer()

Gets the node within which the Range begins.

Returns:

undefined if not initialized

jsxGet_endContainer

public Object jsxGet_endContainer()

Gets the node within which the Range ends.

Returns:

undefined if not initialized

jsxGet_startOffset

public int jsxGet_startOffset()

Gets the offset within the starting node of the Range.

Returns:

0 if not initialized

jsxGet_endOffset

public int jsxGet_endOffset()

Gets the offset within the end node of the Range.

Returns:

0 if not initialized

jsxFunction_setStart

public void jsxFunction_setStart(Node refNode,
                        int offset)

Sets the attributes describing the start of a Range.

Parameters:

refNode - the reference node

offset - the offset value within the node

jsxFunction_setStartAfter

public void jsxFunction_setStartAfter(Node refNode)

Sets the start of the range to be after the node

Parameters:

refNode - the reference node

jsxFunction_setStartBefore

public void jsxFunction_setStartBefore(Node refNode)

Sets the start of the range to be before the node

Parameters:

refNode - the reference node

jsxGet_collapsed

public boolean jsxGet_collapsed()

Indicates if the range is collapsed

Returns:

true if the range is collapsed

jsxFunction_setEnd

public void jsxFunction_setEnd(Node refNode,
                      int offset)

Sets the attributes describing the end of a Range.

Parameters:

refNode - the reference node

offset - the offset value within the node

jsxFunction_setEndAfter

public void jsxFunction_setEndAfter(Node refNode)

Sets the end of the range to be after the node

Parameters:

refNode - the reference node

jsxFunction_setEndBefore

public void jsxFunction_setEndBefore(Node refNode)

Sets the end of the range to be before the node

Parameters:

refNode - the reference node

jsxFunction_selectNodeContents

public void jsxFunction_selectNodeContents(Node refNode)

Select the contents within a node

Parameters:

refNode - Node to select from

jsxFunction_selectNode

public void jsxFunction_selectNode(Node refNode)

Select a node and its contents

Parameters:

refNode - the node to select

jsxFunction_collapse

public void jsxFunction_collapse(boolean toStart)

Collapse a Range onto one of its boundary-points

Parameters:

toStart - If true, collapses the Range onto its start; else collapses it onto its end.

jsxGet_commonAncestorContainer

public Object jsxGet_commonAncestorContainer()

Gets the deepest common ancestor container of the Range's two boundary-points.

Returns:

the ancestor

getAncestorsAndSelf

protected List getAncestorsAndSelf(Node node)

Gets the ancestors of the node

Parameters:

node - the node to start with

Returns:

a list of node

jsxFunction_createContextualFragment

public Object jsxFunction_createContextualFragment(String fragment)

Parses an html snippet.

Parameters:

fragment - text that contains text and tags to be converted to a document fragment.

Returns:

a document fragment

See Also:

Mozilla documentation