| java.lang.Object
 com.ibm.richtext.styledtext.MTabRuler
All known Subclasses: com.ibm.richtext.styledtext.StandardTabRuler,
| MTabRuler | | abstract public class MTabRuler (Code) | | This interface represents a sequence of TabStops, ordered by position.
The first
TabStop in the ruler can be obtained with the firstTab
method; subsequent TabStops are obtained with the nextTab
method.
If a TabStop with type TabStop.kAuto is returned, all tabs
after that TabStop will also have type TabStop.kAuto, and
their positions will be multiples of autoSpacing.
See Also: TabStop |
| Method Summary | |
| public MTabRuler | addTab(TabStop tabToAdd)
Return a tab ruler identical to this ruler, except with the
given tab added. | | abstract public int | autoSpacing()
Return the interval for autotabs. | | public boolean | containsTab(TabStop tabToTest)
Return true if this tab ruler contains the given tab. | | abstract public TabStop | firstTab()
Return first tab in the ruler. | | final public int | hashCode()
Compute the hashCode for this ruler. | | public MTabRuler | moveTab(int fromPosition, int toPosition)
Return a tab ruler identical to this ruler, except with the
tab at position fromPosition moved to position
toPosition. | | abstract public TabStop | nextTab(int position)
Return the first tab in the ruler with fPosition > position. | | public MTabRuler | removeTab(int position)
Return a tab ruler identical to the given ruler, except with the
tab at the given position removed. |
| addTab | | public MTabRuler addTab(TabStop tabToAdd)(Code) | | Return a tab ruler identical to this ruler, except with the
given tab added. This ruler is not modified.
Parameters:
tabToAdd - the tab to add to the new tab ruler an MTabRuler resulting from this operation |
| autoSpacing | | abstract public int autoSpacing()(Code) | | Return the interval for autotabs.
|
| containsTab | | public boolean containsTab(TabStop tabToTest)(Code) | | Return true if this tab ruler contains the given tab.
Parameters:
tabToTest - the tab to search for true if this tab ruler contains tabToTest |
| firstTab | | abstract public TabStop firstTab()(Code) | | Return first tab in the ruler. If an autoTab, it is at position zero, and
all subsequent tabs will be autotabs at autoSpacing intervals.
|
| hashCode | | final public int hashCode()(Code) | | Compute the hashCode for this ruler. The hashCode is the
hashCode of the first tab multiplied by the autoSpacing
interval.
|
| moveTab | | public MTabRuler moveTab(int fromPosition, int toPosition)(Code) | | Return a tab ruler identical to this ruler, except with the
tab at position fromPosition moved to position
toPosition. This ruler is not modified.
Parameters:
fromPosition - the position of the tab to move
Parameters:
toPosition - the new position of the tab an MTabRuler resulting from this operation |
| nextTab | | abstract public TabStop nextTab(int position)(Code) | | Return the first tab in the ruler with fPosition > position. If it is an
autotab, it is at an increment of autoSpacing, and all subsequent tabs will be
autotabs at autoSpacing intervals.
|
| removeTab | | public MTabRuler removeTab(int position)(Code) | | Return a tab ruler identical to the given ruler, except with the
tab at the given position removed. This ruler is not modified.
Parameters:
position - the position of the tab to remove from the new tab ruler an MTabRuler resulting from this operation |
|
|