Represents a position between two logical tokens in an XML document.
The tokens themselves are not exposed as objects, but their type and properties
are discoverable through methods on the cursor. In particular, the general
category of token is represented by a
.
You use an XmlCursor instance to navigate through and manipulate an XML
instance document.
Once you obtain an XML document, you can create a cursor to represent
a specific place in the XML. Because you can use a cursor with or
without a schema corresponding to the XML, cursors are an ideal
way to handle XML without a schema. You can create a new cursor by
calling the
method
exposed by an object representing
the XML, whether it was parsed into a strong type compiled from
schema or an
(as in the no-schema case).
A cursor moves through XML by moving past tokens. A
token represents a category of XML markup, such as the start of an element,
its end, an attribute, comment, and so on. XmlCursor methods such as
toNextToken, toNextSibling, toParent, and so on move the cursor
among tokens. Each token's category is of a particular
class.
When you get a new cursor for a whole instance document, the cursor is
intially located before the STARTDOC token. This token, which has no analogy
in the XML specification, is present in this logical model of XML
so that you may distinguish between the document as a whole
and the content of the document. Terminating the document is an ENDDOC
token. This token is also not part of the XML specification. A cursor
located immediately before this token is at the very end of the document.
It is not possible to position the cursor after the ENDDOC token.
Thus, the STARTDOC and ENDDOC tokens are effectively "bookends" for the content of
the document.
For example, for the following XML, if you were the navigate a cursor
through the XML document using toNextToken(), the list of token types that
follows represents the token sequence you would encounter.
When there are no more tokens available, hasNextToken() returns
false and toNextToken() returns the special token type NONE and does not move
the cursor.
method
will return the type of the token that is immediately after the cursor.
You can also use a number of convenience methods that test for a particular
token type. These include the methods isStart(),
isStartdoc(), isText(), isAttr(), and so on. Each returns a boolean
value indicating whether the token that follows the cursor is the type
in question.
A few other methods determine whether the token is of a kind that may include
multiple token types. The isAnyAttr() method, for example, returns true if
the token immediately following the cursor is any kind of attribute,
including those of the ATTR token type and xmlns attributes.
Legitimate sequences of tokens for an XML document are described
by the following Backus-Naur Form (BNF):
Note that a legitimate sequence is STARTDOC ENDDOC, the result of
creating a brand new instance of an empty document. Also note that
attributes may only follow container tokens (STARTDOC or START)
| Method from org.apache.xmlbeans.XmlCursor Detail: |
|---|
 public void addToSelection()
