| Frames
| Package | flashx.textLayout.elements |
| Interface | public interface IConfiguration |
| Implementors | Configuration |
| Property | Defined By | ||
|---|---|---|---|
| flowComposerClass : Class [read-only] Specifies the type of flowComposer to attach to new TextFlow's by default. | IConfiguration | ||
| focusSelectionFormat : 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 | ||
| linkInitialActiveFormat : ICharacterFormat [read-only] Specifies the active character format attributes that initially apply for all links (LinkElement objects) in the text
flow. | IConfiguration | ||
| linkInitialHoverFormat : ICharacterFormat [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 | ||
| linkInitialLinkFormat : ICharacterFormat [read-only] Specifies the initial link attributes for all LinkElement objects in the text flow. | IConfiguration | ||
| manageEnterKey : Boolean [read-only] Specifies whether the Enter / Return key is entered as text by Text Layout, 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, or Flash Player or AIR handles it and
turns it into a tabbed panel event. | IConfiguration | ||
| noFocusSelectionFormat : SelectionFormat [read-only] The initial selection format that Text Layout uses to draw the selection when the window is active but none of the containers
in the TextFlow have focus. | IConfiguration | ||
| scrollDragDelay : int [read-only] When scrolling, you can specify a timed delay between one scroll and the next to prevent scrolling from going
too fast. | IConfiguration | ||
| scrollDragPixels : int [read-only] Specifies the default number of pixels to scroll when the user initiates auto scrolling by dragging
the selection. | IConfiguration | ||
| scrollMouseWheelMultiplier : int [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 | ||
| textFlowInitialCharacterFormat : ICharacterFormat [read-only] Specifies the initial character format (CharacterFormat) for a text flow (TextFlow). | IConfiguration | ||
| textFlowInitialContainerFormat : IContainerFormat [read-only] Specifies the initial container format (ContainerFormat) for the text flow (TextFlow). | IConfiguration | ||
| textFlowInitialParagraphFormat : IParagraphFormat [read-only] Specifies the initial paragraph format (ParagraphFormat) for a text flow (TextFlow). | IConfiguration | ||
| flowComposerClass | property |
flowComposerClass:Class [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies the type of flowComposer to attach to new TextFlow's by default. Default value is StandardFlowComposer.
public function get flowComposerClass():ClassSee also
| focusSelectionFormat | property |
focusSelectionFormat: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 uses
focusSelectionFormat
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.focusSelectionFormat
, if desired.
The SelectionFormat class specifies the default values, which invert the color of the text and its background.
public function get focusSelectionFormat():SelectionFormatSee also
| 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 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
noFocusSelectionFormat
the SelectionFormat values used are:
color = 0xffffff (white); alpha = 0; blendMode = flash.display.BlendMode.DIFFERENCE. The result is no
selection is displayed.
public function get inactiveSelectionFormat():SelectionFormatSee also
| linkInitialActiveFormat | property |
linkInitialActiveFormat:ICharacterFormat [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
.
public function get linkInitialActiveFormat():ICharacterFormatSee also
| linkInitialHoverFormat | property |
linkInitialHoverFormat:ICharacterFormat [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
.
public function get linkInitialHoverFormat():ICharacterFormatSee also
| linkInitialLinkFormat | property |
linkInitialLinkFormat:ICharacterFormat [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 values are: LinkElement.linkCharacterFormat.color = blue; LinkElement.linkCharacterFormat.textDecoration = flashx.textLayout.formats.TextDecoration.UNDERLINE.
public function get linkInitialLinkFormat():ICharacterFormatSee also
| manageEnterKey | property |
manageEnterKey:Boolean [read-only] Specifies whether the Enter / Return key is entered as text by Text Layout, 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| manageTabKey | 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, or Flash Player or AIR handles it and turns it into a tabbed panel event.
Default value is false.
public function get manageTabKey():Boolean| noFocusSelectionFormat | property |
noFocusSelectionFormat:SelectionFormat [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The initial selection format that Text Layout 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.noFocusSelectionFormat
, if desired.
If you do not override
noFocusSelectionFormat
the SelectionFormat values used are:
color = 0xffffff (white); alpha = 0; blendMode = flash.display.BlendMode.DIFFERENCE.The result is no
selection is displayed.
public function get noFocusSelectionFormat():SelectionFormatSee also
| scrollDragDelay | property |
scrollDragDelay:int [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
When scrolling, you can specify a timed delay between one scroll and the next to prevent scrolling from going too fast. This value specifies what the delay should be in milliseconds. The default value is 35.
public function get scrollDragDelay():int| scrollDragPixels | property |
scrollDragPixels:int [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.
public function get scrollDragPixels():int| scrollMouseWheelMultiplier | property |
scrollMouseWheelMultiplier:int [read-only] | 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():int| scrollPagePercentage | property |
scrollPagePercentage:Number [read-only] | 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| textFlowInitialCharacterFormat | property |
textFlowInitialCharacterFormat:ICharacterFormat [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies the initial character format (CharacterFormat) for a text flow (TextFlow).
Default is
null
.
public function get textFlowInitialCharacterFormat():ICharacterFormatSee also
| textFlowInitialContainerFormat | property |
textFlowInitialContainerFormat:IContainerFormat [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies the initial container format (ContainerFormat) for the text flow (TextFlow).
Default is
null
.
public function get textFlowInitialContainerFormat():IContainerFormatSee also
| textFlowInitialParagraphFormat | property |
textFlowInitialParagraphFormat:IParagraphFormat [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies the initial paragraph format (ParagraphFormat) for a text flow (TextFlow).
Default is
null
.
public function get textFlowInitialParagraphFormat():IParagraphFormatSee also
Send me an e-mail when comments are added to this page | Comment Report
Current page: http://livedocs.adobe.com/labs/textlayout/flashx/textLayout/elements/IConfiguration.html