Bookmark

Inheritance: java.lang.Object

public class Bookmark

Represents a single bookmark.

To learn more, visit the Working with Bookmarks documentation article.

Bookmark is a “facade” object that encapsulates two nodes getBookmarkStart() and getBookmarkEnd() in a document tree and allows to work with a bookmark as a single object.

Methods

Method Description
equals(Object arg0)
getBookmarkEnd() Gets the node that represents the end of the bookmark.
getBookmarkStart() Gets the node that represents the start of the bookmark.
getClass()
getFirstColumn() Gets the zero-based index of the first column of the table column range associated with the bookmark.
getLastColumn() Gets the zero-based index of the last column of the table column range associated with the bookmark.
getName() Gets the name of the bookmark.
getText() Gets the text enclosed in the bookmark.
hashCode()
isColumn() Returns true if this bookmark is a table column bookmark.
notify()
notifyAll()
remove() Removes the bookmark from the document.
setName(String value) Sets the name of the bookmark.
setText(String value) Sets the text enclosed in the bookmark.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter Type Description
arg0 java.lang.Object

Returns: boolean

getBookmarkEnd()

public BookmarkEnd getBookmarkEnd()

Gets the node that represents the end of the bookmark.

Returns: BookmarkEnd - The node that represents the end of the bookmark.

getBookmarkStart()

public BookmarkStart getBookmarkStart()

Gets the node that represents the start of the bookmark.

Returns: BookmarkStart - The node that represents the start of the bookmark.

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getFirstColumn()

public int getFirstColumn()

Gets the zero-based index of the first column of the table column range associated with the bookmark. Returns -1 if this bookmark is not a table column bookmark.

Returns: int - The zero-based index of the first column of the table column range associated with the bookmark.

getLastColumn()

public int getLastColumn()

Gets the zero-based index of the last column of the table column range associated with the bookmark. Returns -1 if this bookmark is not a table column bookmark.

Returns: int - The zero-based index of the last column of the table column range associated with the bookmark.

getName()

public String getName()

Gets the name of the bookmark. Note that if you change the name of a bookmark to a name that already exists in the document, no error will be given and only the first bookmark will be stored when you save the document.

Returns: java.lang.String - The name of the bookmark.

getText()

public String getText()

Gets the text enclosed in the bookmark.

Returns: java.lang.String - The text enclosed in the bookmark.

hashCode()

public native int hashCode()

Returns: int

isColumn()

public boolean isColumn()

Returns true if this bookmark is a table column bookmark.

Returns: boolean - true if this bookmark is a table column bookmark.

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

remove()

public void remove()

Removes the bookmark from the document. Does not remove text inside the bookmark.

setName(String value)

public void setName(String value)

Sets the name of the bookmark. Note that if you change the name of a bookmark to a name that already exists in the document, no error will be given and only the first bookmark will be stored when you save the document.

Parameters:

Parameter Type Description
value java.lang.String The name of the bookmark.

setText(String value)

public void setText(String value)

Sets the text enclosed in the bookmark.

Parameters:

Parameter Type Description
value java.lang.String The text enclosed in the bookmark.

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter Type Description
arg0 long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter Type Description
arg0 long
arg1 int