com.aspose.words

Class TabStop

java.lang.Object

com.aspose.words.TabStop

All Implemented Interfaces:

java.lang.Cloneable

public final class TabStop
extends java.lang.Object
implements java.lang.Cloneable

Represents a single custom tab stop. The TabStop object is a member of the TabStopCollection collection.

To learn more, visit the Aspose.Words Document Object Model (DOM) documentation article.

Normally, a tab stop specifies a position where a tab stop exists. But because tab stops can be inherited from parent styles, it might be needed for the child object to define explicitly that there is no tab stop at a given position. To clear an inherited tab stop at a given position, create a TabStop object and set getAlignment() / setAlignment(int) to TabAlignment.Clear.

For more information see TabStopCollection.

See Also:

ParagraphFormat, TabStopCollection, Document.getDefaultTabStop(), Document.setDefaultTabStop(double)

Constructor Summary

Constructors

Constructor and Description
TabStop(double position) Initializes a new instance of this class.
TabStop(double position, int alignment, int leader) Initializes a new instance of this class.

Method Summary

Modifier and Type	Method and Description
boolean	equals(TabStop rhs) Compares with the specified TabStop.
int	getAlignment() Gets the alignment of text at this tab stop.
int	getLeader() Gets the type of the leader line displayed under the tab character.
double	getPosition() Gets the position of the tab stop in points.
int	hashCode()
boolean	isClear() Returns true if this tab stop clears any existing tab stops in this position.
protected java.lang.Object	memberwiseClone()
void	setAlignment(int value) Sets the alignment of text at this tab stop.
void	setLeader(int value) Sets the type of the leader line displayed under the tab character.

Methods inherited from class java.lang.Object

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

Constructor Detail

TabStop

public TabStop(double position)

Initializes a new instance of this class.

TabStop

public TabStop(double position,
               int alignment,
               int leader)

Initializes a new instance of this class.

Method Detail

equals

public final boolean equals(TabStop rhs)

Compares with the specified TabStop.

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

getPosition

public final double getPosition()

Gets the position of the tab stop in points.

Returns:

The position of the tab stop in points.

getAlignment

public final int getAlignment()

Gets the alignment of text at this tab stop.

Returns:

The alignment of text at this tab stop. The returned value is one of TabAlignment constants.

setAlignment

public final void setAlignment(int value)

Sets the alignment of text at this tab stop.

Parameters:

value - The alignment of text at this tab stop. The value must be one of TabAlignment constants.

getLeader

public final int getLeader()

Gets the type of the leader line displayed under the tab character.

Returns:

The type of the leader line displayed under the tab character. The returned value is one of TabLeader constants.

setLeader

public final void setLeader(int value)

Sets the type of the leader line displayed under the tab character.

Parameters:

value - The type of the leader line displayed under the tab character. The value must be one of TabLeader constants.

isClear

public final boolean isClear()

Returns true if this tab stop clears any existing tab stops in this position.

Returns:

True if this tab stop clears any existing tab stops in this position.

memberwiseClone

protected final java.lang.Object memberwiseClone()