org.xwiki.gwt.dom.client.internal.mozilla
Class NativeSelection

java.lang.Object
  com.google.gwt.core.client.JavaScriptObject
      org.xwiki.gwt.dom.client.JavaScriptObject
          org.xwiki.gwt.dom.client.internal.mozilla.NativeSelection

public final class NativeSelection
extends JavaScriptObject

The native selection implementation provided by Mozilla.

Version:

$Id: NativeSelection.java 20039 2009-05-16 12:04:30Z sdumitriu $

Constructor Summary

protected

NativeSelection() Default constructor.

Method Summary

void	addRange(NativeRange range) Adds a range to this selection.
void	collapse(com.google.gwt.dom.client.Node parentNode, int offset) Collapses the selection to a single point, at the specified offset in the given DOM node.
void	collapseToEnd() Collapses the whole selection to a single point at the end of the current selection (irrespective of direction).
void	collapseToStart() Collapses the whole selection to a single point at the start of the current selection (irrespective of direction).
boolean	containsNode(com.google.gwt.dom.client.Node node, boolean partlyContained) Indicates whether the given node is part of the selection.
void	deleteFromDocument() Deletes this selection from document the nodes belong to.
void	extend(com.google.gwt.dom.client.Node parentNode, int offset) Extends the selection by moving the selection end to the specified node and offset, preserving the selection begin position.
com.google.gwt.dom.client.Node	getAnchorNode()
int	getAnchorOffset()
com.google.gwt.dom.client.Node	getFocusNode()
int	getFocusOffset()
static NativeSelection	getInstance(Document document) Retrieves the native selection object using Mozilla's API.
NativeRange	getRangeAt(int index)
int	getRangeCount()
boolean	isCollapsed()
void	removeAllRanges() Removes all ranges from the current selection.
void	removeRange(NativeRange range) Removes the given range from the selection.
void	selectAllChildren(com.google.gwt.dom.client.Node parentNode) Adds all children of the specified node to the selection.
void	selectionLanguageChange(boolean langRTL) Modifies the cursor Bidi level after a change in keyboard direction.

Methods inherited from class org.xwiki.gwt.dom.client.JavaScriptObject

fromJson, get, getKeys, remove, set

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createFunction, createObject, equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NativeSelection

protected NativeSelection()

Default constructor. Needs to be protected because all instances are created from JavaScript.

Method Detail

getInstance

public static NativeSelection getInstance(Document document)

Retrieves the native selection object using Mozilla's API.

Parameters:

document - the document for which to retrieve the selection instance

Returns:

the native selection object associated with the given document

addRange

public void addRange(NativeRange range)

Adds a range to this selection.

Parameters:

range - the range to be added

collapse

public void collapse(com.google.gwt.dom.client.Node parentNode,
                     int offset)

Collapses the selection to a single point, at the specified offset in the given DOM node. When the selection is collapsed, and the content is focused and editable, the caret will blink there.

Parameters:

parentNode - the DOM node where the selection will be set

offset - specifies where to place the selection in the given node

collapseToEnd

public void collapseToEnd()

Collapses the whole selection to a single point at the end of the current selection (irrespective of direction). If content is focused and editable, the caret will blink there.

collapseToStart

public void collapseToStart()

Collapses the whole selection to a single point at the start of the current selection (irrespective of direction). If content is focused and editable, the caret will blink there.

containsNode

public boolean containsNode(com.google.gwt.dom.client.Node node,
                            boolean partlyContained)

Indicates whether the given node is part of the selection.

Parameters:

node - the DOM node to be tested

partlyContained - if false, the entire subtree rooted in the given node is tested

Returns:

true when the entire node is part of the selection

deleteFromDocument

public void deleteFromDocument()

Deletes this selection from document the nodes belong to.

extend

public void extend(com.google.gwt.dom.client.Node parentNode,
                   int offset)

Extends the selection by moving the selection end to the specified node and offset, preserving the selection begin position. The new selection end result will always be from the anchorNode to the new focusNode, regardless of direction.

Parameters:

parentNode - the node where the selection will be extended to

offset - specifies where to end the selection in the given node

getAnchorNode

public com.google.gwt.dom.client.Node getAnchorNode()

Returns:

the node in which the selection begins

getAnchorOffset

public int getAnchorOffset()

Returns:

the offset within the getAnchorNode() where the selection begins

getFocusNode

public com.google.gwt.dom.client.Node getFocusNode()

Returns:

the node in which the selection ends

getFocusOffset

public int getFocusOffset()

Returns:

the offset within the getFocusNode() where the selection ends.

getRangeAt

public NativeRange getRangeAt(int index)

Parameters:

index - the index of the range to retrieve. Usually the selection contains just one range.

Returns:

the range at the specified index

getRangeCount

public int getRangeCount()

Returns:

the number of ranges in the selection

isCollapsed

public boolean isCollapsed()

Returns:

true if the selection is collapsed

removeAllRanges

public void removeAllRanges()

Removes all ranges from the current selection.

removeRange

public void removeRange(NativeRange range)

Removes the given range from the selection.

Parameters:

range - the range to be removed from the selection.

selectAllChildren

public void selectAllChildren(com.google.gwt.dom.client.Node parentNode)

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

Parameters:

parentNode - the parent of the children to be added to the selection

selectionLanguageChange

public void selectionLanguageChange(boolean langRTL)

Modifies the cursor Bidi level after a change in keyboard direction.

Parameters:

langRTL - is true if the new language is right-to-left or false if the new language is left-to-right