| Package | flashx.textLayout.edit |
| Class | public class SelectionFormat |
| Inheritance | SelectionFormat  Object |
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
More examples
Related API Elements
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| pointAlpha : Number [read-only]
The alpha for drawing the cursor. | SelectionFormat | ||
| pointBlendMode : String [read-only]
The blend mode for drawing the cursor. | SelectionFormat | ||
| pointBlinkRate : Number [read-only]
The rate at which the cursor blinks, in milliseconds. | SelectionFormat | ||
| pointColor : uint [read-only]
The color for drawing the cursor. | SelectionFormat | ||
| rangeAlpha : Number [read-only]
The alpha for drawing the highlight of a range selection. | SelectionFormat | ||
| rangeBlendMode : String [read-only]
The blending mode for drawing the highlight of a range selection. | SelectionFormat | ||
| rangeColor : uint [read-only]
The color for drawing the highlight of a range selection. | SelectionFormat | ||
| Method | Defined By | ||
|---|---|---|---|
SelectionFormat(rangeColor:uint = 0xffffff, rangeAlpha:Number = 1.0, rangeBlendMode:String = "difference", pointColor:uint = 0xffffff, pointAlpha:Number = 1.0, pointBlendMode:String = "difference", pointBlinkRate:Number = 500)
Creates a SelectionFormat object with the specified properties. | SelectionFormat | ||
Determines whether this SelectionFormat object has the same property values
as another SelectionFormat object. | SelectionFormat | ||
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
pointAlpha | property |
pointAlpha:Number [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The alpha for drawing the cursor. Valid values are between 0 (completely transparent) and 1 (completely opaque, which is the default).
Setting the pointAlpha and rangeAlpha properties to zero disables selection highlighting.
Implementation
public function get pointAlpha():NumberRelated API Elements
pointBlendMode | property |
pointBlinkRate | property |
pointColor | property |
rangeAlpha | property |
rangeAlpha:Number [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The alpha for drawing the highlight of a range selection. Valid values are between 0 (completely transparent) and 1 (completely opaque, which is the default).
Setting the pointAlpha and rangeAlpha properties to zero disables selection highlighting.
Implementation
public function get rangeAlpha():NumberRelated API Elements
rangeBlendMode | property |
rangeColor | property |
SelectionFormat | () | Constructor |
public function SelectionFormat(rangeColor:uint = 0xffffff, rangeAlpha:Number = 1.0, rangeBlendMode:String = "difference", pointColor:uint = 0xffffff, pointAlpha:Number = 1.0, pointBlendMode:String = "difference", pointBlinkRate:Number = 500)| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Creates a SelectionFormat object with the specified properties.
A SelectionFormat created with the default values will use black for the highlight colors, 1.0 for the alphas, and BlendMode.DIFFERENCE for the blending modes. The cursor blink rate is 500 milliseconds.
Setting the pointAlpha and rangeAlpha properties to zero disables selection highlighting.
Non-zero blink rate is only used when an EditManager is attached to the TextFlow.
ParametersrangeColor:uint (default = 0xffffff) | |
rangeAlpha:Number (default = 1.0) | |
rangeBlendMode:String (default = "difference") | |
pointColor:uint (default = 0xffffff) | |
pointAlpha:Number (default = 1.0) | |
pointBlendMode:String (default = "difference") | |
pointBlinkRate:Number (default = 500) |
Related API Elements
equals | () | method |
public function equals(selectionFormat:SelectionFormat):Boolean| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Determines whether this SelectionFormat object has the same property values as another SelectionFormat object.
Parameters
selectionFormat:SelectionFormat — the SelectionFormat to compare against.
|
Boolean — true, if the property values are identical; false, otherwise.
|
Wed Nov 21 2018, 06:34 AM -08:00