| Package | flashx.textLayout.elements |
| Class | public class Configuration |
| Inheritance | Configuration  Object |
| Implements | IConfiguration |
| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
TextFlow() constructor when you create a new TextFlow
instance. It allows the application to initially control how the Text Layout Framework behaves.
The Configuration class allows you to specify initial, paragraph and container formats for the text flow
through the textFlowInitialFormat property. It also allows you to specify initial format attributes for links, selection,
scrolling, and for handling the Tab and Enter keys.
See also
| Property | Defined By | ||
|---|---|---|---|
| cursorFunction : Function Specifies the callback used for custom cursor. | Configuration | ||
| defaultLinkActiveFormat : ITextLayoutFormat
Specifies the active character format attributes that initially apply for all links (LinkElement objects) in the text
flow. | Configuration | ||
| defaultLinkHoverFormat : ITextLayoutFormat
Specifies the initial character format attributes that apply to a link (LinkElement) in the text flow when
the cursor hovers over it. | Configuration | ||
| defaultLinkNormalFormat : ITextLayoutFormat
Specifies the initial link attributes for all LinkElement objects in the text flow. | Configuration | ||
| defaultListMarkerFormat : IListMarkerFormat
Specifies the active character format attributes that initially apply for all ListItems in the text
flow. | Configuration | ||
| enableAccessibility : Boolean
Specifies whether accessibility support is turned on or not. | Configuration | ||
| flowComposerClass : Class Specifies the type of flow composer to attach to a new TextFlow object by default. | Configuration | ||
| focusedSelectionFormat : SelectionFormat
The initial selection format (SelectionFormat) for a text flow (TextFlow) when its window has focus. | Configuration | ||
| inactiveSelectionFormat : SelectionFormat
The initial selection format (SelectionFormat) for a text flow (TextFlow) when its window is inactive. | Configuration | ||
| inlineGraphicResolverFunction : Function Specifies the callback used for resolving an inline graphic element. | Configuration | ||
| manageEnterKey : Boolean
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. | Configuration | ||
| manageTabKey : Boolean
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. | Configuration | ||
| overflowPolicy : String
Policy used for deciding whether the last line of a container fits in the container, or whether it overflows. | Configuration | ||
| releaseLineCreationData : Boolean Requests that the process of composing text release line creation data after composing each paragraph. | Configuration | ||
| scrollDragDelay : Number
Specifies a timed delay between one scroll and the next to prevent scrolling from going
too fast. | Configuration | ||
| scrollDragPixels : Number Specifies the default number of pixels to scroll when the user initiates auto scrolling by dragging
the selection. | Configuration | ||
| scrollMouseWheelMultiplier : Number Specifies the default number of pixels to scroll for Mouse wheel events. | Configuration | ||
| scrollPagePercentage : Number
Specifies the default percentage of the text flow to scroll for page scrolls. | Configuration | ||
| shiftEnterLevel : int
Determines how shift-enter is treated. | Configuration | ||
| textFlowInitialFormat : ITextLayoutFormat
Specifies the initial format TextLayoutFormat configuration for a text flow (TextFlow object). | Configuration | ||
| unfocusedSelectionFormat : SelectionFormat
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. | Configuration | ||
| Method | Defined By | ||
|---|---|---|---|
Configuration(initializeWithDefaults:Boolean = true) Constructor - creates a default configuration. | Configuration | ||
Creates a clone of the Configuration object. | Configuration | ||
| Constant | Defined By | ||
|---|---|---|---|
| SHIFT_RETURN_AS_HARD : int = 0 [static] | Configuration | ||
| SHIFT_RETURN_AS_HARD_IN_LIST : int = 1 [static] | Configuration | ||
| SHIFT_RETURN_AS_SOFT : int = 2 [static] | Configuration | ||
| cursorFunction | property |
cursorFunction:Function| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10.2, AIR 1.5 |
Specifies the callback used for custom cursor.
The callback takes a String object, string is cursor name and returns the value to
be used in MouseCursor.cursor.
This callback provides the user to customize the cursor
public function get cursorFunction():Function public function set cursorFunction(value:Function):void| defaultLinkActiveFormat | property |
defaultLinkActiveFormat:ITextLayoutFormat| 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.
public function get defaultLinkActiveFormat():ITextLayoutFormat public function set defaultLinkActiveFormat(value:ITextLayoutFormat):voidSee also
| defaultLinkHoverFormat | property |
defaultLinkHoverFormat:ITextLayoutFormat| 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.
public function get defaultLinkHoverFormat():ITextLayoutFormat public function set defaultLinkHoverFormat(value:ITextLayoutFormat):voidSee also
| defaultLinkNormalFormat | property |
defaultLinkNormalFormat:ITextLayoutFormat| 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.
public function get defaultLinkNormalFormat():ITextLayoutFormat public function set defaultLinkNormalFormat(value:ITextLayoutFormat):voidSee also
| defaultListMarkerFormat | property |
defaultListMarkerFormat:IListMarkerFormat| 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.
public function get defaultListMarkerFormat():IListMarkerFormat public function set defaultListMarkerFormat(value:IListMarkerFormat):voidSee also
| defaultShiftEnterLevel | property |
tlf_internal static var defaultShiftEnterLevel:int = 2| enableAccessibility | property |
enableAccessibility:Boolean| 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.
public function get enableAccessibility():Boolean public function set enableAccessibility(value:Boolean):voidSee also
| flowComposerClass | property |
flowComposerClass:Class| 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.
public function get flowComposerClass():Class public function set flowComposerClass(value:Class):voidSee also
| focusedSelectionFormat | property |
focusedSelectionFormat:SelectionFormat| 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.
public function get focusedSelectionFormat():SelectionFormat public function set focusedSelectionFormat(value:SelectionFormat):voidSee also
| inactiveSelectionFormat | property |
inactiveSelectionFormat:SelectionFormat| 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.DIFFERENCEThe result is no selection is displayed.
public function get inactiveSelectionFormat():SelectionFormat public function set inactiveSelectionFormat(value:SelectionFormat):voidSee also
| inlineGraphicResolverFunction | property |
inlineGraphicResolverFunction:Function| 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.
public function get inlineGraphicResolverFunction():Function public function set inlineGraphicResolverFunction(value:Function):voidSee also
| manageEnterKey | property |
manageEnterKey:Boolean| 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.
public function get manageEnterKey():Boolean public function set manageEnterKey(value:Boolean):void| manageTabKey | property |
manageTabKey:Boolean| 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.
public function get manageTabKey():Boolean public function set manageTabKey(value:Boolean):void| overflowPolicy | property |
overflowPolicy:String| 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.
public function get overflowPolicy():String public function set overflowPolicy(value:String):voidSee also
| releaseLineCreationData | property |
releaseLineCreationData:Boolean| 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.
public function get releaseLineCreationData():Boolean public function set releaseLineCreationData(value:Boolean):voidSee also
| scrollDragDelay | property |
scrollDragDelay:Number| 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.
public function get scrollDragDelay():Number public function set scrollDragDelay(value:Number):void| scrollDragPixels | property |
scrollDragPixels:Number| 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.
public function get scrollDragPixels():Number public function set scrollDragPixels(value:Number):void| scrollMouseWheelMultiplier | property |
scrollMouseWheelMultiplier:Number| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Specifies the default number of pixels to scroll for Mouse wheel events. Default value is 20.
public function get scrollMouseWheelMultiplier():Number public function set scrollMouseWheelMultiplier(value:Number):void| scrollPagePercentage | property |
scrollPagePercentage:Number| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Specifies the default percentage of the text flow to scroll for page scrolls. Default value is 7.0 / 8.0, or .875.
public function get scrollPagePercentage():Number public function set scrollPagePercentage(value:Number):void| shiftEnterLevel | property |
shiftEnterLevel:int| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Determines how shift-enter is treated. Shift-enter can be treated as a soft return or hard return. There are three possible levels. Level 0 means all shift-returns will be hard returns. Level 1 means shift-returns inside lists will be treated as hard returns. Otherwise they will be treated as hard returns. Level 2 means all shift-returns will be treated as soft returns.
Default value is 2.
public function get shiftEnterLevel():int public function set shiftEnterLevel(value:int):void| textFlowInitialFormat | property |
textFlowInitialFormat:ITextLayoutFormat| 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.
public function get textFlowInitialFormat():ITextLayoutFormat public function set textFlowInitialFormat(value:ITextLayoutFormat):voidSee also
| unfocusedSelectionFormat | property |
unfocusedSelectionFormat:SelectionFormat| 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.DIFFERENCEThe result is no selection is displayed.
public function get unfocusedSelectionFormat():SelectionFormat public function set unfocusedSelectionFormat(value:SelectionFormat):voidSee also
| Configuration | () | Constructor |
public function Configuration(initializeWithDefaults:Boolean = true)| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Constructor - creates a default configuration.
ParametersinitializeWithDefaults:Boolean (default = true)true. If set to false, initializes
without default values, thereby saving some objects. The clone() method sets this
to false and copies the properties from the original object.
|
See also
| clone | () | method |
public function clone():Configuration| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Creates a clone of the Configuration object.
ReturnsConfiguration |
| hasTouchScreen | Constant |
tlf_internal static const hasTouchScreen:Boolean| SHIFT_RETURN_AS_HARD | Constant |
public static const SHIFT_RETURN_AS_HARD:int = 0| SHIFT_RETURN_AS_HARD_IN_LIST | Constant |
public static const SHIFT_RETURN_AS_HARD_IN_LIST:int = 1| SHIFT_RETURN_AS_SOFT | Constant |
public static const SHIFT_RETURN_AS_SOFT:int = 2