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

Package | flashx.textLayout.formats
Interface | public interface IListMarkerFormat extends ITextLayoutFormat
Implementors | ListMarkerFormat

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

This interface provides read access to ListMarkerFormat properties.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | afterContent : * [read-only] Specifies a string that goes after the marker. | IListMarkerFormat
|  | alignmentBaseline : * [read-only] Specifies the baseline to which the dominant baseline aligns. | ITextLayoutFormat
|  | backgroundAlpha : * [read-only] Alpha (transparency) value for the background (adopts default value if undefined during cascade). | ITextLayoutFormat
|  | backgroundColor : * [read-only] Background color of the text (adopts default value if undefined during cascade). | ITextLayoutFormat
|  | baselineShift : * [read-only] Amount to shift the baseline from the dominantBaseline value. | ITextLayoutFormat
|  | beforeContent : * [read-only] Specifies a string that goes before the marker. | IListMarkerFormat
|  | blockProgression : * [read-only] Specifies a vertical or horizontal progression of line placement. | ITextLayoutFormat
|  | borderBottomColor : * [read-only] Color of the bottom border (adopts default value if undefined during cascade). | ITextLayoutFormat
|  | borderBottomPriority : * [read-only] Specifies the priority when drawing cell boundaries. | ITextLayoutFormat
|  | borderBottomWidth : * [read-only] Bottom border width in pixels (adopts default value if undefined during cascade) Legal values are numbers from 0 to 128 and FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will have a value of 0. | ITextLayoutFormat
|  | borderLeftColor : * [read-only] Color of the left border (adopts default value if undefined during cascade). | ITextLayoutFormat
|  | borderLeftPriority : * [read-only] Specifies the priority when drawing cell boundaries. | ITextLayoutFormat
|  | borderLeftWidth : * [read-only] Left border width in pixels (adopts default value if undefined during cascade) Legal values are numbers from 0 to 128 and FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will have a value of 0. | ITextLayoutFormat
|  | borderRightColor : * [read-only] Color of the right border (adopts default value if undefined during cascade). | ITextLayoutFormat
|  | borderRightPriority : * [read-only] Specifies the priority when drawing cell boundaries. | ITextLayoutFormat
|  | borderRightWidth : * [read-only] Right border width in pixels (adopts default value if undefined during cascade) Legal values are numbers from 0 to 128 and FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will have a value of 0. | ITextLayoutFormat
|  | borderTopColor : * [read-only] Color of the top border (adopts default value if undefined during cascade). | ITextLayoutFormat
|  | borderTopPriority : * [read-only] Specifies the priority when drawing cell boundaries. | ITextLayoutFormat
|  | borderTopWidth : * [read-only] Top border width in pixels (adopts default value if undefined during cascade) Legal values are numbers from 0 to 128 and FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will have a value of 0. | ITextLayoutFormat
|  | breakOpportunity : * [read-only] Controls where lines are allowed to break when breaking wrapping text into multiple lines. | ITextLayoutFormat
|  | cellPadding : * [read-only] cellPadding specifies the amount of space between the border of the cell and its contents. | ITextLayoutFormat
|  | cellSpacing : * [read-only] cellSpacing specifies how much space the user agent should leave between the left side of the table and the left-hand side of the leftmost column, the top of the table and the top side of the topmost row, and so on for the right and bottom of the table. | ITextLayoutFormat
|  | cffHinting : * [read-only] The type of CFF hinting used for this text. | ITextLayoutFormat
|  | clearFloats : * [read-only] Controls how text wraps around a float. | ITextLayoutFormat
|  | color : * [read-only] Color of the text. | ITextLayoutFormat
|  | columnBreakAfter : * [read-only] Controls column after before the element. | ITextLayoutFormat
|  | columnBreakBefore : * [read-only] Controls column break before the element. | ITextLayoutFormat
|  | columnCount : * [read-only] Number of text columns (adopts default value if undefined during cascade). | ITextLayoutFormat
|  | columnGap : * [read-only] Specifies the amount of gutter space, in pixels, to leave between the columns (adopts default value if undefined during cascade). | ITextLayoutFormat
|  | columnWidth : * [read-only] Column width in pixels (adopts default value if undefined during cascade). | ITextLayoutFormat
|  | containerBreakAfter : * [read-only] Controls container after before the element. | ITextLayoutFormat
|  | containerBreakBefore : * [read-only] Controls container break before the element. | ITextLayoutFormat
|  | content : * [read-only] Controls the content of the marker. | IListMarkerFormat
|  | counterIncrement : * [read-only] Controls incrementing the value of the counter. | IListMarkerFormat
|  | counterReset : * [read-only] Controls resetting the value of the counter. | IListMarkerFormat
|  | digitCase : * [read-only] The type of digit case used for this text. | ITextLayoutFormat
|  | digitWidth : * [read-only] Type of digit width used for this text. | ITextLayoutFormat
|  | direction : * [read-only] Specifies the default bidirectional embedding level of the text in the text block. | ITextLayoutFormat
|  | dominantBaseline : * [read-only] Specifies which element baseline snaps to the alignmentBaseline to determine the vertical position of the element on the line. | ITextLayoutFormat
|  | firstBaselineOffset : * [read-only] Specifies the baseline position of the first line in the container. | ITextLayoutFormat
|  | fontFamily : * [read-only] The name of the font to use, or a comma-separated list of font names. | ITextLayoutFormat
|  | fontLookup : * [read-only] Font lookup to use. | ITextLayoutFormat
|  | fontSize : * [read-only] The size of the text in pixels. | ITextLayoutFormat
|  | fontStyle : * [read-only] Style of text. | ITextLayoutFormat
|  | fontWeight : * [read-only] Weight of text. | ITextLayoutFormat
|  | frame : * [read-only] frame specifies which sides of the frame surrounding a table will be visible. | ITextLayoutFormat
|  | justificationRule : * [read-only] Rule used to justify text in a paragraph. | ITextLayoutFormat
|  | justificationStyle : * [read-only] The style used for justification of the paragraph. | ITextLayoutFormat
|  | kerning : * [read-only] Kerning adjusts the pixels between certain character pairs to improve readability. | ITextLayoutFormat
|  | leadingModel : * [read-only] Specifies the leading model, which is a combination of leading basis and leading direction. | ITextLayoutFormat
|  | ligatureLevel : * [read-only] Controls which of the ligatures that are defined in the font may be used in the text. | ITextLayoutFormat
|  | lineBreak : * [read-only] Controls word wrapping within the container (adopts default value if undefined during cascade). | ITextLayoutFormat
|  | lineHeight : * [read-only] Leading controls for the text. | ITextLayoutFormat
|  | lineThrough : * [read-only] If true, applies strikethrough, a line drawn through the middle of the text. | ITextLayoutFormat
|  | linkActiveFormat : * [read-only] Defines the formatting attributes used for links in normal state. | ITextLayoutFormat
|  | linkHoverFormat : * [read-only] Defines the formatting attributes used for links in hover state, when the mouse is within the bounds (rolling over) a link. | ITextLayoutFormat
|  | linkNormalFormat : * [read-only] Defines the formatting attributes used for links in normal state. | ITextLayoutFormat
|  | listAutoPadding : * [read-only] This specifies an auto indent for the start edge of lists when the padding value of the list on that side is auto. | ITextLayoutFormat
|  | listMarkerFormat : * [read-only] Defines the formatting attributes list markers. | ITextLayoutFormat
|  | listStylePosition : * [read-only] Legal values are ListStylePosition.INSIDE, ListStylePosition.OUTSIDE, FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. | ITextLayoutFormat
|  | listStyleType : * [read-only] Legal values are ListStyleType.UPPER_ALPHA, ListStyleType.LOWER_ALPHA, ListStyleType.UPPER_ROMAN, ListStyleType.LOWER_ROMAN, ListStyleType.NONE, ListStyleType.DISC, ListStyleType.CIRCLE, ListStyleType.SQUARE, ListStyleType.BOX, ListStyleType.CHECK, ListStyleType.DIAMOND, ListStyleType.HYPHEN, ListStyleType.ARABIC_INDIC, ListStyleType.BENGALI, ListStyleType.DECIMAL, ListStyleType.DECIMAL_LEADING_ZERO, ListStyleType.DEVANAGARI, ListStyleType.GUJARATI, ListStyleType.GURMUKHI, ListStyleType.KANNADA, ListStyleType.PERSIAN, ListStyleType.THAI, ListStyleType.URDU, ListStyleType.CJK_EARTHLY_BRANCH, ListStyleType.CJK_HEAVENLY_STEM, ListStyleType.HANGUL, ListStyleType.HANGUL_CONSTANT, ListStyleType.HIRAGANA, ListStyleType.HIRAGANA_IROHA, ListStyleType.KATAKANA, ListStyleType.KATAKANA_IROHA, ListStyleType.LOWER_ALPHA, ListStyleType.LOWER_GREEK, ListStyleType.LOWER_LATIN, ListStyleType.UPPER_ALPHA, ListStyleType.UPPER_GREEK, ListStyleType.UPPER_LATIN, FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. | ITextLayoutFormat
|  | locale : * [read-only] The locale of the text. | ITextLayoutFormat
|  | marginBottom : * [read-only] bottom margin in pixels (adopts default value if undefined during cascade). | ITextLayoutFormat
|  | marginLeft : * [read-only] left margin in pixels(adopts default value if undefined during cascade). | ITextLayoutFormat
|  | marginRight : * [read-only] right margin in pixels (adopts default value if undefined during cascade). | ITextLayoutFormat
|  | marginTop : * [read-only] top margin in pixels (adopts default value if undefined during cascade). | ITextLayoutFormat
|  | maxCellHeight : * [read-only] Maximum height of a table cell. | ITextLayoutFormat
|  | minCellHeight : * [read-only] Minimum height of a table cell. | ITextLayoutFormat
|  | paddingBottom : * [read-only] Bottom inset in pixels. | ITextLayoutFormat
|  | paddingLeft : * [read-only] Left inset in pixels. | ITextLayoutFormat
|  | paddingRight : * [read-only] Right inset in pixels. | ITextLayoutFormat
|  | paddingTop : * [read-only] Top inset in pixels. | ITextLayoutFormat
|  | paragraphEndIndent : * [read-only] A Number that specifies, in pixels, the amount to indent the paragraph's end edge. | ITextLayoutFormat
|  | paragraphSpaceAfter : * [read-only] A Number that specifies the amount of space, in pixels, to leave after the paragraph. | ITextLayoutFormat
|  | paragraphSpaceBefore : * [read-only] A Number that specifies the amount of space, in pixels, to leave before the paragraph. | ITextLayoutFormat
|  | paragraphStartIndent : * [read-only] A Number that specifies, in pixels, the amount to indent the paragraph's start edge. | ITextLayoutFormat
|  | renderingMode : * [read-only] The rendering mode used for this text. | ITextLayoutFormat
|  | rules : * [read-only] rules specifies which rules will appear between cells within a table. | ITextLayoutFormat
|  | styleName : * [read-only] Assigns an identifying class to the element, making it possible to set a style for the element by referencing the styleName. | ITextLayoutFormat
|  | suffix : * [read-only] Controls the application of the suffix in the generated text in the ListItemElement. | IListMarkerFormat
|  | tableColumnWidth : * [read-only] Width of table column specifies a default width for each column spanned by the current COL element. | ITextLayoutFormat
|  | tableWidth : * [read-only] Width of table element specifies the desired width of the entire table and is intended for visual user agents. | ITextLayoutFormat
|  | tabStops : * [read-only] Specifies the tab stops associated with the paragraph. | ITextLayoutFormat
|  | textAlign : * [read-only] Alignment of lines in the paragraph relative to the container. | ITextLayoutFormat
|  | textAlignLast : * [read-only] Alignment of the last (or only) line in the paragraph relative to the container in justified text. | ITextLayoutFormat
|  | textAlpha : * [read-only] Alpha (transparency) value for the text. | ITextLayoutFormat
|  | textDecoration : * [read-only] Decoration on text. | ITextLayoutFormat
|  | textIndent : * [read-only] A Number that specifies, in pixels, the amount to indent the first line of the paragraph. | ITextLayoutFormat
|  | textJustify : * [read-only] Specifies options for justifying text. | ITextLayoutFormat
|  | textRotation : * [read-only] Determines the number of degrees to rotate this text. | ITextLayoutFormat
|  | trackingLeft : * [read-only] Number in pixels (or percent of fontSize, like 120%) indicating the amount of tracking (manual kerning) to be applied to the left of each character. | ITextLayoutFormat
|  | trackingRight : * [read-only] Number in pixels (or percent of fontSize, like 120%) indicating the amount of tracking (manual kerning) to be applied to the right of each character. | ITextLayoutFormat
|  | typographicCase : * [read-only] The type of typographic case used for this text. | ITextLayoutFormat
|  | verticalAlign : * [read-only] Vertical alignment or justification (adopts default value if undefined during cascade). | ITextLayoutFormat
|  | whiteSpaceCollapse : * [read-only] Collapses or preserves whitespace when importing text into a TextFlow. | ITextLayoutFormat
|  | wordSpacing : * [read-only] Specifies the optimum, minimum, and maximum spacing (as a multiplier of the width of a normal space) between words to use during justification. | ITextLayoutFormat

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

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

