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

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

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The ApplyLinkOperation class encapsulates a link creation or modification operation.

See also

flashx.textLayout.elements.LinkElement
flashx.textLayout.edit.EditManager
flashx.textLayout.events.FlowOperationEvent

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
|  | beginGeneration : uint [read-only] The text flow generation before the operation. | FlowOperation
|  | endGeneration : uint [read-only] The text flow generation after the operation. | FlowOperation
|  | extendToLinkBoundary : Boolean Whether to extend the selection to include the entire text of any existing links overlapped by the selection, and then apply the change. | ApplyLinkOperation
|  | href : String The URI to be associated with the link. | ApplyLinkOperation
|  | newLinkElement : LinkElement [read-only] The LinkElement that was created by doOperation. | ApplyLinkOperation
|  | originalSelectionState : SelectionState The selection state at the start of the operation. | FlowTextOperation
|  | target : String The target of the link. | ApplyLinkOperation
|  | textFlow : 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
--- | --- | ---
|  | ApplyLinkOperation(operationState:SelectionState, href:String, target:String, extendToLinkBoundary:Boolean) Creates an ApplyLinkOperation object. | ApplyLinkOperation
|  | canUndo():Boolean Test if this operation be placed on the undo stack. | FlowOperation
|  | doOperation():Boolean Executes the operation. | FlowOperation
|  | redo():SelectionState [override] Re-executes the operation. | FlowTextOperation
|  | undo():SelectionState Reverses the operation. | FlowOperation

Property Detail

extendToLinkBoundary | property

`extendToLinkBoundary:Boolean`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Whether to extend the selection to include the entire text of any existing links overlapped by the selection, and then apply the change.

Implementation
`public function get extendToLinkBoundary():Boolean`
`public function set extendToLinkBoundary(value:Boolean):void`

href | property |

`href:String`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The URI to be associated with the link. If href is an empty string, the URI of links in the selection are removed.

Implementation
`public function get href():String`
`public function set href(value:String):void`

newLinkElement | property |

`newLinkElement:LinkElement` [read-only]

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 2.0

The LinkElement that was created by doOperation.

Implementation
`public function get newLinkElement():LinkElement`

target | property |

`target:String`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The target of the link.

Implementation
`public function get target():String`
`public function set target(value:String):void`
Constructor Detail

ApplyLinkOperation | () | Constructor

`public function ApplyLinkOperation(operationState:SelectionState, href:String, target:String, extendToLinkBoundary:Boolean)`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Creates an ApplyLinkOperation object.

Parameters

| `operationState:SelectionState` — The text range to which the operation is applied.
| `href:String` — The URI to be associated with the link. If href is an empty string, the URI of links in the selection are removed.
| `target:String` — The target of the link.
| `extendToLinkBoundary:Boolean` — Whether to extend the selection to include the entire text of any existing links overlapped by the selection, and then apply the change.

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