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

Package | flashx.textLayout.operations
Class | public class InsertInlineGraphicOperation
Inheritance | InsertInlineGraphicOperation FlowTextOperation FlowOperation 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

flashx.textLayout.elements.InlineGraphicElement
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
|  | height : Object The height of the image. | InsertInlineGraphicOperation
|  | newInlineGraphicElement : InlineGraphicElement [read-only] The InlineGraphicElement that was created by doOperation. | InsertInlineGraphicOperation
|  | options : Object Controls the placement of the graphic relative to the text. | InsertInlineGraphicOperation
|  | originalSelectionState : SelectionState The selection state at the start of the operation. | FlowTextOperation
|  | source : Object Sets the source for the graphic. | InsertInlineGraphicOperation
|  | textFlow : TextFlow The TextFlow object to which this operation is applied. | FlowOperation
|  | userData : * Arbitrary data associated with an element. | FlowOperation
|  | width : Object The width of the graphic. | InsertInlineGraphicOperation

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | InsertInlineGraphicOperation(operationState:SelectionState, source:Object, width:Object, height:Object, options:Object = null) Creates an InsertInlineGraphicsOperation object. | InsertInlineGraphicOperation
|  | 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 after it has been undone. | InsertInlineGraphicOperation
|  | undo():SelectionState Reverses the operation. | FlowOperation

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

newInlineGraphicElement | property |

`newInlineGraphicElement:InlineGraphicElement` [read-only]

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The InlineGraphicElement that was created by doOperation.

Implementation
`public function get newInlineGraphicElement():InlineGraphicElement`

options | property |

`options:Object`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Controls the placement of the graphic relative to the text. It can be part of the line, or can be beside the line with the text wrapped around it.

Legal values are `flashx.textLayout.formats.Float.NONE`, `flashx.textLayout.formats.Float.LEFT`, `flashx.textLayout.formats.Float.RIGHT`, `flashx.textLayout.formats.Float.START`, and `flashx.textLayout.formats.Float.END`.

Default value is undefined indicating not set.

If undefined will be treated as `Float.NONE`.

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`)`` — The float to assign (String value, none for inline with text, left/right/start/end for float)

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`

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