Property Detail

afterContent | property

`afterContent:*` [read-only]

Specifies a string that goes after the marker. Default is the empty string.

Implementation
`public function get afterContent():*`

beforeContent | property |

`beforeContent:*` [read-only]

Specifies a string that goes before the marker. Default is the empty string.

Implementation
`public function get beforeContent():*`

content | property |

`content:*` [read-only]

Controls the content of the marker.

Legal values for this string are:

- `none` - No marker.
- `counter(ordered)` - Display the marker.
- `counter(ordered,ListStyleType)` - Display the marker but change the listStyleType to the specified value.
- `counters(ordered)` - Starting from the top-most parent ListElement creating a string of values of the ordered counter in each counters specified listStyleType separated by the suffix for each. This is used for outline number - for example I.1., I.2. etc.
- `counters(ordered,"<string>")` - Similar to the previous value, except the suffix for each ordered counter is replaced by <string>.
- `counters(ordered,"<string>",ListStyleType)` - Similar to the previous value, except each counter's `listStyleType` is replaced with the specified value.

If undefined, the default vaule of this property is `"counter(ordered)"`.

Implementation
`public function get content():*`

counterIncrement | property |

`counterIncrement:*` [read-only]

Controls incrementing the value of the counter.

Legal values for this string are:

- `none` - No increment.
- `ordered` - Increment the counter by one.
- `ordered integer` - Increment the counter by `integer`.

If undefined, the default vaule of this property is `"ordered 1"`.

Note: The `counterIncrement` property is applied before the `counterReset` property.

Implementation
`public function get counterIncrement():*`

counterReset | property |

`counterReset:*` [read-only]

Controls resetting the value of the counter.

Legal values for this property are:

- `none` - No reset.
- `ordered` - Reset the counter to zero.
- `ordered integer` - Reset the counter to `integer`.

If `undefined`, the default value of this property is "none".

Note: The `counterReset` property is applied before the `counterIncrement` property.

Implementation
`public function get counterReset():*`

suffix | property |

`suffix:*` [read-only]

Controls the application of the suffix in the generated text in the ListItemElement.

Legal values are:

- `flashx.textLayout.formats.Suffix.NONE` - No suffix.
- `flashx.textLayout.formats.Suffix.AUTO` - Follow CSS rules for adding a suffix.

Default value is `Suffix.AUTO`.

Implementation
`public function get suffix():*`

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