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
  converted : Boolean
The converted flag, meaning this clause has been processed by the IME and is awaiting acceptance/confirmation by the user
CompositionAttributeRange
  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
Property Detail
convertedproperty
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

relativeEndproperty 
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)

relativeStartproperty 
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)

selectedproperty 
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



The Apache Software Foundation

Wed Nov 15 2017, 09:50 AM +01:00