| Package | flashx.textLayout.elements |
| Interface | public interface IConfiguration |
| Implementors | Configuration |
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
| Property | Defined By | ||
|---|---|---|---|
| defaultLinkActiveFormat : flashx.textLayout.formats:ITextLayoutFormat [read-only]
Specifies the active character format attributes that initially apply for all links (LinkElement objects) in the text
flow. | IConfiguration | ||
| defaultLinkHoverFormat : flashx.textLayout.formats:ITextLayoutFormat [read-only]
Specifies the initial character format attributes that apply to a link (LinkElement) in the text flow when
the cursor hovers over it. | IConfiguration | ||
| defaultLinkNormalFormat : flashx.textLayout.formats:ITextLayoutFormat [read-only]
Specifies the initial link attributes for all LinkElement objects in the text flow. | IConfiguration | ||
| defaultListMarkerFormat : IListMarkerFormat [read-only]
Specifies the active character format attributes that initially apply for all ListItems in the text
flow. | IConfiguration | ||
| enableAccessibility : Boolean [read-only]
Specifies whether accessibility support is turned on or not. | IConfiguration | ||
| flowComposerClass : Class [read-only] Specifies the type of flow composer to attach to a new TextFlow object by default. | IConfiguration | ||
| focusedSelectionFormat : SelectionFormat [read-only]
The initial selection format (SelectionFormat) for a text flow (TextFlow) when its window has focus. | IConfiguration | ||
| inactiveSelectionFormat : SelectionFormat [read-only]
The initial selection format (SelectionFormat) for a text flow (TextFlow) when its window is inactive. | IConfiguration | ||
| inlineGraphicResolverFunction : Function [read-only] Specifies the callback used for resolving an inline graphic element. | IConfiguration | ||
| manageEnterKey : Boolean [read-only]
Specifies whether the Enter / Return key is entered as text by Text Layout Framework, to split a paragraph for example,
or the client code handles it. | IConfiguration | ||
| manageTabKey : Boolean [read-only]
Specifies whether the TAB key is entered as text by Text Layout Framework, or Flash Player or AIR handles it and
turns it into a tabbed panel event. | IConfiguration | ||
| overflowPolicy : String [read-only]
Policy used for deciding whether the last line of a container fits in the container, or whether it overflows. | IConfiguration | ||
| releaseLineCreationData : Boolean [read-only] Requests that the process of composing text release line creation data after composing each paragraph. | IConfiguration | ||
| scrollDragDelay : Number [read-only]
Specifies a timed delay between one scroll and the next to prevent scrolling from going
too fast. | IConfiguration | ||
| scrollDragPixels : Number [read-only] Specifies the default number of pixels to scroll when the user initiates auto scrolling by dragging
the selection. | IConfiguration | ||
| scrollMouseWheelMultiplier : Number [read-only] Specifies the default number of pixels to scroll for Mouse wheel events. | IConfiguration | ||
| scrollPagePercentage : Number [read-only]
Specifies the default percentage of the text flow to scroll for page scrolls. | IConfiguration | ||
| textFlowInitialFormat : flashx.textLayout.formats:ITextLayoutFormat [read-only]
Specifies the initial format TextLayoutFormat configuration for a text flow (TextFlow object). | IConfiguration | ||
| unfocusedSelectionFormat : SelectionFormat [read-only]
The initial selection format that Text Layout Framework uses to draw the selection when the window is active but none of the containers
in the TextFlow have focus. | IConfiguration | ||
| Method | Defined By | ||
|---|---|---|---|
Creates a writeable clone of the IConfiguration object. | IConfiguration | ||
defaultLinkActiveFormat | property |
defaultLinkActiveFormat:flashx.textLayout.formats:ITextLayoutFormat [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies the active character format attributes that initially apply for all links (LinkElement objects) in the text flow. These are defaults for new LinkElement objects that don't specify values for these attributes.
Default is null.
Implementation
public function get defaultLinkActiveFormat():flashx.textLayout.formats:ITextLayoutFormatRelated API Elements
defaultLinkHoverFormat | property |
defaultLinkHoverFormat:flashx.textLayout.formats:ITextLayoutFormat [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies the initial character format attributes that apply to a link (LinkElement) in the text flow when the cursor hovers over it. These are defaults for new LinkElement objects that don't specify values for these attributes.
Default is null.
Implementation
public function get defaultLinkHoverFormat():flashx.textLayout.formats:ITextLayoutFormatRelated API Elements
defaultLinkNormalFormat | property |
defaultLinkNormalFormat:flashx.textLayout.formats:ITextLayoutFormat [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies the initial link attributes for all LinkElement objects in the text flow. These are default values for new LinkElement objects that don't specify values for these attributes. The default normal format displays the link in blue with underlining.
Implementation
public function get defaultLinkNormalFormat():flashx.textLayout.formats:ITextLayoutFormatRelated API Elements
defaultListMarkerFormat | property |
defaultListMarkerFormat:IListMarkerFormat [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies the active character format attributes that initially apply for all ListItems in the text flow. These are defaults for new ListItemElements objects that don't specify values for these attributes.
Default is null.
Implementation
public function get defaultListMarkerFormat():IListMarkerFormatRelated API Elements
enableAccessibility | property |
enableAccessibility:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies whether accessibility support is turned on or not. If true, screen readers can read the TextFlow contents.
Default value is false.
Implementation
public function get enableAccessibility():BooleanRelated API Elements
flowComposerClass | property |
flowComposerClass:Class [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies the type of flow composer to attach to a new TextFlow object by default. Default value is StandardFlowComposer.
Implementation
public function get flowComposerClass():ClassRelated API Elements
focusedSelectionFormat | property |
focusedSelectionFormat:SelectionFormat [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The initial selection format (SelectionFormat) for a text flow (TextFlow) when its window has focus.
Text Layout Framework uses focusedSelectionFormat to draw the selection when the window is active and one of
the containers in the TextFlow has focus. You can override this format using
SelectionManager.focusedSelectionFormat, if desired.
The SelectionFormat class specifies the default values, which invert the color of the text and its background.
Implementation
public function get focusedSelectionFormat():SelectionFormatRelated API Elements
inactiveSelectionFormat | property |
inactiveSelectionFormat:SelectionFormat [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The initial selection format (SelectionFormat) for a text flow (TextFlow) when its window is inactive. Text Layout Framework uses
inactiveSelectionFormat for drawing the selection when the window is inactive. You can override
this format using SelectionManager.inactiveSelectionFormat, if desired.
If you do not override unfocusedSelectionFormat the SelectionFormat values used are:
color = 0xffffff(white)alpha = 0blendMode = flash.display.BlendMode.DIFFERENCE
The result is no selection is displayed.
Implementation
public function get inactiveSelectionFormat():SelectionFormatRelated API Elements
inlineGraphicResolverFunction | property |
inlineGraphicResolverFunction:Function [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies the callback used for resolving an inline graphic element.
The callback takes a flashx.textLayout.elements.InlineGraphicElement object and returns
the value to be used as the element's flashx.textLayout.elements.InlineGraphicElement#source.
This callback provides the mechanism to delay providing an inline graphic element's source until just before it is composed.
Note: this callback will be invoked only if a placeholder source of String type is already set. Moreover, it may be invoked multiple times.
Implementation
public function get inlineGraphicResolverFunction():FunctionRelated API Elements
manageEnterKey | property |
manageEnterKey:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies whether the Enter / Return key is entered as text by Text Layout Framework, to split a paragraph for example, or the client code handles it. The client code might handle it by committing a form that has a default button for that purpose, for example.
Default value is true.
Implementation
public function get manageEnterKey():BooleanmanageTabKey | property |
manageTabKey:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies whether the TAB key is entered as text by Text Layout Framework, or Flash Player or AIR handles it and turns it into a tabbed panel event.
Default value is false.
Implementation
public function get manageTabKey():BooleanoverflowPolicy | property |
overflowPolicy:String [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Policy used for deciding whether the last line of a container fits in the container, or whether it overflows. Use the constants of the OverflowPolicy class to set this property.
Default value is OverflowPolicy.FIT_DESCENDERS, which fits the line in the composition area if the area from the top to the baseline fits.
Implementation
public function get overflowPolicy():StringRelated API Elements
releaseLineCreationData | property |
releaseLineCreationData:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Requests that the process of composing text release line creation data after composing each paragraph. This request saves memory but slows down the composing process.
Default value is false.
Implementation
public function get releaseLineCreationData():BooleanRelated API Elements
scrollDragDelay | property |
scrollDragDelay:Number [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies a timed delay between one scroll and the next to prevent scrolling from going too fast. This value specifies what the delay is in milliseconds. The default value is 35.
Implementation
public function get scrollDragDelay():NumberscrollDragPixels | property |
scrollDragPixels:Number [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies the default number of pixels to scroll when the user initiates auto scrolling by dragging the selection. Default value is 20.
Implementation
public function get scrollDragPixels():NumberscrollMouseWheelMultiplier | property |
scrollPagePercentage | property |
textFlowInitialFormat | property |
textFlowInitialFormat:flashx.textLayout.formats:ITextLayoutFormat [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies the initial format TextLayoutFormat configuration for a text flow (TextFlow object).
Default is null.
Implementation
public function get textFlowInitialFormat():flashx.textLayout.formats:ITextLayoutFormatRelated API Elements
unfocusedSelectionFormat | property |
unfocusedSelectionFormat:SelectionFormat [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The initial selection format that Text Layout Framework uses to draw the selection when the window is active but none of the containers
in the TextFlow have focus. You can override this format using SelectionManager.unfocusedSelectionFormat, if desired.
If you do not override unfocusedSelectionFormat the SelectionFormat values used are:
color = 0xffffff(white)alpha = 0blendMode = flash.display.BlendMode.DIFFERENCE
The result is no selection is displayed.
Implementation
public function get unfocusedSelectionFormat():SelectionFormatRelated API Elements
clone | () | method |
public function clone():Configuration| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10.2, AIR 1.5 |
Creates a writeable clone of the IConfiguration object.
ReturnsConfiguration |
Thu Dec 4 2014, 05:50 PM -08:00