ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
flashx.textLayout.formats 

IListMarkerFormat  - AS3

Packageflashx.textLayout.formats
Interfacepublic 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
 PropertyDefined By
  afterContent : *
[read-only] Specifies a string that goes after the marker.
IListMarkerFormat
 InheritedalignmentBaseline : *
[read-only] Specifies the baseline to which the dominant baseline aligns.
ITextLayoutFormat
 InheritedbackgroundAlpha : *
[read-only] Alpha (transparency) value for the background (adopts default value if undefined during cascade).
ITextLayoutFormat
 InheritedbackgroundColor : *
[read-only] Background color of the text (adopts default value if undefined during cascade).
ITextLayoutFormat
 InheritedbaselineShift : *
[read-only] Amount to shift the baseline from the dominantBaseline value.
ITextLayoutFormat
  beforeContent : *
[read-only] Specifies a string that goes before the marker.
IListMarkerFormat
 InheritedblockProgression : *
[read-only] Specifies a vertical or horizontal progression of line placement.
ITextLayoutFormat
 InheritedbreakOpportunity : *
[read-only] Controls where lines are allowed to break when breaking wrapping text into multiple lines.
ITextLayoutFormat
 InheritedcffHinting : *
[read-only] The type of CFF hinting used for this text.
ITextLayoutFormat
 InheritedclearFloats : *
[read-only] Controls how text wraps around a float.
ITextLayoutFormat
 Inheritedcolor : *
[read-only] Color of the text.
ITextLayoutFormat
 InheritedcolumnCount : *
[read-only] Number of text columns (adopts default value if undefined during cascade).
ITextLayoutFormat
 InheritedcolumnGap : *
[read-only] Specifies the amount of gutter space, in pixels, to leave between the columns (adopts default value if undefined during cascade).
ITextLayoutFormat
 InheritedcolumnWidth : *
[read-only] Column width in pixels (adopts default value if undefined during cascade).
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
 InheriteddigitCase : *
[read-only] The type of digit case used for this text.
ITextLayoutFormat
 InheriteddigitWidth : *
[read-only] Type of digit width used for this text.
ITextLayoutFormat
 Inheriteddirection : *
[read-only] Specifies the default bidirectional embedding level of the text in the text block.
ITextLayoutFormat
 InheriteddominantBaseline : *
[read-only] Specifies which element baseline snaps to the alignmentBaseline to determine the vertical position of the element on the line.
ITextLayoutFormat
 InheritedfirstBaselineOffset : *
[read-only] Specifies the baseline position of the first line in the container.
ITextLayoutFormat
 InheritedfontFamily : *
[read-only] The name of the font to use, or a comma-separated list of font names.
ITextLayoutFormat
 InheritedfontLookup : *
[read-only] Font lookup to use.
ITextLayoutFormat
 InheritedfontSize : *
[read-only] The size of the text in pixels.
ITextLayoutFormat
 InheritedfontStyle : *
[read-only] Style of text.
ITextLayoutFormat
 InheritedfontWeight : *
[read-only] Weight of text.
ITextLayoutFormat
 InheritedjustificationRule : *
[read-only] Rule used to justify text in a paragraph.
ITextLayoutFormat
 InheritedjustificationStyle : *
[read-only] The style used for justification of the paragraph.
ITextLayoutFormat
 Inheritedkerning : *
[read-only] Kerning adjusts the pixels between certain character pairs to improve readability.
ITextLayoutFormat
 InheritedleadingModel : *
[read-only] Specifies the leading model, which is a combination of leading basis and leading direction.
ITextLayoutFormat
 InheritedligatureLevel : *
[read-only] Controls which of the ligatures that are defined in the font may be used in the text.
ITextLayoutFormat
 InheritedlineBreak : *
[read-only] Controls word wrapping within the container (adopts default value if undefined during cascade).
ITextLayoutFormat
 InheritedlineHeight : *
[read-only] Leading controls for the text.
ITextLayoutFormat
 InheritedlineThrough : *
[read-only] If true, applies strikethrough, a line drawn through the middle of the text.
ITextLayoutFormat
 InheritedlinkActiveFormat : *
[read-only] Defines the formatting attributes used for links in normal state.
ITextLayoutFormat
 InheritedlinkHoverFormat : *
[read-only] Defines the formatting attributes used for links in hover state, when the mouse is within the bounds (rolling over) a link.
ITextLayoutFormat
 InheritedlinkNormalFormat : *
[read-only] Defines the formatting attributes used for links in normal state.
ITextLayoutFormat
 InheritedlistAutoPadding : *
[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
 InheritedlistMarkerFormat : *
[read-only] Defines the formatting attributes list markers.
ITextLayoutFormat
 InheritedlistStylePosition : *
[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
 InheritedlistStyleType : *
[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
 Inheritedlocale : *
[read-only] The locale of the text.
ITextLayoutFormat
 InheritedpaddingBottom : *
[read-only] Bottom inset in pixels.
ITextLayoutFormat
 InheritedpaddingLeft : *
[read-only] Left inset in pixels.
ITextLayoutFormat
 InheritedpaddingRight : *
[read-only] Right inset in pixels.
ITextLayoutFormat
 InheritedpaddingTop : *
[read-only] Top inset in pixels.
ITextLayoutFormat
 InheritedparagraphEndIndent : *
[read-only] A Number that specifies, in pixels, the amount to indent the paragraph's end edge.
ITextLayoutFormat
 InheritedparagraphSpaceAfter : *
[read-only] A Number that specifies the amount of space, in pixels, to leave after the paragraph.
ITextLayoutFormat
 InheritedparagraphSpaceBefore : *
[read-only] A Number that specifies the amount of space, in pixels, to leave before the paragraph.
ITextLayoutFormat
 InheritedparagraphStartIndent : *
[read-only] A Number that specifies, in pixels, the amount to indent the paragraph's start edge.
ITextLayoutFormat
 InheritedrenderingMode : *
[read-only] The rendering mode used for this text.
ITextLayoutFormat
 InheritedstyleName : *
[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
 InheritedtabStops : *
[read-only] Specifies the tab stops associated with the paragraph.
ITextLayoutFormat
 InheritedtextAlign : *
[read-only] Alignment of lines in the paragraph relative to the container.
ITextLayoutFormat
 InheritedtextAlignLast : *
[read-only] Alignment of the last (or only) line in the paragraph relative to the container in justified text.
ITextLayoutFormat
 InheritedtextAlpha : *
[read-only] Alpha (transparency) value for the text.
ITextLayoutFormat
 InheritedtextDecoration : *
[read-only] Decoration on text.
ITextLayoutFormat
 InheritedtextIndent : *
[read-only] A Number that specifies, in pixels, the amount to indent the first line of the paragraph.
ITextLayoutFormat
 InheritedtextJustify : *
[read-only] Specifies options for justifying text.
ITextLayoutFormat
 InheritedtextRotation : *
[read-only] Determines the number of degrees to rotate this text.
ITextLayoutFormat
 InheritedtrackingLeft : *
[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
 InheritedtrackingRight : *
[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
 InheritedtypographicCase : *
[read-only] The type of typographic case used for this text.
ITextLayoutFormat
 InheritedverticalAlign : *
[read-only] Vertical alignment or justification (adopts default value if undefined during cascade).
ITextLayoutFormat
 InheritedwhiteSpaceCollapse : *
[read-only] Collapses or preserves whitespace when importing text into a TextFlow.
ITextLayoutFormat
 InheritedwordSpacing : *
[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
 MethodDefined By
 Inherited
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():*