com.xmlmind.xmledit.edit

Class NodeMark

java.lang.Object

com.xmlmind.util.PropertySet

com.xmlmind.xmledit.edit.Mark

com.xmlmind.xmledit.edit.NodeMark

public final class NodeMark
extends Mark

Mark used to mark a node.

Nested Class Summary

Nested classes/interfaces inherited from class com.xmlmind.xmledit.edit.Mark

Mark.Type

Field Summary

Fields inherited from class com.xmlmind.xmledit.edit.Mark

DOT, MARK, SELECTED, SELECTED2

Fields inherited from class com.xmlmind.util.PropertySet

properties

Method Summary

Modifier and Type	Method and Description
Node	getNode() Returns marked node if the type of this mark is Mark.Type.NODE_MARK.
Node	getPreviouslyMarkedChild(int index)
int	getPreviouslyMarkedChildCount()
Mark.Type	getType() Returns the type of this mark: Mark.Type.NODE_MARK or Mark.Type.TEXT_LOCATION.
boolean	moveTo(Node node) Moves this mark to specified node.
boolean	moveToChild() Moves this mark to previously marked child of marked node (that is, undo last moveToParent()) or if marked node has no previously marked child (that is, there is no last moveToParent to undo), moves this mark to first child of marked node.
boolean	moveToNextSibling() Moves this mark to following sibling of marked node.
boolean	moveToParent() Moves this mark to parent of marked node.
boolean	moveToPreviousSibling() Moves this mark to preceding sibling of marked node.

Methods inherited from class com.xmlmind.xmledit.edit.Mark

getId, getManager, isRemoved, remove, toString

Methods inherited from class com.xmlmind.util.PropertySet

getProperties, getProperty, getPropertyCount, hasProperty, putProperties, putProperty, removeAllProperties, removeProperty

Methods inherited from class java.lang.Object

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

Method Detail

getType

public Mark.Type getType()

Description copied from class: Mark

Returns the type of this mark: Mark.Type.NODE_MARK or Mark.Type.TEXT_LOCATION.

Specified by:

getType in class Mark

getNode

public Node getNode()

Description copied from class: Mark

Returns marked node if the type of this mark is Mark.Type.NODE_MARK. Returns textual node containing marked character if the type of this mark is Mark.Type.TEXT_LOCATION.

Specified by:

getNode in class Mark

moveTo

public boolean moveTo(Node node)

Moves this mark to specified node.

Parameters:

node - node to be marked

Returns:

true if marked node has successfully been changed; false if specified node is already the marked node

moveToParent

public boolean moveToParent()

Moves this mark to parent of marked node.

Returns:

true if marked node has successfully been changed; false if marked node is root element

moveToChild

public boolean moveToChild()

Moves this mark to previously marked child of marked node (that is, undo last moveToParent()) or if marked node has no previously marked child (that is, there is no last moveToParent to undo), moves this mark to first child of marked node.

Returns:

true if marked node has successfully been changed; false if marked node has no child

moveToPreviousSibling

public boolean moveToPreviousSibling()

Moves this mark to preceding sibling of marked node.

Returns:

true if marked node has successfully been changed; false if marked node has no preceding sibling or if marked node is the root element

moveToNextSibling

public boolean moveToNextSibling()

Moves this mark to following sibling of marked node.

Returns:

true if marked node has successfully been changed; false if marked node has no following sibling or if marked node is the root element

getPreviouslyMarkedChildCount

public int getPreviouslyMarkedChildCount()

getPreviouslyMarkedChild

public Node getPreviouslyMarkedChild(int index)