Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
GlobalSettings

Package | flashx.textLayout.elements
Class | public class GlobalSettings
Inheritance | GlobalSettings Object

Runtime Versions : | Flash Player 10, AIR 1.5

Configuration that applies to all TextFlow objects.

Public Properties

| Property | Defined By
--- | --- | ---
|  | enableSearch : Boolean [static] Controls whether the text will be visible to a search engine indexer. | GlobalSettings
|  | fontMapperFunction : Function [static] Specifies the callback used for font mapping. | GlobalSettings
|  | resolveFontLookupFunction : Function [static] Specifies the callback used for changing the FontLookup based on swfcontext. | GlobalSettings
|  | resourceStringFunction : Function [static] Function that takes two parameters, a resource id and an optional array of parameters to substitute into the string. | GlobalSettings

Property Detail

enableSearch | property

`enableSearch:Boolean`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Controls whether the text will be visible to a search engine indexer. Defaults to `true`.

Implementation
`public static function get enableSearch():Boolean`
`public static function set enableSearch(value:Boolean):void`

fontMapperFunction | property |

`fontMapperFunction:Function`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Specifies the callback used for font mapping. The callback takes a `flash.text.engine.FontDescription` object and updates it as needed. After setting a new font mapping callback, or changing the behavior of the exisiting font mapping callback, the client must explicitly call `flashx.textLayout.elements.TextFlow.invalidateAllFormats` for each impacted text flow. This ensures that whenever a leaf element in the text flow is next recomposed, the FontDescription applied to it is recalculated, and the the callback is invoked.

Implementation
`public static function get fontMapperFunction():Function`
`public static function set fontMapperFunction(value:Function):void`

See also

FontDescription
invalidateAllFormats

resolveFontLookupFunction | property |

`resolveFontLookupFunction:Function`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Specifies the callback used for changing the FontLookup based on swfcontext. The function will be called each time an ElementFormat is computed. It gives the client the opportunity to modify the FontLookup setting. The function is called with two parameters an ISWFContext and an ITextLayoutFormat. It must return a valid FontLookup.

Implementation
`public static function get resolveFontLookupFunction():Function`
`public static function set resolveFontLookupFunction(value:Function):void`

See also

flashx.textLayout.compose.ISWFContext
flashx.textLayout.formats.ITextLayoutFormat
flash.text.engine.ElementFormat
flash.text.engine.FontLookup

resourceStringFunction | property |

`resourceStringFunction:Function`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Function that takes two parameters, a resource id and an optional array of parameters to substitute into the string. The string is of form "Content {0} more content {1}". The parameters are read from the optional array and substituted for the bracketed substrings. TLF provides a default implementation with default strings. Clients may replace this function with their own implementation for localization.

Implementation
`public static function get resourceStringFunction():Function`
`public static function set resourceStringFunction(value:Function):void`

Sun Mar 5 2017, 03:42 PM +11:00