com.aspose.words

Class TabStopCollection

java.lang.Object

com.aspose.words.InternableComplexAttr

com.aspose.words.TabStopCollection

All Implemented Interfaces:

java.lang.Cloneable

public class TabStopCollection
extends InternableComplexAttr
implements java.lang.Cloneable

A collection of TabStop objects that represent custom tabs for a paragraph or a style.

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

In Microsoft Word documents, a tab stop can be defined in the properties of a paragraph style or directly in the properties of a paragraph. A style can be based on another style. Therefore, the complete set of tab stops for a given object is a combination of tab stops defined directly on this object and tab stops inherited from the parent styles.

In Aspose.Words, when you obtain a TabStops collection for a paragraph or a style, it contains only the custom tab stops defined directly for this paragraph or style. The collection does not include tab stops defined in the parent styles or default tab stops.

See Also:

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

Method Summary

Modifier and Type	Method and Description
void	add(double position, int alignment, int leader)
void	add(TabStop tabStop) Adds or replaces a tab stop in the collection.
TabStop	after(double position) Gets a first tab stop to the right of the specified position.
TabStop	before(double position) Gets a first tab stop to the left of the specified position.
void	clear() Deletes all tab stop positions.
boolean	equals(java.lang.Object obj) Determines whether the specified object is equal in value to the current object.
boolean	equals(TabStopCollection rhs) Determines whether the specified TabStopCollection is equal in value to the current TabStopCollection.
TabStop	get(double position) Gets a tab stop at the specified position.
TabStop	get(int index) Retrieves a tab stop from the collection.
int	getCount() Gets the number of tab stops in the collection.
int	getIndexByPosition(double position) Gets the index of a tab stop with the specified position in points.
double	getPositionByIndex(int index) Gets the position (in points) of the tab stop at the specified index.
int	hashCode()
boolean	isInheritedComplexAttr()
protected java.lang.Object	memberwiseClone()
void	removeByIndex(int index) Removes a tab stop at the specified index from the collection.
void	removeByPosition(double position) Removes a tab stop at the specified position from the collection.

Methods inherited from class com.aspose.words.InternableComplexAttr

notifyChanging

Methods inherited from class java.lang.Object

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

Method Detail

equals

public boolean equals(TabStopCollection rhs)

Determines whether the specified TabStopCollection is equal in value to the current TabStopCollection.

equals

public boolean equals(java.lang.Object obj)

Determines whether the specified object is equal in value to the current object.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getCount

public int getCount()

Gets the number of tab stops in the collection.

Returns:

The number of tab stops in the collection.

get

public TabStop get(int index)

Retrieves a tab stop from the collection. Gets a tab stop at the given index.

Parameters:

index - An index into the collection of tab stops.

Returns:

The corresponding TabStop value.

get

public TabStop get(double position)

Gets a tab stop at the specified position. Returns null if no tab stop is found at the specified position.

Parameters:

position - The position (in points) of the tab stop.

Returns:

A tab stop at the specified position.

clear

public void clear()

Deletes all tab stop positions.

getPositionByIndex

public double getPositionByIndex(int index)

Gets the position (in points) of the tab stop at the specified index.

Parameters:

index - An index into the collection of tab stops.

Returns:

The position of the tab stop.

getIndexByPosition

public int getIndexByPosition(double position)

Gets the index of a tab stop with the specified position in points.

add

public void add(TabStop tabStop)

Adds or replaces a tab stop in the collection.

If a tab stop already exists at the specified position, it is replaced.

Parameters:

tabStop - A tab stop object to add.

add

public void add(double position,
                int alignment,
                int leader)

removeByPosition

public void removeByPosition(double position)

Removes a tab stop at the specified position from the collection.

Parameters:

position - The position (in points) of the tab stop to remove.

removeByIndex

public void removeByIndex(int index)

Removes a tab stop at the specified index from the collection.

Parameters:

index - An index into the collection of tab stops.

after

public TabStop after(double position)

Gets a first tab stop to the right of the specified position.

Skips tab stops with Alignment set to TabAlignment.Bar.

Parameters:

position - The reference position (in points).

Returns:

A tab stop object or null if a suitable tab stop was not found.

before

public TabStop before(double position)

Gets a first tab stop to the left of the specified position.

Skips tab stops with Alignment set to TabAlignment.Bar.

Parameters:

position - The reference position (in points).

Returns:

A tab stop object or null if a suitable tab stop was not found.

isInheritedComplexAttr

public boolean isInheritedComplexAttr()

memberwiseClone

protected java.lang.Object memberwiseClone()