ru.novosoft.dc.rtf.dom
Class Bookmark

java.lang.Object
  |
  +--ru.novosoft.dc.rtf.dom.Bookmark

public final class Bookmark

extends java.lang.Object

implements RTFInline

Marker of start and end bookmarks.

Field Summary

static byte	FIRST The index of the first column number.
static byte	LAST The index of the last column number.

Constructor Summary

Bookmark()

Method Summary

void	exportTo(org.w3c.dom.Element elem) Export the contents of this object to the specified DOM element.
int	getColumnNumber(int index) Return the value of the specified column number or 0 if this number is nonspecified.
java.lang.String	getName() Return the bookmark name or null if name nonspecified.
boolean	isStartBookmark() Return true if this is the start bookmark.
void	setColumnNumber(int index, int value) Set a number of the first or last column the bookmark occupies in table (the index specifies what number to set).
void	setName(java.lang.String value) Set a bookmark name.
void	setStartBookmark(boolean value) Set bookmark type (true if start bookmark and false if end bookmark).

Methods inherited from class java.lang.Object

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

Field Detail

FIRST

public static final byte FIRST

The index of the first column number.

LAST

public static final byte LAST

The index of the last column number.

Constructor Detail

Bookmark

public Bookmark()

Method Detail

setStartBookmark

public final void setStartBookmark(boolean value)

Set bookmark type (true if start bookmark and false if end bookmark).

isStartBookmark

public final boolean isStartBookmark()

Return true if this is the start bookmark.

setName

public final void setName(java.lang.String value)

Set a bookmark name.

getName

public final java.lang.String getName()

Return the bookmark name or null if name nonspecified.

setColumnNumber

public final void setColumnNumber(int index,
                                  int value)

Set a number of the first or last column the bookmark occupies in table (the index specifies what number to set). Column numbers are enumerated from 1 here. Zero value means that the column number is unspecified and the bookmark occupies from the first column or up to the last column respectively.

getColumnNumber

public final int getColumnNumber(int index)

Return the value of the specified column number or 0 if this number is nonspecified.

exportTo

public void exportTo(org.w3c.dom.Element elem)

Export the contents of this object to the specified DOM element.