ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
flashx.textLayout.operations 

CreateSubParagraphGroupOperation  - AS3

Packageflashx.textLayout.operations
Classpublic class CreateSubParagraphGroupOperation
InheritanceCreateSubParagraphGroupOperation Inheritance FlowTextOperation Inheritance FlowOperation Inheritance Object

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

The CreateSPGEOperation class encapsulates creating a SubPargraphGroupElement


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
  format : flashx.textLayout.formats:ITextLayoutFormat
Format to be applied to the new SubParagraphGroupElement
CreateSubParagraphGroupOperation
  newSubParagraphGroupElement : SubParagraphGroupElement
[read-only] The new SubParagraphGroupElement.
CreateSubParagraphGroupOperation
 InheritedoriginalSelectionState : SelectionState
The selection state at the start of the operation.
FlowTextOperation
  parent : FlowGroupElement
Specifies the element this operation modifies.
CreateSubParagraphGroupOperation
 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
  
CreateSubParagraphGroupOperation(operationState:SelectionState, parent:FlowGroupElement = null, format:flashx.textLayout.formats:ITextLayoutFormat = null)
Constructor.
CreateSubParagraphGroupOperation
 Inherited
canUndo():Boolean
Test if this operation be placed on the undo stack.
FlowOperation
 Inherited
doOperation():Boolean
Executes the operation.
FlowOperation
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
redo():SelectionState
[override] Re-executes the operation.
FlowTextOperation
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
undo():SelectionState
Reverses the operation.
FlowOperation
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Property Detail

format

property
format:flashx.textLayout.formats:ITextLayoutFormat

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

Format to be applied to the new SubParagraphGroupElement



Implementation
    public function get format():flashx.textLayout.formats:ITextLayoutFormat
    public function set format(value:flashx.textLayout.formats:ITextLayoutFormat):void

newSubParagraphGroupElement

property 
newSubParagraphGroupElement:SubParagraphGroupElement  [read-only]

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

The new SubParagraphGroupElement.



Implementation
    public function get newSubParagraphGroupElement():SubParagraphGroupElement

parent

property 
parent:FlowGroupElement

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

Specifies the element this operation modifies.



Implementation
    public function get parent():FlowGroupElement
    public function set parent(value:FlowGroupElement):void
Constructor Detail

CreateSubParagraphGroupOperation

()Constructor
public function CreateSubParagraphGroupOperation(operationState:SelectionState, parent:FlowGroupElement = null, format:flashx.textLayout.formats:ITextLayoutFormat = null)

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

Constructor. This operation creates a single SubParagraphGroupElement in the first paragraph of the selection range. That paragraph must have at least one character selected the paragraph terminator does not count towards that selection. Specifying the spgeParent creates an SubParagraphGroupElement int he part of the selection range included by that spgeParent.

Parameters
operationState:SelectionState — selection over which to apply the operation.
 
parent:FlowGroupElement (default = null) — optional parent for the spge element. If not specified one is chosen based on the selection
 
format:flashx.textLayout.formats:ITextLayoutFormat (default = null) — optional format to set in the new spge element.



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy