Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
IConfiguration

Package | flashx.textLayout.elements
Interface | public interface IConfiguration
Implementors | Configuration

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Read-only interface to a configuration object. Used by TextFlow to guarantee it has an unchangeable configuration once its constructed.

Public Properties

| Property | Defined By
--- | --- | ---
|  | cursorFunction : Function [read-only] Specifies the callback used for custom cursor. | IConfiguration
|  | defaultLinkActiveFormat : ITextLayoutFormat [read-only] Specifies the active character format attributes that initially apply for all links (LinkElement objects) in the text flow. | IConfiguration
|  | defaultLinkHoverFormat : 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 : 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
|  | shiftEnterLevel : int [read-only] Determines how shift-enter is treated. | IConfiguration
|  | textFlowInitialFormat : 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

Public Methods

| Method | Defined By
--- | --- | ---
|  | clone():Configuration Creates a writeable clone of the IConfiguration object. | IConfiguration

Property Detail

cursorFunction | property

`cursorFunction:Function` [read-only]

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

Implementation
`public function get cursorFunction():Function`

defaultLinkActiveFormat | property |

`defaultLinkActiveFormat: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():ITextLayoutFormat`

See also

FlowElement.linkActiveFormat
ITextLayoutFormat
LinkElement

defaultLinkHoverFormat | property |

`defaultLinkHoverFormat: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():ITextLayoutFormat`

See also

FlowElement.linkHoverFormat
ITextLayoutFormat
LinkElement

defaultLinkNormalFormat | property |

`defaultLinkNormalFormat: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():ITextLayoutFormat`

See also

FlowElement.linkNormalFormat
ITextLayoutFormat
LinkElement

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():IListMarkerFormat`

See also

FlowElement.linkActiveFormat
ITextLayoutFormat
LinkElement

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():Boolean`

See also

TextFlow

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():Class`

See also

StandardFlowComposer
TextFlow

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():SelectionFormat`

See also

SelectionFormat
SelectionManager.focusedSelectionFormat
TextFlow

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 = 0`
- `blendMode = flash.display.BlendMode.DIFFERENCE`

The result is no selection is displayed.

Implementation
`public function get inactiveSelectionFormat():SelectionFormat`

See also

SelectionFormat
SelectionManager.inactiveSelectionFormat
TextFlow

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():Function`

See also

InlineGraphicElement

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():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 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():Boolean`

overflowPolicy | 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():String`

See also

OverflowPolicy

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():Boolean`

See also

StandardFlowComposer
TextBlock.releaseLineCreationData()

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():Number`

scrollDragPixels | 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():Number`

scrollMouseWheelMultiplier | property |

`scrollMouseWheelMultiplier:Number` [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.

Implementation
`public function get scrollMouseWheelMultiplier():Number`

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.

Implementation
`public function get scrollPagePercentage():Number`

shiftEnterLevel | property |

`shiftEnterLevel:int` [read-only]

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`.

Implementation
`public function get shiftEnterLevel():int`

textFlowInitialFormat | property |

`textFlowInitialFormat: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():ITextLayoutFormat`

See also

TextFlow
ITextLayoutFormat

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 = 0`
- `blendMode = flash.display.BlendMode.DIFFERENCE`

The result is no selection is displayed.

Implementation
`public function get unfocusedSelectionFormat():SelectionFormat`

See also

SelectionFormat
SelectionManager.unfocusedSelectionFormat
TextFlow
Method Detail

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.

Returns

| `Configuration`

Wed Nov 15 2017, 09:50 AM +01:00