ru.novosoft.dc.rtf.dom.objects
Class Tab

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

public final class Tab

extends java.lang.Object

implements java.lang.Cloneable

The tab specification class. It consists of the tab kind, leaders, and position from the left margin.

Field Summary

static byte	BAR Bar tab kind (this tab presents a vertical bar at the specified position without alignment on it).
static byte	CENTER Centered tab kind.
static byte	DECIMAL Decimal tab kind.
static byte	DOTS Leader dots.
static byte	EQUAL_SIGN Leader equal sign.
static byte	HYPHENS Leader hyphens.
static byte	LEFT Flush-left tab kind (default).
static byte	LISTTAB List label tab kind.
static byte	MIDDLE_DOTS Leader middle dots.
static byte	NONE No leaders (default).
static byte	RIGHT Flush-right tab kind.
static byte	THICK_LINE Leader thick line.
static byte	UNDERLINE Leader underline.

Constructor Summary

Tab()

Method Summary

java.lang.Object	clone() Create a deep copy of this object.
boolean	equals(java.lang.Object obj) Compare this tab with another tab and return true if tabs coinside.
void	exportTo(org.w3c.dom.Element elem) Export the contents of this object to the specified DOM element.
int	getKind() Return the tab kind (the default is LEFT).
int	getLeader() Return the tab leader (the default is NONE).
int	getPosition() Return the tab position (the default is 0).
void	setKind(int value) Set a tab kind (LEFT, RIGHT, CENTER, DECIMAL, or BAR).
void	setLeader(int value) Set a tab leader (NONE, DOTS, MIDDLE_DOTS, HYPHENS, UNDERLINE, THICK_LINE, or EQUAL_SIGN).
void	setPosition(int value) Set a tab position in twips from the left margin.

Methods inherited from class java.lang.Object

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

Field Detail

BAR

public static final byte BAR

Bar tab kind (this tab presents a vertical bar at the specified position without alignment on it).

LEFT

public static final byte LEFT

Flush-left tab kind (default).

RIGHT

public static final byte RIGHT

Flush-right tab kind.

CENTER

public static final byte CENTER

Centered tab kind.

DECIMAL

public static final byte DECIMAL

Decimal tab kind.

LISTTAB

public static final byte LISTTAB

List label tab kind.

NONE

public static final byte NONE

No leaders (default).

DOTS

public static final byte DOTS

Leader dots.

MIDDLE_DOTS

public static final byte MIDDLE_DOTS

Leader middle dots.

HYPHENS

public static final byte HYPHENS

Leader hyphens.

UNDERLINE

public static final byte UNDERLINE

Leader underline.

THICK_LINE

public static final byte THICK_LINE

Leader thick line.

EQUAL_SIGN

public static final byte EQUAL_SIGN

Leader equal sign.

Constructor Detail

Tab

public Tab()

Method Detail

setKind

public final void setKind(int value)

Set a tab kind (LEFT, RIGHT, CENTER, DECIMAL, or BAR).

getKind

public final int getKind()

Return the tab kind (the default is LEFT).

setLeader

public final void setLeader(int value)

Set a tab leader (NONE, DOTS, MIDDLE_DOTS, HYPHENS, UNDERLINE, THICK_LINE, or EQUAL_SIGN).

getLeader

public final int getLeader()

Return the tab leader (the default is NONE).

setPosition

public final void setPosition(int value)

Set a tab position in twips from the left margin.

getPosition

public final int getPosition()

Return the tab position (the default is 0).

clone

public java.lang.Object clone()

Create a deep copy of this object.

Overrides:

clone in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Compare this tab with another tab and return true if tabs coinside.

Overrides:

equals in class java.lang.Object

exportTo

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

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