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

Package | flashx.textLayout.elements
Interface | public interface IFormatResolver

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Interface to a format resolver. An implementation allows you to attach a styling mechanism of your choosing, such as Flex CSS styling and named styles, to a TextFlow.

See also

TextFlow.formatResolver

Public Methods

| Method | Defined By
--- | --- | ---
|  | getResolverForNewFlow(oldFlow:TextFlow, newFlow:TextFlow):IFormatResolver Returns the format resolver when a TextFlow is copied. | IFormatResolver
|  | invalidate(target:Object):void Invalidates cached formatting information on this element because, for example, the parent changed, or the id or the styleName changed or the typeName changed. | IFormatResolver
|  | invalidateAll(textFlow:TextFlow):void Invalidates any cached formatting information for a TextFlow so that formatting must be recomputed. | IFormatResolver
|  | resolveFormat(target:Object):ITextLayoutFormat Given a FlowElement or ContainerController object, return any format settings for it. | IFormatResolver
|  | resolveUserFormat(target:Object, userFormat:String):* Given a FlowElement or ContainerController object and the name of a format property, return the format value or undefined if the value is not found. | IFormatResolver

Method Detail

getResolverForNewFlow | () | method

`public function getResolverForNewFlow(oldFlow:TextFlow, newFlow:TextFlow):IFormatResolver`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Returns the format resolver when a TextFlow is copied.

Parameters

| `oldFlow:TextFlow`
| `newFlow:TextFlow`

Returns

| `IFormatResolver` — the format resolver for the copy of the TextFlow.

invalidate | () | method |

`public function invalidate(target:Object):void`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Invalidates cached formatting information on this element because, for example, the `parent` changed, or the `id` or the `styleName` changed or the `typeName` changed.

Parameters

| `target:Object`

invalidateAll | () | method |

`public function invalidateAll(textFlow:TextFlow):void`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Invalidates any cached formatting information for a TextFlow so that formatting must be recomputed.

Parameters

| `textFlow:TextFlow`

resolveFormat | () | method |

`public function resolveFormat(target:Object):ITextLayoutFormat`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Given a FlowElement or ContainerController object, return any format settings for it.

Parameters

| `target:Object`

Returns

| `ITextLayoutFormat` — format settings for the specified object.

resolveUserFormat | () | method |

`public function resolveUserFormat(target:Object, userFormat:String):*`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Given a FlowElement or ContainerController object and the name of a format property, return the format value or `undefined` if the value is not found.

Parameters

| `target:Object`
| `userFormat:String`

Returns

| `*` — the value of the specified format for the specified object.

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