Adobe® Flex® 4 Language Reference
Hide Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
flash.text.ime 
CompositionAttributeRange 
Packageflash.text.ime
Classpublic final class CompositionAttributeRange
InheritanceCompositionAttributeRange Inheritance Object

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

The CompositionAttributeRange class represents a range of composition attributes for use with IME events. For example, when editing text in the IME, the text is divided by the IME into composition ranges. These composition ranges are flagged as selected (i.e. currently being lengthened, shortened, or edited), and/or converted (i.e. they have made one pass through the IME dictionary lookup already).

By convention, the client should adorn these composition ranges with underlining or hiliting according to the flags.

For example:

     !converted              = thick gray underline (raw text)
     !selected && converted  = thin black underline
      selected && converted  = thick black underline



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  converted : Boolean
The converted flag, meaning this clause has been processed by the IME and is awaiting acceptance/confirmation by the user
CompositionAttributeRange
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  relativeEnd : int
The relative end of the composition clause, relative to the beginning of the inline edit session.
CompositionAttributeRange
  relativeStart : int
The relative start from the beginning of the inline edit session i.e.
CompositionAttributeRange
  selected : Boolean
The selected flag, meaning this composition clause is active and being lengthened or shortened or edited with the IME, and the neighboring clauses are not.
CompositionAttributeRange
Public Methods
 MethodDefined By
  
CompositionAttributeRange(relativeStart:int, relativeEnd:int, selected:Boolean, converted:Boolean)
Creates a CompositionAttributeRange object.
CompositionAttributeRange
 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
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
Returns the primitive value of the specified object.
Object
Property Detail

converted

property
public var converted:Boolean

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0 Flash Player 10.1

The converted flag, meaning this clause has been processed by the IME and is awaiting acceptance/confirmation by the user

relativeEnd

property 
public var relativeEnd:int

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0 Flash Player 10.1

The relative end of the composition clause, relative to the beginning of the inline edit session. i.e. 0 = the start of the text the IME can see (there may be text before that in the edit field)

relativeStart

property 
public var relativeStart:int

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0 Flash Player 10.1

The relative start from the beginning of the inline edit session i.e. 0 = the start of the text the IME can see (there may be text before that in the edit field)

selected

property 
public var selected:Boolean

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0 Flash Player 10.1

The selected flag, meaning this composition clause is active and being lengthened or shortened or edited with the IME, and the neighboring clauses are not.

Constructor Detail

CompositionAttributeRange

()Constructor
public function CompositionAttributeRange(relativeStart:int, relativeEnd:int, selected:Boolean, converted:Boolean)

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0 Flash Player 10.1

Creates a CompositionAttributeRange object.

Parameters
relativeStart:int — The zero based index of the first character included in the character range.
 
relativeEnd:int — The zero based index of the last character included in the character range.
 
selected:Boolean — The selected flag
 
converted:Boolean — The converted flag