Adobe® Flex® 4 Language Reference
Hide Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
flashx.textLayout.operations 
InsertInlineGraphicOperation 
Packageflashx.textLayout.operations
Classpublic class InsertInlineGraphicOperation
InheritanceInsertInlineGraphicOperation Inheritance FlowTextOperation Inheritance FlowOperation Inheritance Object

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

The InsertInlineGraphicOperation class encapsulates the insertion of an inline graphic into a text flow.

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
  height : Object
The height of the image.
InsertInlineGraphicOperation
  options : Object
options are not supported
InsertInlineGraphicOperation
 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
  source : Object
Sets the source for the graphic.
InsertInlineGraphicOperation
 InheritedtextFlow : flashx.textLayout.elements:TextFlow
The TextFlow object to which this operation is applied.
FlowOperation
 InheriteduserData : *
Arbitrary data associated with an element.
FlowOperation
  width : Object
The width of the graphic.
InsertInlineGraphicOperation
Public Methods
 MethodDefined By
  
InsertInlineGraphicOperation(operationState:SelectionState, source:Object, width:Object, height:Object, options:Object = null)
Creates an InsertInlineGraphicsOperation object.
InsertInlineGraphicOperation
 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
  
[override] Re-executes the operation after it has been undone.
InsertInlineGraphicOperation
 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

height

property
height:Object

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

The height of the image. May be 'auto', a number of pixels or a percent of the measured height.

Legal values are flashx.textLayout.formats.FormatValue.AUTO and flashx.textLayout.formats.FormatValue.INHERIT.

Legal values as a number are from 0 to 32000.

Legal values as a percent are numbers from 0 to 1000000.

Default value is undefined indicating not set.

If undefined or "inherit" the InlineGraphicElement will use the default value of "auto".



Implementation
    public function get height():Object
    public function set height(value:Object):void

See also

flashx.textLayout.InlineGraphicElement.height

options

property 
options:Object

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

options are not supported



Implementation
    public function get options():Object
    public function set options(value:Object):void

source

property 
source:Object

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Sets the source for the graphic. The value can be either a String that is interpreted as a URI, a Class that's interpreted as the class of an embeddded DisplayObject, a DisplayObject instance, or a URLRequest. Creates a DisplayObject and, if the InlineGraphicElement object is added into a ParagraphElement in a TextFlow object, causes it to appear inline in the text.



Implementation
    public function get source():Object
    public function set source(value:Object):void

width

property 
width:Object

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

The width of the graphic. The value can be 'auto', a number of pixels or a percent of the measured width of the image.

Legal values are flashx.textLayout.formats.FormatValue.AUTO and flashx.textLayout.formats.FormatValue.INHERIT.

Legal values as a number are from 0 to 32000.

Legal values as a percent are numbers from 0 to 1000000.

Default value is undefined indicating not set.

If undefined or "inherit" the InlineGraphicElement will use the default value of "auto".



Implementation
    public function get width():Object
    public function set width(value:Object):void
Constructor Detail

InsertInlineGraphicOperation

()Constructor
public function InsertInlineGraphicOperation(operationState:SelectionState, source:Object, width:Object, height:Object, options:Object = null)

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Creates an InsertInlineGraphicsOperation object.

Parameters
operationState:SelectionState — Describes the insertion point. If a range is selected, the operation deletes the contents of that range.
 
source:Object — The graphic source (uri string, URLRequest, DisplayObject, or Class of an embedded asset).
 
width:Object — The width to assign (number of pixels, percent, or the string 'auto')
 
height:Object — The height to assign (number of pixels, percent, or the string 'auto')
 
options:Object (default = null) — None supported
Method Detail

redo

()method
override public function redo():SelectionState

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Re-executes the operation after it has been undone.

This function is called by the edit manager, when necessary.

Returns
SelectionState