com.gargoylesoftware.htmlunit.javascript.host
Class Selection

java.lang.Object
  net.sourceforge.htmlunit.corejs.javascript.ScriptableObject
      com.gargoylesoftware.htmlunit.javascript.SimpleScriptable
          com.gargoylesoftware.htmlunit.javascript.host.Selection

All Implemented Interfaces:

Serializable, Cloneable, net.sourceforge.htmlunit.corejs.javascript.ConstProperties, net.sourceforge.htmlunit.corejs.javascript.debug.DebuggableObject, net.sourceforge.htmlunit.corejs.javascript.Scriptable

public class Selection
extends SimpleScriptable

A JavaScript object for a Selection.

Version:

$Revision: 7582 $

Author:

Ahmed Ashour, Daniel Gredler

See Also:

MSDN Documentation, Gecko DOM Reference, Serialized Form

Field Summary

Fields inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface net.sourceforge.htmlunit.corejs.javascript.Scriptable

NOT_FOUND

Constructor Summary

Selection()

Method Summary

void	addRange(Range range) Adds a range to the selection.
void	collapse(Node parentNode, int offset) Collapses the current selection to a single point.
void	collapseToEnd() Moves the anchor of the selection to the same point as the focus.
void	collapseToStart() Moves the focus of the selection to the same point at the anchor.
TextRange	createRange() Creates a TextRange object from the current text selection (IE only).
void	empty() Cancels the current selection, sets the selection type to none, and sets the item property to null (IE only).
void	extend(Node parentNode, int offset) Moves the focus of the selection to a specified point.
Node	getAnchorNode() Returns the node in which the selection begins.
int	getAnchorOffset() Returns the number of characters that the selection's anchor is offset within the anchor node.
Object	getDefaultValue(Class<?> hint) Returns the JavaScript default value of this object.
Node	getFocusNode() Returns the node in which the selection ends.
int	getFocusOffset() Returns the number of characters that the selection's focus is offset within the focus node.
boolean	getIsCollapsed() Returns a boolean indicating whether the selection's start and end points are at the same position.
Range	getRangeAt(int index) Returns the range at the specified index.
int	getRangeCount() Returns the number of ranges in the selection.
String	getType() Returns the type of selection (IE only).
void	removeAllRanges() Removes all ranges from the selection.
void	removeRange(Range range) Removes a range from the selection.
void	selectAllChildren(Node parentNode) Adds all the children of the specified node to the selection.

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

clone, defineFunctionProperties, defineProperty, equivalentValues, get, getBrowserVersion, getClassName, getDomNodeOrDie, getDomNodeOrNull, getPrototype, getScriptableFor, getStartingScope, getTransformerScriptableFor, getWindow, getWindow, getWithPreemption, hasInstance, initParentScope, isReadOnlySettable, makeScriptableFor, setCaseSensitive, setDomNode, setDomNode, setHtmlElement

Methods inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getSlot, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setGetterOrSetter, setParentScope, setPrototype, size

Methods inherited from class java.lang.Object

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

Constructor Detail

Selection

public Selection()

Method Detail

getDefaultValue

public Object getDefaultValue(Class<?> hint)

Returns the JavaScript default value of this object. This is the JavaScript equivalent of a toString() in Java.

Specified by:

getDefaultValue in interface net.sourceforge.htmlunit.corejs.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

getAnchorNode

public Node getAnchorNode()

Returns the node in which the selection begins.

Returns:

the node in which the selection begins

getAnchorOffset

public int getAnchorOffset()

Returns the number of characters that the selection's anchor is offset within the anchor node.

Returns:

the number of characters that the selection's anchor is offset within the anchor node

getFocusNode

public Node getFocusNode()

Returns the node in which the selection ends.

Returns:

the node in which the selection ends

getFocusOffset

public int getFocusOffset()

Returns the number of characters that the selection's focus is offset within the focus node.

Returns:

the number of characters that the selection's focus is offset within the focus node

getIsCollapsed

public boolean getIsCollapsed()

Returns a boolean indicating whether the selection's start and end points are at the same position.

Returns:

a boolean indicating whether the selection's start and end points are at the same position

getRangeCount

public int getRangeCount()

Returns the number of ranges in the selection.

Returns:

the number of ranges in the selection

getType

public String getType()

Returns the type of selection (IE only).

Returns:

the type of selection

createRange

public TextRange createRange()

Creates a TextRange object from the current text selection (IE only).

Returns:

the created TextRange object

addRange

public void addRange(Range range)

Adds a range to the selection.

Parameters:

range - the range to add

removeRange

public void removeRange(Range range)

Removes a range from the selection.

Parameters:

range - the range to remove

removeAllRanges

public void removeAllRanges()

Removes all ranges from the selection.

getRangeAt

public Range getRangeAt(int index)

Returns the range at the specified index.

Parameters:

index - the index of the range to return

Returns:

the range at the specified index

collapse

public void collapse(Node parentNode,
                     int offset)

Collapses the current selection to a single point. The document is not modified.

Parameters:

parentNode - the caret location will be within this node

offset - the caret will be placed this number of characters from the beginning of the parentNode's text

collapseToEnd

public void collapseToEnd()

Moves the anchor of the selection to the same point as the focus. The focus does not move.

collapseToStart

public void collapseToStart()

Moves the focus of the selection to the same point at the anchor. The anchor does not move.

empty

public void empty()

Cancels the current selection, sets the selection type to none, and sets the item property to null (IE only).

extend

public void extend(Node parentNode,
                   int offset)

Moves the focus of the selection to a specified point. The anchor of the selection does not move.

Parameters:

parentNode - the node within which the focus will be moved

offset - the number of characters from the beginning of parentNode's text the focus will be placed

selectAllChildren

public void selectAllChildren(Node parentNode)

Adds all the children of the specified node to the selection. The previous selection is lost.

Parameters:

parentNode - all children of parentNode will be selected; parentNode itself is not part of the selection