(Beta)
Package | flashx.textLayout.edit |
Class | public class TextScrap |
Inheritance | TextScrap Object |
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
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.
Related API Elements
Public Properties
Property | Defined By | ||
---|---|---|---|
constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | ||
textFlow : flashx.textLayout.elements:TextFlow [read-only]
Gets the TextFlow that is currently in the TextScrap. | TextScrap |
Public Methods
Method | Defined By | ||
---|---|---|---|
TextScrap(textFlow:flashx.textLayout.elements:TextFlow = null)
Creates a TextScrap object. | TextScrap | ||
Creates a duplicate copy of this TextScrap object. | TextScrap | ||
[static]
Creates a TextScrap object from a range of text represented by a TextRange object. | TextScrap | ||
Indicates whether an object has a specified property defined. | Object | ||
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | ||
Indicates whether the specified property exists and is enumerable. | Object | ||
Sets the availability of a dynamic property for loop operations. | Object | ||
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | ||
Returns the string representation of the specified object. | Object | ||
Returns the primitive value of the specified object. | Object |
Property Detail
textFlow | property |
textFlow:flashx.textLayout.elements: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():flashx.textLayout.elements:TextFlow
Constructor Detail
TextScrap | () | Constructor |
public function TextScrap(textFlow:flashx.textLayout.elements: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.
textFlow:flashx.textLayout.elements: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():flashx.textLayout.edit:TextScrap
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Creates a duplicate copy of this TextScrap object.
Returnsflashx.textLayout.edit:TextScrap — TextScrap A copy of this TextScrap.
|
createTextScrap | () | method |
public static function createTextScrap(range:flashx.textLayout.elements:TextRange):flashx.textLayout.edit: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:flashx.textLayout.elements:TextRange — the TextRange object representing the range of text to copy.
|
flashx.textLayout.edit: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)
ReturnsBoolean |
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"
Wed Nov 21 2018, 06:34 AM -08:00