Appends the current location of the cursor to the selection.
See also the selectPath() method. You can use this as an
alternative to calling the selectPath method when you want
to define your own selection. |
public void beginElement(QName name) Inserts a new element around this cursor, giving the element the specified
qualified name. After the element is inserted, this cursor is between its start
and end. This cursor can then be used to insert additional XML into
the new element. |
public void beginElement(String localName) Inserts a new element around this cursor, giving the element the specified
local name. After the element is inserted, this cursor is between its start
and end. This cursor can then be used to insert additional XML into
the new element. |
public void beginElement(String localName,
String uri) Inserts a new element around this cursor, giving the element the specified
local name and associating it with the specified namespace. After the element
is inserted, this cursor is between its start and end. This cursor
can then be used to insert additional XML into the new element. |
public void clearBookmark(Object key) Clears the bookmark whose key is specified, if the bookmark
exists at this cursor's location. |
public void clearSelections() Clears this cursor's selection, but does not modify the document. |
public int comparePosition(XmlCursor cursor) Returns an integer indicating whether this cursor is before,
after, or at the same position as the specified cursor.
a.comparePosition(b) < 0 means a is to the left of b.
a.comparePosition(b) == 0 means a is at the same position as b.
a.comparePosition(b) > 0 means a is to the right of b.
The sort order of cursors in the document is the token order.
For example, if cursor "a" is at a START token and the cursor "b"
is at a token within the contents of the same element, then
a.comparePosition(b) will return -1, meaning that the position
of a is before b. |
public int copyChars(int maxCharacterCount,
XmlCursor toHere) Copies characters to the position immediately after the specified cursor.
Characters are counted to the right up to the specified maximum number.
XML after the destination cursor is shifted to the right to make room. |
public boolean copyXml(XmlCursor toHere) Copies the XML immediately after this cursor to the location
specified by the toHere cursor. For the TEXT, ATTR, NAMESPACE,
COMMENT and PROCINST tokens, a single token is copied. For a start token,
the element and all of its contents are copied. For all other tokens, this
is a no-op.
The cursors and bookmarks located in the XML that was copied are also copied
to the new location. |
public boolean copyXmlContents(XmlCursor toHere) Copies the contents of the container (STARTDOC OR START) immediately to
the right of the cursor to the location specified by the toHere cursor.
For all other situations, returns false. Does not copy attributes or
namespaces. |
public TokenType currentTokenType() Returns the type of the current token. By definition, the current
token is the token immediately to the right of the cursor.
If you're in the middle of text, before a character, you get TEXT.
You can't dive into the text of an ATTR, COMMENT or PROCINST.
As an alternative, it may be more convenient for you to use one of the
methods that test for a particular token type. These include the methods
isStart(), isStartdoc(), isText(), isAttr(), and so on. Each returns a boolean
value indicating whether the token that follows the cursor is the type
in question.
|
public void dispose() Deallocates resources needed to manage the cursor, rendering this cursor
inoperable. Because cursors are managed by a mechanism which stores the
XML, simply letting a cursor go out of scope and having the garbage collector
attempt to reclaim it may not produce desirable performance.
So, explicitly disposing a cursor allows the underlying implementation
to release its responsibility of maintaining its position.
After a cursor has been disposed, it may not be used again. It can
throw IllegalStateException or NullPointerException if used after
disposal.
|
public XmlCursor execQuery(String query) Executes the specified XQuery expression against the XML this
cursor is in.
The query may be a String or a compiled query. You can precompile
an XQuery expression using the XmlBeans.compileQuery method.
The root referred to by the expression should be given as
a dot. The following is an example path expression:
XmlCursor results = cursor.execQuery("purchase-order/line-item[price <= 20.00]");
|
public XmlCursor execQuery(String query,
XmlOptions options) Executes the specified XQuery expression against the XML this
cursor is in, and using the specified options.
|
public void getAllBookmarkRefs(Collection listToFill) Retrieves all the bookmarks at this location, adding them to
the specified collection. Bookmarks held by weak references are
added to this collection as Weak referenced objects pointing to the
bookmark. |
public void getAllNamespaces(Map addToThis) Adds to the specified map, all the namespaces in scope at the container
where this cursor is positioned. This method is useful for
container tokens only. |
public String getAttributeText(QName attrName) When at a START or STARTDOC, returns the attribute text for the given
attribute. When not at a START or STARTDOC or the attribute does not
exist, returns null. |
public XmlBookmark getBookmark(Object key) Retrieves the bookmark with the specified key
at this cursor's location. If there is no bookmark whose key is
given by the specified key at the current position, null is returned.
If the getKey method is not overridden on
the bookmark, then the bookmark's class is used as the key. |
public String getChars() Returns characters to the right of the cursor up to the next token. |
public int getChars(char[] returnedChars,
int offset,
int maxCharacterCount) Copies characters up to the specified maximum number, counting right from
this cursor's location to the character at maxCharacterCount. The
returned characters are added to returnedChars, with the first
character copied to the offset position. The maxCharacterCount
parameter should be less than or equal to the length of returnedChars
minus offset. Copies a number of characters, which is
either maxCharacterCount or the number of characters up to the next token,
whichever is less. |
public ChangeStamp getDocChangeStamp() Returns the current change stamp for the document the current cursor is in.
This change stamp can be queried at a later point in time to find out
if the document has changed. |
public QName getName() Returns the name of the current token. Names may be associated with
START, ATTR, NAMESPACE or PROCINST. Returns null if there is no
name associated with the current token. For START and ATTR, the
name returned identifies the name of the element or attribute.
For NAMESPACE, the local part of the name is the prefix, while
the URI is the namespace defined. For PROCINST, the local part
is the target and the uri is "".
In the following example, xmlObject represents
an XML instance whose root element is not preceded by any other XML.
This code prints the root element name (here, the local name, or
name without URI).
XmlCursor cursor = xmlObject.newCursor();
cursor.toFirstContentToken();
String elementName = cursor.getName().getLocalPart();
System.out.println(elementName);
|
public XmlObject getObject() Returns the strongly-typed XmlObject at the current START,
STARTDOC, or ATTR.
The strongly-typed object can be cast to the strongly-typed
XBean interface corresponding to the XML Schema Type given
by result.getSchemaType().
If a more specific type cannot be determined, an XmlObject
whose schema type is anyType will be returned. |
public int getSelectionCount() Returns the count of the current selection. See also the selectPath()
and addToSelection() methods.
You may experience better performance if you use the iteration
model using the toNextSelection method, rather than
the indexing model using the getSelectionCount and
toSelection methods. |
public String getTextValue() Gets the text value of the current document, element, attribute,
comment, procinst or text token.
When getting the text value of an element, non-text content such
as comments and processing instructions are ignored and text is concatenated.
For elements that have nested element children, this
returns the concatenated text of all mixed content and the
text of all the element children, recursing in first-to-last
depthfirst order.
For attributes, including namespaces, this returns the attribute value.
For comments and processing instructions, this returns the text content
of the comment or PI, not including the delimiting sequences <!-- -->, <? ?>.
For a PI, the name of the PI is also not included.
The value of an empty tag is the empty string.
If the current token is END or ENDDOC, this throws an java.lang.IllegalStateException .
|
public int getTextValue(char[] returnedChars,
int offset,
int maxCharacterCount) Copies the text value of the current document, element, attribute,
comment, processing instruction or text token, counting right from
this cursor's location up to maxCharacterCount,
and copies the returned text into returnedChars.
When getting the text value of an element, non-text content such
as comments and processing instructions are ignored and text is concatenated.
For elements that have nested element children, this
returns the concatenated text of all mixed content and the
text of all the element children, recursing in first-to-last
depthfirst order.
For attributes, including namespaces, this returns the attribute value.
For comments and processing instructions, this returns the text contents
of the comment or PI, not including the delimiting sequences <!-- -->, <? ?>. For
a PI, the text will not include the name of the PI.
If the current token is END or ENDDOC, this throws an java.lang.IllegalStateException .
The value of an empty tag is the empty string.
|
public boolean hasNextSelection() Returns whether or not there is a next selection. |
public boolean hasNextToken() True if there is a next token. When this is false, as when the cursor is
at the ENDDOC token, the toNextToken() method returns NONE and does not
move the cursor. |
public boolean hasPrevToken() True if there is a previous token. When this is false, toPrevToken
returns NONE and does not move the cursor. |
public void insertAttribute(String localName) Inserts a new attribute immediately before this cursor's location, giving it
the specified local name. |
public void insertAttribute(QName name) Inserts a new attribute immediately before this cursor's location, giving it
the specified name. |
public void insertAttribute(String localName,
String uri) Inserts a new attribute immediately before this cursor's location, giving it
the specified local name and associating it with the specified namespace. |
public void insertAttributeWithValue(String Name,
String value) Inserts a new attribute immediately before this cursor's location, giving it
the specified value and name. |
public void insertAttributeWithValue(QName name,
String value) Inserts an attribute immediately before the cursor's location, giving it
the specified name and value. |
public void insertAttributeWithValue(String name,
String uri,
String value) Inserts an attribute immediately before the cursor's location, giving it
the specified name and value, and associating it with the specified namespace. |
public void insertChars(String text) Inserts the specified text immediately before this cursor's location. |
public void insertComment(String text) Inserts an XML comment immediately before the cursor's location,
giving it the specified content. |
public void insertElement(QName name) Inserts an element immediately before this cursor's location, giving
the element the specified qualified name. |
public void insertElement(String localName) Inserts an element immediately before this cursor's location, giving
the element the specified local name. |
public void insertElement(String localName,
String uri) Inserts a new element immediately before this cursor's location, giving the
element the specified local name and associating it with specified namespace |
public void insertElementWithText(QName name,
String text) Inserts a new element immediately before this cursor's location, giving the
element the specified qualified name and content. |
public void insertElementWithText(String localName,
String text) Inserts a new element immediately before this cursor's location, giving the
element the specified local name and content. |
public void insertElementWithText(String localName,
String uri,
String text) Inserts a new element immediately before this cursor's location, giving the
element the specified local name, associating it with the specified namespace,
and giving it the specified content. |
public void insertNamespace(String prefix,
String namespace) Inserts a namespace declaration immediately before the cursor's location,
giving it the specified prefix and URI. |
public void insertProcInst(String target,
String text) Inserts an XML processing instruction immediately before the cursor's location,
giving it the specified target and text. |
public boolean isAnyAttr() True if this token is any attribute. This includes an ATTR token type and
the NAMESPACE token type attribute. |
public boolean isAtSamePositionAs(XmlCursor cursor) Determines if this cursor is at the same position as
the specified cursor. Note that this is the same as
a.comparePosition(b) == 0 |
public boolean isAttr() True if this token is an ATTR token type, meaning
just before an attribute. |
public boolean isComment() True if this token is a COMMENT token type, meaning
just before a comment. |
public boolean isContainer() True if this token is a container token. The STARTDOC and START
token types are containers. Containers, including documents and elements,
have the same content model. In other words, a document and an element
may have the same contents. For example, a document may contain attributes
or text, without any child elements. |
public boolean isEnd() True if this token is an END token type, meaning
just before an element's end. |
public boolean isEnddoc() True if this token is an ENDDOC token type, meaning
at the very end of the document. |
public boolean isFinish() True if this token is a finish token. A finish token can be an ENDDOC
or END token type. |
public boolean isInSameDocument(XmlCursor cursor) Determines if the specified cursor is in the same document as
this cursor. |
public boolean isLeftOf(XmlCursor cursor) Determines if this cursor is to the left of (or before)
the specified cursor. Note that this is the same as
a.comparePosition(b) < 0 |
public boolean isNamespace() True if this token is a NAMESPACE token type, meaning
just before a namespace declaration. |
public boolean isProcinst() True if this token is a PROCINST token type, meaning
just before a processing instruction. |
public boolean isRightOf(XmlCursor cursor) Determines if this cursor is to the right of (or after)
the specified cursor. Note that this is the same as
a.comparePosition(b) > 0 |
public boolean isStart() True if this token is a START token type, meaning
just before an element's start. |
public boolean isStartdoc() True if the current token is a STARTDOC token type, meaning
at the very root of the document. |
public boolean isText() True if the this token is a TEXT token type, meaning
just before or inside text. |
public int moveChars(int maxCharacterCount,
XmlCursor toHere) Moves characters immediately after this cursor to the position immediately
after the specified cursor. Characters are counted to the right up to the
specified maximum number. XML after the destination cursor is
shifted to the right to make room. The space remaining from moving the
characters collapses up to this cursor. |
public boolean moveXml(XmlCursor toHere) Moves the XML immediately after this cursor to the location
specified by the toHere cursor, shifting XML at that location
to the right to make room. For the TEXT, ATTR, NAMESPACE,
COMMENT and PROCINST tokens, a single token is moved. For a start token, the
element and all of its contents are moved. For all other tokens, this
is a no-op.
The bookmarks located in the XML that was moved also move to the
new location; the cursors don't move with the content. |
public boolean moveXmlContents(XmlCursor toHere) Moves the contents of the container (STARTDOC OR START) immediately after
this cursor to the location specified by the toHere cursor.
For all other situations, returns false. Does not move attributes or
namespaces. |
public String namespaceForPrefix(String prefix) Returns the namespace URI indicated by the given prefix. The current
context must be at a START or STARTDOC. Namespace prefix mappings
are queried for the mappings defined at the current container first,
then parents are queried. The prefix can be "" or null to indicate
a search for the default namespace. To conform with the
XML spec, the default namespace will return the no-namespace ("")
if it is not mapped.
Note that this queries the current state of the document. When the
document is persisted, the saving mechanism may synthesize namespaces
(ns1, ns2, and so on) for the purposes of persistence. These namepaces are
only present in the serialized form, and are not reflected back into
the document being saved. |
public boolean pop() Restores the cursor location most recently saved with the push() method. |
public String prefixForNamespace(String namespaceURI) Returns a prefix that can be used to indicate a namespace URI. The
current context must be at a START or STARTDOC. If there is an
existing prefix that indicates the URI in the current context, that
prefix may be returned. Otherwise, a new prefix for the URI will be
defined by adding an xmlns attribute to the current container or a
parent container.
Note that this queries the current state of the document. When the
document is persisted, the saving mechanism may synthesize namespaces
(ns1, ns2, and so on) for the purposes of persistence. These namepaces are
only present in the serialized form, and are not reflected back into
the document being saved. |
public TokenType prevTokenType() Returns the type of the previous token. By definition, the previous
token is the token immediately to the left of the cursor.
If you're in the middle of text, after a character, you get TEXT. |
public void push() Saves the current location of this cursor on an internal stack of saved
positions (independent of selection). This location may be restored
later by calling the pop() method. |
public boolean removeAttribute(QName attrName) When at a START or STARTDOC, removes the attribute with the given name. |
public int removeChars(int maxCharacterCount) Removes characters up to the specified maximum number, counting right from
this cursor's location to the character at maxCharacterCount. The
space remaining from removing the characters collapses up to this cursor. |
public boolean removeXml() Removes the XML that is immediately after this cursor.
For the TEXT, ATTR, NAMESPACE, COMMENT and PROCINST tokens, a single
token is removed. For a START token, the corresponding element and all
of its contents are removed. For all other tokens, this is a no-op.
You cannot remove a STARTDOC.
The cursors located in the XML that was removed all collapse to the
same location. All bookmarks in this XML will be orphaned. |
public boolean removeXmlContents() Removes the contents of the container (STARTDOC OR START) immediately after
this cursor. For all other situations, returns false. Does
not remove attributes or namspaces. |
public void selectPath(String path) Executes the specified XPath expression against the XML that this
cursor is in. The cursor's position does not change. To navigate to the
selections, use #hasNextSelection and #toNextSelection (similar to
java.util.Iterator ).
The root referred to by the expression should be given as
a dot. The following is an example path expression:
cursor.selectPath("./purchase-order/line-item");
Note that this method does not support top-level XPath functions. |
public void selectPath(String path,
XmlOptions options) Executes the specified XPath expression against the XML that this
cursor is in. The cursor's position does not change. To navigate to the
selections, use hasNextSelection and toNextSelection (similar to
java.util.Iterator).
The root referred to by the expression should be given as
a dot. The following is an example path expression:
cursor.selectPath("./purchase-order/line-item");
Note that this method does not support top-level XPath functions. |
public boolean setAttributeText(QName attrName,
String value) When at a START or STARTDOC, sets the attribute text for the given
attribute. When not at a START or STARTDOC returns false.
If the attribute does not exist, one is created. |
public void setBookmark(XmlBookmark bookmark) Sets a bookmark to the document at this cursor's location.
The bookmark is attached to the token in the tree immediately
after the cursor. If the tree is manipulated to move
that object to a different place, the bookmark moves with it.
If the tree is manipulated to delete that token from the
tree, the bookmark is orphaned. Copy operations do not copy
bookmarks. |
public void setName(QName name) Sets the name of the current token. This token can be START, NAMESPACE,
ATTR or PROCINST. |
public void setTextValue(String text) Sets the text value of the XML at this cursor's location if that XML's
token type is START, STARTDOC, ATTR, COMMENT or PROCINST.
For elements that have nested children this first removes all
the content of the element and replaces it with the given text. |
public void setTextValue(char[] sourceChars,
int offset,
int length) Sets the text value of the XML at this cursor's location (if that XML's
token type is START, STARTDOC, ATTR, COMMENT or PROCINST) to the
contents of the specified character array.
For elements that have nested children this first removes all
the content of the element and replaces it with the given text. |
public boolean toBookmark(XmlBookmark bookmark) Moves this cursor to the same position as the bookmark. If the
bookmark is in a different document from this cursor or if the
bookmark is orphaned, this cursor
will not be moved, and false will be returned. |
public boolean toChild(String name) Moves the cursor to the first child element of the specified name in
no namespace. |
public boolean toChild(QName name) Moves the cursor to the first child element of the specified qualified name. |
public boolean toChild(int index) Moves the cursor to the child element specified by index. |
public boolean toChild(String namespace,
String name) Moves the cursor to the first child element of the specified name in the
specified namespace. |
public boolean toChild(QName name,
int index) Moves the cursor to the specified index child element of the
specified name, where that element is the . |
public boolean toCursor(XmlCursor moveTo) Moves this cursor to the same position as the moveTo cursor. if the
moveTo cursor is in a different document from this cursor, this cursor
will not be moved, and false returned. |
public void toEndDoc() Moves the cursor to the ENDDOC token, which is the end
of the document. |
public TokenType toEndToken() Moves the cursor to the END or ENDDOC token corresponding to the
current START or STARTDOC, and returns END or ENDDOC.
If the current token is not a START or STARTDOC, the cursor is not
moved and NONE is returned. |
public boolean toFirstAttribute() Moves the cursor to the first attribute of this element, or
returns false and does not move the cursor if there are no
attributes. The order of attributes is arbitrary, but stable.
If the cursor is on a STARTDOC of a document-fragment, this method will
move it to the first top level attribute if one exists.
xmlns attributes (namespace declarations) are not considered
attributes by this function.
The cursor must be on a START or STARTDOC (in the case of a
document fragment with top level attributes) for this method to
succeed.
Example for looping through attributes:
XmlCursor cursor = ... //cursor on START or STARTDOC
if (cursor.toFirstAttribute())
{
do
{
// do something using attribute's name and value
cursor.getName();
cursor.getTextValue();
}
while (cursor.toNextAttribute());
}
|
public boolean toFirstChild() Moves the cursor to the first child element, or returns false and
does not move the cursor if there are no element children.
If the cursor is not currently in an element, it moves into the
first child element of the next element. |
public TokenType toFirstContentToken() Moves the cursor to the first token in the content of the current
START or STARTDOC. That is, the first token after all ATTR and NAMESPACE
tokens associated with this START.
If the current token is not a START or STARTDOC, the cursor is not
moved and NONE is returned. If the current START or STARTDOC
has no content, the cursor is moved to the END or ENDDOC token.
|
public boolean toLastAttribute() Moves the cursor to the last attribute of this element, or
returns false and does not move the cursor if there are no
attributes. The order of attributes is arbitrary, but stable.
xmlns attributes (namespace declarations) are not considered
attributes by this function.
The cursor must be on a START or STARTDOC for this method
to succeed. |
public boolean toLastChild() Moves the cursor to the last element child, or returns false and
does not move the cursor if there are no element children. |
public boolean toNextAttribute() Moves the cursor to the next sibling attribute, or returns
false and does not move the cursor if there is no next
sibling attribute. The order of attributes is arbitrary, but stable.
xmlns attributes (namespace declarations) are not considered
attributes by this function.
The cursor must be on an attribute for this method to succeed. |
public XmlBookmark toNextBookmark(Object key) Moves this cursor to the location after its current position
where a bookmark with the given key exists. Returns false if no
such bookmark exists. |
public int toNextChar(int maxCharacterCount) Moves the cursor forward by the specified number of characters, and
stops at the next non-TEXT token. Returns the number of characters
actually moved across, which is guaranteed to be less than or equal to
maxCharacterCount. If there is no further text, or if
there is no text at all, returns zero.
Note this does not dive into attribute values, comment contents,
processing instruction contents, etc., but only content text.
You can pass maxCharacterCount < 0 to move over all the text to the
right. This has the same effect as toNextToken, but returns the amount
of text moved over. |
public boolean toNextSelection() |
public boolean toNextSibling() Moves the cursor to the next sibling element, or returns
false and does not move the cursor if there is no next sibling
element. (By definition the position of an element is the same
as the position of its START token.)
If the current token is not s START, the cursor will be
moved to the next START without moving out of the scope of the
current element. |
public boolean toNextSibling(String name) Moves the cursor to the next sibling element of the specified name in no
namespace. |
public boolean toNextSibling(QName name) Moves the cursor to the next sibling element of the specified
qualified name. |
public boolean toNextSibling(String namespace,
String name) Moves the cursor to the next sibling element of the specified name
in the specified namespace. |
public TokenType toNextToken() Moves the cursor to the next token. When there are no more tokens
available, hasNextToken returns false and toNextToken() returns
NONE and does not move the cursor. Returns the token type
of the token to the right of the cursor upon a successful move. |
public boolean toParent() Moves the cursor to the parent element or STARTDOC, or returns
false and does not move the cursor if there is no parent.
Works if you're in attributes or content. Returns false only if at
STARTDOC. Note that the parent of an END token is the corresponding
START token. |
public boolean toPrevAttribute() Moves the cursor to the previous sibling attribute, or returns
false and does not move the cursor if there is no previous
sibling attribute. The order of attributes is arbitrary, but stable.
xmlns attributes (namespace declarations) are not considered
attributes by this function.
The cursor must be on an attribute for this method to succeed. |
public XmlBookmark toPrevBookmark(Object key) Moves this cursor to the location before its current position
where a bookmark with the given key exists. Returns false if no
such bookmark exists. |
public int toPrevChar(int maxCharacterCount) Moves the cursor backwards by the number of characters given. Has
similar characteristics to the toNextChar method. |
public boolean toPrevSibling() Moves the cursor to the previous sibling element, or returns
false and does not move the cursor if there is no previous sibling
element. (By definition the position of an element is the same
as the position of its START token.) |
public TokenType toPrevToken() Moves the cursor to the previous token. When there is no
previous token, returns NONE, otherwise returns the token
to the left of the new position of the cursor. |
public boolean toSelection(int i) Moves this cursor to the specified location in the selection.
If i is less than zero or greater than or equal to the selection
count, this method returns false.
See also the selectPath() and addToSelection() methods. |
public void toStartDoc() Moves the cursor to the STARTDOC token, which is the
root of the document. |