Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
ITabStopFormat

Package | flashx.textLayout.formats
Interface | public interface ITabStopFormat
Implementors | TabStopFormat

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

This interface provides read access to tab stop-related properties.

Public Properties

| Property | Defined By
--- | --- | ---
|  | alignment : * [read-only] The tab alignment for this tab stop. | ITabStopFormat
|  | decimalAlignmentToken : * [read-only] The alignment token to be used if the alignment is DECIMAL. | ITabStopFormat
|  | position : * [read-only] The position of the tab stop, in pixels, relative to the start edge of the column. | ITabStopFormat

Public Methods

| Method | Defined By
--- | --- | ---
|  | getStyle(styleName:String):* Return the value of the style specified by the styleProp parameter which specifies the style name. | ITabStopFormat

Property Detail

alignment | property

`alignment:*` [read-only]

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The tab alignment for this tab stop.

Legal values are TabAlignment.START, TabAlignment.CENTER, TabAlignment.END, TabAlignment.DECIMAL, FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will have a value of TabAlignment.START.

Implementation
`public function get alignment():*`
Throws

| `RangeError` — when set value is not within range for this property

See also

FormatValue.INHERIT
flash.text.engine.TabAlignment

decimalAlignmentToken | property |

`decimalAlignmentToken:*` [read-only]

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The alignment token to be used if the alignment is DECIMAL.

Default value is undefined indicating not set.

If undefined during the cascade this property will have a value of null.

Implementation
`public function get decimalAlignmentToken():*`
Throws

| `RangeError` — when set value is not within range for this property

position | property |

`position:*` [read-only]

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The position of the tab stop, in pixels, relative to the start edge of the column.

Legal values are numbers from 0 to 10000 and FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will have a value of 0.

Implementation
`public function get position():*`
Throws

| `RangeError` — when set value is not within range for this property

See also

FormatValue.INHERIT
Method Detail

getStyle | () | method

`public function getStyle(styleName:String):*`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Return the value of the style specified by the `styleProp` parameter which specifies the style name.

Parameters

| `styleName:String` — The name of the style whose value is to be retrieved.

Returns

| `*` — The value of the specified style. The type varies depending on the type of the style being accessed. Returns `undefined` if the style is not set.

Sun Mar 5 2017, 03:42 PM +11:00