Package com.itextpdf.layout.element
Class TabStop
- java.lang.Object
-
- com.itextpdf.layout.element.TabStop
-
public class TabStop extends java.lang.Object
A TabStop is the closest location on a line of text that the text will jump to if aTab
is inserted. At least one TabStop must be defined on an element if you want to useTabs
. This object can be added to aParagraph
with the methodParagraph.addTabStops(com.itextpdf.layout.element.TabStop...)
.
-
-
Field Summary
Fields Modifier and Type Field Description private TabAlignment
tabAlignment
private java.lang.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
All Methods Instance Methods Concrete Methods 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.java.lang.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(java.lang.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.
-
-
-
Field Detail
-
tabPosition
private float tabPosition
-
tabAlignment
private TabAlignment tabAlignment
-
tabAnchor
private java.lang.Character tabAnchor
-
tabLeader
private ILineDrawer tabLeader
-
-
Constructor Detail
-
TabStop
public TabStop(float tabPosition)
Creates a TabStop at the appropriate position.- Parameters:
tabPosition
- afloat
, 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
- afloat
, measured in absolute pointstabAlignment
- aTabAlignment
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
- afloat
, measured in absolute pointstabAlignment
- aTabAlignment
valuetabLeader
- theILineDrawer
value, a pattern drawing object
-
-
Method Detail
-
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
- aTabAlignment
value
-
getTabAnchor
public java.lang.Character getTabAnchor()
Returns the anchor of a tab stop.- Returns:
- a
Character
value
-
setTabAnchor
public void setTabAnchor(java.lang.Character tabAnchor)
Sets the anchor of a tab stop.- Parameters:
tabAnchor
- aCharacter
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
- aILineDrawer
value
-
-