Packageflashx.textLayout.operations
Classpublic class ApplyLinkOperation
InheritanceApplyLinkOperation Inheritance FlowTextOperation Inheritance FlowOperation Inheritance 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
 PropertyDefined By
 InheritedabsoluteEnd : int
The absolute end point of the range of text to which this operation is applied.
FlowTextOperation
 InheritedabsoluteStart : int
The absolute start point of the range of text to which this operation is applied.
FlowTextOperation
 InheritedbeginGeneration : uint
[read-only] The text flow generation before the operation.
FlowOperation
 InheritedendGeneration : 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
 InheritedoriginalSelectionState : SelectionState
The selection state at the start of the operation.
FlowTextOperation
  target : String
The target of the link.
ApplyLinkOperation
 InheritedtextFlow : TextFlow
The TextFlow object to which this operation is applied.
FlowOperation
 InheriteduserData : *
Arbitrary data associated with an element.
FlowOperation
Public Methods
 MethodDefined By
  
ApplyLinkOperation(operationState:SelectionState, href:String, target:String, extendToLinkBoundary:Boolean)
Creates an ApplyLinkOperation object.
ApplyLinkOperation
 Inherited
canUndo():Boolean
Test if this operation be placed on the undo stack.
FlowOperation
 Inherited
doOperation():Boolean
Executes the operation.
FlowOperation
 Inherited
[override] Re-executes the operation.
FlowTextOperation
 Inherited
Reverses the operation.
FlowOperation
Property Detail
extendToLinkBoundaryproperty
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
hrefproperty 
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
newLinkElementproperty 
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
targetproperty 
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.