com.itextpdf.layout.element

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(com.itextpdf.layout.element.TabStop...).

Constructor Summary

Constructors

Constructor and 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 and Description
TabAlignment	getTabAlignment()
Character	getTabAnchor()
ILineDrawer	getTabLeader()
float	getTabPosition()
void	setTabAlignment(TabAlignment tabAlignment)
void	setTabAnchor(Character tabAnchor)
void	setTabLeader(ILineDrawer tabLeader)

Methods inherited from class java.lang.Object

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

Constructor Detail

TabStop

public TabStop(float tabPosition)

Creates a TabStop at the appropriate position.

Parameters:

tabPosition - a float, measured in 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 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 points

tabAlignment - a TabAlignment value

tabLeader - the ILineDrawer value, a pattern drawing object

Method Detail

getTabPosition

public float getTabPosition()

getTabAlignment

public TabAlignment getTabAlignment()

setTabAlignment

public void setTabAlignment(TabAlignment tabAlignment)

getTabAnchor

public Character getTabAnchor()

setTabAnchor

public void setTabAnchor(Character tabAnchor)

getTabLeader

public ILineDrawer getTabLeader()

setTabLeader

public void setTabLeader(ILineDrawer tabLeader)