Class TabStop

java.lang.Object

com.itextpdf.layout.element.TabStop

public class TabStop
extends Object

A TabStop is the closest location on a line of text that the text will jump to if a Tab is inserted. At least one TabStop must be defined on an element if you want to use Tabs. This object can be added to a Paragraph with the method Paragraph.addTabStops(TabStop...).

Field Summary

Fields

Modifier and Type	Field	Description
private TabAlignment	tabAlignment
private Character	tabAnchor
private ILineDrawer	tabLeader
private float	tabPosition

Constructor Summary

Constructors

Constructor	Description
TabStop(float tabPosition)	Creates a TabStop at the appropriate position.
TabStop(float tabPosition, TabAlignment tabAlignment)	Creates a TabStop at the appropriate position, with a specified tab alignment.
TabStop(float tabPosition, TabAlignment tabAlignment, ILineDrawer tabLeader)	Creates a TabStop at the appropriate position, with a specified tab alignment and an explicitly given line pattern.

Method Summary

Modifier and Type	Method	Description
TabAlignment	getTabAlignment()	Returns the alignment of a tab stop, which defines the way the textual content should be positioned in regard to this tab stop.
Character	getTabAnchor()	Returns the anchor of a tab stop.
ILineDrawer	getTabLeader()	Returns the tab leader of a tab stop, which defines a pattern that should be repeated until the TabStop is reached.
float	getTabPosition()	Returns the position of a tab stop.
void	setTabAlignment(TabAlignment tabAlignment)	Sets the alignment, which defines the way the textual content should be positioned in regard to this tab stop.
void	setTabAnchor(Character tabAnchor)	Sets the anchor of a tab stop.
void	setTabLeader(ILineDrawer tabLeader)	Sets the tab leader of a tab stop, which defines a pattern that should be repeated until the TabStop is reached.

Methods inherited from class Object

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

Field Details

tabPosition

private float tabPosition

tabAlignment

private TabAlignment tabAlignment

tabAnchor

private Character tabAnchor

tabLeader

private ILineDrawer tabLeader

Constructor Details

TabStop

public TabStop(float tabPosition)

Creates a TabStop at the appropriate position.

Parameters:

tabPosition - a float, measured in absolute points

TabStop

public TabStop(float tabPosition,
 TabAlignment tabAlignment)

Creates a TabStop at the appropriate position, with a specified tab alignment. A tab alignment defines the way the textual content should be positioned with regards to this tab stop.

Parameters:

tabPosition - a float, measured in absolute points

tabAlignment - a TabAlignment value

TabStop

public TabStop(float tabPosition,
 TabAlignment tabAlignment,
 ILineDrawer tabLeader)

Creates a TabStop at the appropriate position, with a specified tab alignment and an explicitly given line pattern. A tab alignment defines the way the textual content should be positioned with regards to this tab stop. The line pattern defines a pattern that should be repeated until the TabStop is reached. If null, the space leading up to the TabStop will be empty.

Parameters:

tabPosition - a float, measured in absolute points

tabAlignment - a TabAlignment value

tabLeader - the ILineDrawer value, a pattern drawing object

Method Details

getTabPosition

public float getTabPosition()

Returns the position of a tab stop.

Returns:

tabPosition, measured in absolute points

getTabAlignment

public TabAlignment getTabAlignment()

Returns the alignment of a tab stop, which defines the way the textual content should be positioned in regard to this tab stop.

Returns:

a TabAlignment value

setTabAlignment

public void setTabAlignment(TabAlignment tabAlignment)

Sets the alignment, which defines the way the textual content should be positioned in regard to this tab stop.

Parameters:

tabAlignment - a TabAlignment value

getTabAnchor

public Character getTabAnchor()

Returns the anchor of a tab stop.

Returns:

a Character value

setTabAnchor

public void setTabAnchor(Character tabAnchor)

Sets the anchor of a tab stop.

Parameters:

tabAnchor - a Character value

getTabLeader

public ILineDrawer getTabLeader()

Returns the tab leader of a tab stop, which defines a pattern that should be repeated until the TabStop is reached.

Returns:

a ILineDrawer value, a pattern drawing object

setTabLeader

public void setTabLeader(ILineDrawer tabLeader)

Sets the tab leader of a tab stop, which defines a pattern that should be repeated until the TabStop is reached.

Parameters:

tabLeader - a ILineDrawer value