flashx.textLayout.operations.DeleteTextOperation - Adobe® Flex® 4 Language Reference (Flex 4)

Package	flashx.textLayout.operations
Class	public class DeleteTextOperation
Inheritance	DeleteTextOperation FlowTextOperation FlowOperation Object

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

The DeleteTextOperation class encapsulates the deletion of a range of text.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		absoluteEnd : int The absolute end point of the range of text to which this operation is applied.	FlowTextOperation
		absoluteStart : int The absolute start point of the range of text to which this operation is applied.	FlowTextOperation
		allowMerge : Boolean Indicates whether this operation can be merged with operations executed before or after it.	DeleteTextOperation
		beginGeneration : uint [read-only] The text flow generation before the operation.	FlowOperation
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		deleteSelectionState : SelectionState deleteSelectionState The range of text to delete	DeleteTextOperation
		endGeneration : uint [read-only] The text flow generation after the operation.	FlowOperation
		originalSelectionState : SelectionState The selection state at the start of the operation.	FlowTextOperation
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		textFlow : flashx.textLayout.elements:TextFlow The TextFlow object to which this operation is applied.	FlowOperation
		userData : * Arbitrary data associated with an element.	FlowOperation

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		DeleteTextOperation(operationState:SelectionState, deleteSelectionState:SelectionState = null, allowMerge:Boolean = false) Creates a DeleteTextOperation operation.	DeleteTextOperation
		canUndo():Boolean Test if this operation be placed on the undo stack.	FlowOperation
		doOperation():Boolean Executes the operation.	FlowOperation
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		redo():SelectionState [override] Re-executes the operation.	FlowTextOperation
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		undo():SelectionState Reverses the operation.	FlowOperation
		valueOf():Object Returns the primitive value of the specified object.	Object

Property Detail

allowMerge

property

allowMerge:Boolean

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

Indicates whether this operation can be merged with operations executed before or after it.

Some delete operations, for example, a sequence of backspace keystrokes, can be fruitfully merged into one operation so that undoing the operation reverses the entire sequence.

Implementation
public function get allowMerge():Boolean
public function set allowMerge(value:Boolean):void

deleteSelectionState

property

deleteSelectionState:SelectionState

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

deleteSelectionState The range of text to delete

Implementation
public function get deleteSelectionState():SelectionState
public function set deleteSelectionState(value:SelectionState):void

Constructor Detail

DeleteTextOperation

()

Constructor

public function DeleteTextOperation(operationState:SelectionState, deleteSelectionState:SelectionState = null, allowMerge:Boolean = false)

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

Creates a DeleteTextOperation operation.

Parameters

	`operationState:SelectionState` — The original range of text.

	`deleteSelectionState:SelectionState` (default = `null`) — The range of text to delete, if different from the range described by `operationState`. (Set to `null` to delete the range described by `operationState`.)

	`allowMerge:Boolean` (default = `false`) — Set to `true` if this operation can be merged with the next or previous operation.