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

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

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The TextScrap class represents a fragment of a text flow.

A TextScrap is a holding place for all or part of a TextFlow. A range of text can be copied from a TextFlow into a TextScrap, and pasted from the TextScrap into another TextFlow.

See also

flashx.textLayout.elements.TextFlow
flashx.textLayout.edit.SelectionManager

Public Properties

| Property | Defined By
--- | --- | ---
|  | textFlow : TextFlow [read-only] Gets the TextFlow that is currently in the TextScrap. | TextScrap

Public Methods

| Method | Defined By
--- | --- | ---
|  | TextScrap(textFlow:TextFlow = null) Creates a TextScrap object. | TextScrap
|  | clone():TextScrap Creates a duplicate copy of this TextScrap object. | TextScrap
|  | createTextScrap(range:TextRange):TextScrap [static] Creates a TextScrap object from a range of text represented by a TextRange object. | TextScrap

Property Detail

textFlow | property

`textFlow:TextFlow` [read-only]

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Gets the TextFlow that is currently in the TextScrap.

Implementation
`public function get textFlow():TextFlow`
Constructor Detail

TextScrap | () | Constructor

`public function TextScrap(textFlow:TextFlow = null)`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Creates a TextScrap object.

Use the `createTextScrap()` method to create a TextScrap object from a range of text represented by a TextRange object.

Parameters

| `textFlow:TextFlow` (default = `null`)`` — if set, the new TextScrap object contains the entire text flow. Otherwise, the TextScrap object is empty.

Method Detail

clone | () | method

`public function clone():TextScrap`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Creates a duplicate copy of this TextScrap object.

Returns

| `TextScrap` — TextScrap A copy of this TextScrap.

createTextScrap | () | method |

`public static function createTextScrap(range:TextRange):TextScrap`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Creates a TextScrap object from a range of text represented by a TextRange object.

Parameters

| `range:TextRange` — the TextRange object representing the range of text to copy.

Returns

| `TextScrap`

isPlainText | () | method |

`tlf_internal function isPlainText():Boolean`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Returns true if the text is plain text (not formatted)

Returns

| `Boolean`

setPlainText | () | method |

`tlf_internal function setPlainText(plainText:Boolean):void`

Marks the TextScrap's content as being either plain or formatted

Parameters

| `plainText:Boolean`

Constant Detail

MERGE_TO_NEXT_ON_PASTE | Constant

`tlf_internal static const MERGE_TO_NEXT_ON_PASTE:String = mergeToNextOnPaste`

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