Adobe® Flex® 4 Language Reference
Hide Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
flashx.textLayout.operations 
ApplyLinkOperation 
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.

View the examples

See also



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
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 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
 InheritedoriginalSelectionState : SelectionState
The selection state at the start of the operation.
FlowTextOperation
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  target : String
The target of the link.
ApplyLinkOperation
 InheritedtextFlow : flashx.textLayout.elements: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
Test if this operation be placed on the undo stack.
FlowOperation
 Inherited
Executes the operation.
FlowOperation
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
[override] Re-executes the operation.
FlowTextOperation
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Reverses the operation.
FlowOperation
 Inherited
Returns the primitive value of the specified object.
Object
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

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.
ApplyLinkOperation_example.as

This code snippet shows a use of the ApplyLinkOperation class. Before an operation of this type is executed, the link being applied to this TextFlow is verified. If the link is invalid, the event is cancelled and the link is not applied.

package flashx.textLayout.operations.examples
{
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.events.FlowOperationEvent;
    import flashx.textLayout.operations.FlowOperation;
    import flashx.textLayout.operations.ApplyLinkOperation;
    
    public class ApplyLinkOperation_example
    {
        public function attach(textFlow:TextFlow):void
        {
            textFlow.addEventListener(FlowOperationEvent.FLOW_OPERATION_BEGIN, opBeginHandler);
        }
            
        public function opBeginHandler(evt:FlowOperationEvent):void { 
            var flowOp:FlowOperation = evt.operation; 
            if(flowOp is ApplyLinkOperation && evt.cancelable) {
                //if link is invalid, cancel link operation
                if(!linkValid(flowOp.textFlow)) {
                    evt.preventDefault();
                }
            }
        }
        private function linkValid(tf:TextFlow):Boolean { 
            //code to check inserted link text in this TextFlow for validity
            return false;
        }
    }
}