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

Package | flashx.textLayout.edit
Class | public class ElementRange
Inheritance | ElementRange Object

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The ElementRange class represents the range of objects selected within a text flow.

The beginning elements (such as `firstLeaf`) are always less than or equal to the end elements (in this case, `lastLeaf`) for each pair of values in an element range.

See also

flashx.textLayout.elements.TextFlow

Public Properties

| Property | Defined By
--- | --- | ---
|  | absoluteEnd : int The absolute text position of the FlowLeafElement object that contains the end of the range. | ElementRange
|  | absoluteStart : int The absolute text position of the FlowLeafElement object that contains the start of the range. | ElementRange
|  | characterFormat : ITextLayoutFormat [read-only] The format attributes of the characters in the range. | ElementRange
|  | containerFormat : ITextLayoutFormat [read-only] The format attributes of the container displaying the range. | ElementRange
|  | firstLeaf : FlowLeafElement The FlowLeafElement object that contains the start of the range. | ElementRange
|  | firstParagraph : ParagraphElement The ParagraphElement object that contains the start of the range. | ElementRange
|  | lastLeaf : FlowLeafElement The FlowLeafElement object that contains the end of the range. | ElementRange
|  | lastParagraph : ParagraphElement The ParagraphElement object that contains the end of the range. | ElementRange
|  | paragraphFormat : ITextLayoutFormat [read-only] The format attributes of the paragraph containing the range. | ElementRange
|  | textFlow : TextFlow The TextFlow object that contains the range. | ElementRange

Public Methods

| Method | Defined By
--- | --- | ---
|  | createElementRange(textFlow:TextFlow, absoluteStart:int, absoluteEnd:int):ElementRange [static] Creates an ElementRange object. | ElementRange
|  | getCommonCharacterFormat():TextLayoutFormat Gets the character format attributes that are common to all characters in the text range or current selection. | ElementRange
|  | getCommonContainerFormat():TextLayoutFormat Gets the container format attributes that are common to all containers in the element range. | ElementRange
|  | getCommonParagraphFormat():TextLayoutFormat Gets the paragraph format attributes that are common to all paragraphs in the element range. | ElementRange

Property Detail

absoluteEnd | property

`absoluteEnd:int`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The absolute text position of the FlowLeafElement object that contains the end of the range.

Implementation
`public function get absoluteEnd():int`
`public function set absoluteEnd(value:int):void`

absoluteStart | property |

`absoluteStart:int`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The absolute text position of the FlowLeafElement object that contains the start of the range.

Implementation
`public function get absoluteStart():int`
`public function set absoluteStart(value:int):void`

characterFormat | property |

`characterFormat:ITextLayoutFormat` [read-only]

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The format attributes of the characters in the range.

If the range spans more than one FlowElement object, which means that more than one character format may exist within the range, the format of the first FlowElement object is returned.

Implementation
`public function get characterFormat():ITextLayoutFormat`

containerFormat | property |

`containerFormat:ITextLayoutFormat` [read-only]

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The format attributes of the container displaying the range.

If the range spans more than one container, the format of the first container is returned.

Implementation
`public function get containerFormat():ITextLayoutFormat`

firstLeaf | property |

`firstLeaf:FlowLeafElement`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The FlowLeafElement object that contains the start of the range.

Implementation
`public function get firstLeaf():FlowLeafElement`
`public function set firstLeaf(value:FlowLeafElement):void`

firstParagraph | property |

`firstParagraph:ParagraphElement`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The ParagraphElement object that contains the start of the range.

Implementation
`public function get firstParagraph():ParagraphElement`
`public function set firstParagraph(value:ParagraphElement):void`

lastLeaf | property |

`lastLeaf:FlowLeafElement`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The FlowLeafElement object that contains the end of the range.

Implementation
`public function get lastLeaf():FlowLeafElement`
`public function set lastLeaf(value:FlowLeafElement):void`

lastParagraph | property |

`lastParagraph:ParagraphElement`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The ParagraphElement object that contains the end of the range.

Implementation
`public function get lastParagraph():ParagraphElement`
`public function set lastParagraph(value:ParagraphElement):void`

paragraphFormat | property |

`paragraphFormat:ITextLayoutFormat` [read-only]

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The format attributes of the paragraph containing the range.

If the range spans more than one paragraph, the format of the first paragraph is returned.

Implementation
`public function get paragraphFormat():ITextLayoutFormat`

textFlow | property |

`textFlow:TextFlow`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The TextFlow object that contains the range.

Implementation
`public function get textFlow():TextFlow`
`public function set textFlow(value:TextFlow):void`
Method Detail

createElementRange | () | method

`public static function createElementRange(textFlow:TextFlow, absoluteStart:int, absoluteEnd:int):ElementRange`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Creates an ElementRange object.

Parameters

| `textFlow:TextFlow` — the text flow
| `absoluteStart:int` — absolute text position of the first character in the text range
| `absoluteEnd:int` — one beyond the absolute text position of the last character in the text range

Returns

| `ElementRange`

getCommonCharacterFormat | () | method |

`public function getCommonCharacterFormat():TextLayoutFormat`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Gets the character format attributes that are common to all characters in the text range or current selection.

Format attributes that do not have the same value for all characters in the element range are set to `null` in the returned TextLayoutFormat instance.

Returns

| `TextLayoutFormat` — The common character style settings

getCommonContainerFormat | () | method |

`public function getCommonContainerFormat():TextLayoutFormat`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Gets the container format attributes that are common to all containers in the element range.

Format attributes that do not have the same value for all containers in the element range are set to `null` in the returned TextLayoutFormat instance.

Returns

| `TextLayoutFormat` — The common paragraph style settings

See also

flashx.textLayout.edit.ISelectionManager.getCommonParagraphFormat

getCommonParagraphFormat | () | method |

`public function getCommonParagraphFormat():TextLayoutFormat`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Gets the paragraph format attributes that are common to all paragraphs in the element range.

Format attributes that do not have the same value for all paragraphs in the element range are set to `null` in the returned TextLayoutFormat instance.

Returns

| `TextLayoutFormat` — The common paragraph style settings

See also

flashx.textLayout.edit.ISelectionManager.getCommonParagraphFormat

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