| Package | flashx.textLayout.formats |
| Class | public class ListMarkerFormat |
| Inheritance | ListMarkerFormat  TextLayoutFormat Object |
| Implements | IListMarkerFormat |
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
More examples
Related API Elements
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| afterContent : * Specifies a string that goes after the marker. | ListMarkerFormat | ||
 | alignmentBaseline : *
Specifies the baseline to which the dominant baseline aligns. | TextLayoutFormat | |
| backgroundAlpha : *
Alpha (transparency) value for the background (adopts default value if undefined during cascade). | TextLayoutFormat | |
| backgroundColor : *
Background color of the text (adopts default value if undefined during cascade). | TextLayoutFormat | |
| baselineShift : *
Amount to shift the baseline from the dominantBaseline value. | TextLayoutFormat | |
| beforeContent : * Specifies a string that goes before the marker. | ListMarkerFormat | ||
| blockProgression : *
Specifies a vertical or horizontal progression of line placement. | TextLayoutFormat | |
| breakOpportunity : *
Controls where lines are allowed to break when breaking wrapping text into multiple lines. | TextLayoutFormat | |
| cffHinting : *
The type of CFF hinting used for this text. | TextLayoutFormat | |
| clearFloats : *
Controls how text wraps around a float. | TextLayoutFormat | |
| color : *
Color of the text. | TextLayoutFormat | |
| columnCount : *
Number of text columns (adopts default value if undefined during cascade). | TextLayoutFormat | |
| columnGap : *
Specifies the amount of gutter space, in pixels, to leave between the columns (adopts default value if undefined during cascade). | TextLayoutFormat | |
| columnWidth : *
Column width in pixels (adopts default value if undefined during cascade). | TextLayoutFormat | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| content : *
Controls the content of the marker. | ListMarkerFormat | ||
| coreStyles : Object [read-only] Returns the coreStyles on this TextLayoutFormat. | TextLayoutFormat | |
| counterIncrement : *
Controls incrementing the value of the counter. | ListMarkerFormat | ||
| counterReset : *
Controls resetting the value of the counter. | ListMarkerFormat | ||
| defaultFormat : flashx.textLayout.formats:ITextLayoutFormat [static] [read-only]
Returns a TextLayoutFormat object with default settings. | TextLayoutFormat | |
| digitCase : *
The type of digit case used for this text. | TextLayoutFormat | |
| digitWidth : *
Type of digit width used for this text. | TextLayoutFormat | |
| direction : *
Specifies the default bidirectional embedding level of the text in the text block. | TextLayoutFormat | |
| dominantBaseline : *
Specifies which element baseline snaps to the alignmentBaseline to determine the vertical position of the element on the line. | TextLayoutFormat | |
| firstBaselineOffset : *
Specifies the baseline position of the first line in the container. | TextLayoutFormat | |
| fontFamily : *
The name of the font to use, or a comma-separated list of font names. | TextLayoutFormat | |
| fontLookup : *
Font lookup to use. | TextLayoutFormat | |
| fontSize : *
The size of the text in pixels. | TextLayoutFormat | |
| fontStyle : *
Style of text. | TextLayoutFormat | |
| fontWeight : *
Weight of text. | TextLayoutFormat | |
| justificationRule : *
Rule used to justify text in a paragraph. | TextLayoutFormat | |
| justificationStyle : *
The style used for justification of the paragraph. | TextLayoutFormat | |
| kerning : *
Kerning adjusts the pixels between certain character pairs to improve readability. | TextLayoutFormat | |
| leadingModel : *
Specifies the leading model, which is a combination of leading basis and leading direction. | TextLayoutFormat | |
| ligatureLevel : *
Controls which of the ligatures that are defined in the font may be used in the text. | TextLayoutFormat | |
| lineBreak : *
Controls word wrapping within the container (adopts default value if undefined during cascade). | TextLayoutFormat | |
| lineHeight : *
Leading controls for the text. | TextLayoutFormat | |
| lineThrough : *
If true, applies strikethrough, a line drawn through the middle of the text. | TextLayoutFormat | |
| linkActiveFormat : *
Defines the formatting attributes used for links in normal state. | TextLayoutFormat | |
| linkHoverFormat : *
Defines the formatting attributes used for links in hover state, when the mouse is within the bounds (rolling over) a link. | TextLayoutFormat | |
| linkNormalFormat : *
Defines the formatting attributes used for links in normal state. | TextLayoutFormat | |
| listAutoPadding : *
This specifies an auto indent for the start edge of lists when the padding value of the list on that side is auto. | TextLayoutFormat | |
| listMarkerFormat : *
Defines the formatting attributes list markers. | TextLayoutFormat | |
| listStylePosition : *
Legal values are ListStylePosition.INSIDE, ListStylePosition.OUTSIDE, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade, this property inherits its value from an ancestor. | TextLayoutFormat | |
| listStyleType : *
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 inherits its value from an ancestor. | TextLayoutFormat | |
| locale : *
The locale of the text. | TextLayoutFormat | |
| paddingBottom : *
Bottom inset in pixels. | TextLayoutFormat | |
| paddingLeft : *
Left inset in pixels. | TextLayoutFormat | |
| paddingRight : *
Right inset in pixels. | TextLayoutFormat | |
| paddingTop : *
Top inset in pixels. | TextLayoutFormat | |
| paragraphEndIndent : *
A Number that specifies, in pixels, the amount to indent the paragraph's end edge. | TextLayoutFormat | |
| paragraphSpaceAfter : *
A Number that specifies the amount of space, in pixels, to leave after the paragraph. | TextLayoutFormat | |
| paragraphSpaceBefore : *
A Number that specifies the amount of space, in pixels, to leave before the paragraph. | TextLayoutFormat | |
| paragraphStartIndent : *
A Number that specifies, in pixels, the amount to indent the paragraph's start edge. | TextLayoutFormat | |
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| renderingMode : *
The rendering mode used for this text. | TextLayoutFormat | |
| styleName : *
Assigns an identifying class to the element, making it possible to set a style for the element by referencing the styleName. | TextLayoutFormat | |
| styles : Object [read-only] Returns the styles on this TextLayoutFormat. | TextLayoutFormat | |
| suffix : *
Controls the application of the suffix in the generated text in the ListItemElement. | ListMarkerFormat | ||
| tabStops : *
Specifies the tab stops associated with the paragraph. | TextLayoutFormat | |
| textAlign : *
Alignment of lines in the paragraph relative to the container. | TextLayoutFormat | |
| textAlignLast : *
Alignment of the last (or only) line in the paragraph relative to the container in justified text. | TextLayoutFormat | |
| textAlpha : *
Alpha (transparency) value for the text. | TextLayoutFormat | |
| textDecoration : *
Decoration on text. | TextLayoutFormat | |
| textIndent : *
A Number that specifies, in pixels, the amount to indent the first line of the paragraph. | TextLayoutFormat | |
| textJustify : *
Specifies options for justifying text. | TextLayoutFormat | |
| textRotation : *
Determines the number of degrees to rotate this text. | TextLayoutFormat | |
| trackingLeft : *
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. | TextLayoutFormat | |
| trackingRight : *
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. | TextLayoutFormat | |
| typographicCase : *
The type of typographic case used for this text. | TextLayoutFormat | |
| userStyles : Object [read-only] Returns the userStyles on this TextLayoutFormat. | TextLayoutFormat | |
| verticalAlign : *
Vertical alignment or justification (adopts default value if undefined during cascade). | TextLayoutFormat | |
| whiteSpaceCollapse : *
Collapses or preserves whitespace when importing text into a TextFlow. | TextLayoutFormat | |
| wordSpacing : *
Specifies the optimum, minimum, and maximum spacing (as a multiplier of the width of a normal space) between words to use during justification. | TextLayoutFormat | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
ListMarkerFormat(initialValues:IListMarkerFormat = null) Create a ListMarkerFormat that holds all the properties possible for a list marker. | ListMarkerFormat | ||
|
Replaces property values in this TextLayoutFormat object with the values of properties that are set in
the incoming ITextLayoutFormat instance. | TextLayoutFormat | |
|
Concatenates the values of properties in the incoming ITextLayoutFormat instance
with the values of this TextLayoutFormat object. | TextLayoutFormat | |
|
Concatenates the values of properties in the incoming ITextLayoutFormat instance
with the values of this TextLayoutFormat object. | TextLayoutFormat | |
|
Copies TextLayoutFormat settings from the values ITextLayoutFormat instance into this TextLayoutFormat object. | TextLayoutFormat | |
[static]
Creates a new ListMarkerFormat object. | ListMarkerFormat | ||
| [static]
Creates a new TextLayoutFormat object. | TextLayoutFormat | |
| Returns the value of the style specified by the styleProp parameter, which specifies
the style name. | TextLayoutFormat | |
|
Indicates whether an object has a specified property defined. | Object | |
| isEqual(p1:flashx.textLayout.formats:ITextLayoutFormat, p2:flashx.textLayout.formats:ITextLayoutFormat):Boolean [static]
Compares properties in ITextLayoutFormat instance p1 with properties in ITextLayoutFormat instance p2
and returns true if all properties match. | TextLayoutFormat | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets properties in this TextLayoutFormat object to undefined if they do not match those in the
incoming ITextLayoutFormat instance. | TextLayoutFormat | |
|
Sets properties in this TextLayoutFormat object to undefined if they match those in the incoming
ITextLayoutFormat instance. | TextLayoutFormat | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
| Sets the style specified by the styleProp parameter to the value specified by the
newValue parameter. | TextLayoutFormat | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
Property Detail
afterContent | property |
beforeContent | property |
content | property |
content:*| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
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'slistStyleTypeis replaced with the specified value.
If undefined, the default vaule of this property is "counter(ordered)".
Implementation
public function get content():* public function set content(value:any):voidThrows
RangeError — when set value is not within range for this property
|
counterIncrement | property |
counterIncrement:*| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
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 byinteger.
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():* public function set counterIncrement(value:any):voidThrows
RangeError — when set value is not within range for this property
|
counterReset | property |
counterReset:*| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
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 tointeger.
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():* public function set counterReset(value:any):voidThrows
RangeError — when set value is not within range for this property
|
suffix | property |
suffix:*| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
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():* public function set suffix(value:any):voidThrows
RangeError — when set value is not within range for this property
|
Related API Elements
Constructor Detail
ListMarkerFormat | () | Constructor |
public function ListMarkerFormat(initialValues:IListMarkerFormat = null)| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Create a ListMarkerFormat that holds all the properties possible for a list marker.
ParametersinitialValues:IListMarkerFormat (default = null) |
Method Detail
createListMarkerFormat | () | method |
public static function createListMarkerFormat(initialValues:Object):ListMarkerFormat| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Creates a new ListMarkerFormat object. All settings are empty or, optionally, are initialized from the
supplied initialValues object.
Parameters
initialValues:Object — Optional instance from which to copy initial values. If the object is of type IListMarkerFormat or ITextLayoutFormat, the values are copied.
Otherwise the initialValues parameter is treated like a Dictionary or Object and iterated over.
|
ListMarkerFormat — The new ListMarkerFormat object.
|
Related API Elements
Mon Nov 28 2011, 06:48 AM -08:00