Packageflashx.textLayout.elements
Classpublic class Configuration
InheritanceConfiguration Inheritance Object
Implements IConfiguration

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

The Configuration class is a primary point of integration between the Text Layout Framework and an application. You can include a Configuration object as a parameter to the TextFlow() constructor when you create a new TextFlow instance. It allows the application to initially control how the Text Layout Framework behaves.

The Configuration class allows you to specify the initial character and paragraph formats for the text flow and the initial container format. It also allows you to specify initial format attributes for links, properties for scrolling, and settings for handling the Tab and Enter keys.

See also

ICharacterFormat
IContainerFormat
IParagraphFormat
SelectionFormat
TextDecoration
TextFlow

Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  flowComposerClass : Class
Specifies the type of flowComposer to attach to new TextFlow's by default.
Configuration
  focusSelectionFormat : SelectionFormat
The initial selection format (SelectionFormat) for a text flow (TextFlow) when its window has focus.
Configuration
  inactiveSelectionFormat : SelectionFormat
The initial selection format (SelectionFormat) for a text flow (TextFlow) when its window is inactive.
Configuration
  linkInitialActiveFormat : ICharacterFormat
Specifies the active character format attributes that initially apply for all links (LinkElement objects) in the text flow.
Configuration
  linkInitialHoverFormat : ICharacterFormat
Specifies the initial character format attributes that apply to a link (LinkElement) in the text flow when the cursor hovers over it.
Configuration
  linkInitialLinkFormat : ICharacterFormat
Specifies the initial link attributes for all LinkElement objects in the text flow.
Configuration
  manageEnterKey : Boolean
Specifies whether the Enter / Return key is entered as text by Text Layout, to split a paragraph for example, or the client code handles it.
Configuration
  manageTabKey : Boolean
Specifies whether the TAB key is entered as text by Text Layout, or Flash Player or AIR handles it and turns it into a tabbed panel event.
Configuration
  noFocusSelectionFormat : SelectionFormat
The initial selection format that Text Layout uses to draw the selection when the window is active but none of the containers in the TextFlow have focus.
Configuration
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  scrollDragDelay : int
When scrolling, you can specify a timed delay between one scroll and the next to prevent scrolling from going too fast.
Configuration
  scrollDragPixels : int
Specifies the default number of pixels to scroll when the user initiates auto scrolling by dragging the selection.
Configuration
  scrollMouseWheelMultiplier : int
Specifies the default number of pixels to scroll for Mouse wheel events.
Configuration
  scrollPagePercentage : Number
Specifies the default percentage of the text flow to scroll for page scrolls.
Configuration
  textFlowInitialCharacterFormat : ICharacterFormat
Specifies the initial character format (CharacterFormat) for a text flow (TextFlow).
Configuration
  textFlowInitialContainerFormat : IContainerFormat
Specifies the initial container format (ContainerFormat) for the text flow (TextFlow).
Configuration
  textFlowInitialParagraphFormat : IParagraphFormat
Specifies the initial paragraph format (ParagraphFormat) for a text flow (TextFlow).
Configuration
Public Methods
 MethodDefined By
  
Configuration()
Constructor - creates a default configuration.
Configuration
  
clone():Configuration
Creates a clone of the Configuration object.
Configuration
 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
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Property Detail
flowComposerClassproperty
flowComposerClass:Class  [read-write]

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

Specifies the type of flowComposer to attach to new TextFlow's by default. Default value is StandardFlowComposer.



Implementation
    public function get flowComposerClass():Class
    public function set flowComposerClass(value:Class):void
focusSelectionFormatproperty 
focusSelectionFormat:SelectionFormat  [read-write]

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

The initial selection format (SelectionFormat) for a text flow (TextFlow) when its window has focus. Text Layout uses focusSelectionFormat to draw the selection when the window is active and one of the containers in the TextFlow has focus. You can override this format using SelectionManager.focusSelectionFormat , if desired.

The SelectionFormat class specifies the default values, which invert the color of the text and its background.



Implementation
    public function get focusSelectionFormat():SelectionFormat
    public function set focusSelectionFormat(value:SelectionFormat):void

See also

TextFlow
inactiveSelectionFormatproperty 
inactiveSelectionFormat:SelectionFormat  [read-write]

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

The initial selection format (SelectionFormat) for a text flow (TextFlow) when its window is inactive. Text Layout uses inactiveSelectionFormat for drawing the selection when the window is inactive. You can override this format using SelectionManager.inactiveSelectionFormat , if desired.

If you do not override noFocusSelectionFormat the SelectionFormat values used are: color = 0xffffff (white); alpha = 0; blendMode = flash.display.BlendMode.DIFFERENCE. The result is no selection is displayed.



Implementation
    public function get inactiveSelectionFormat():SelectionFormat
    public function set inactiveSelectionFormat(value:SelectionFormat):void

See also

TextFlow
linkInitialActiveFormatproperty 
linkInitialActiveFormat:ICharacterFormat  [read-write]

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

Specifies the active character format attributes that initially apply for all links (LinkElement objects) in the text flow. These are defaults for new LinkElement objects that don't specify values for these attributes. Default is null .



Implementation
    public function get linkInitialActiveFormat():ICharacterFormat
    public function set linkInitialActiveFormat(value:ICharacterFormat):void

See also

LinkElement
linkInitialHoverFormatproperty 
linkInitialHoverFormat:ICharacterFormat  [read-write]

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

Specifies the initial character format attributes that apply to a link (LinkElement) in the text flow when the cursor hovers over it. These are defaults for new LinkElement objects that don't specify values for these attributes. Default is null .



Implementation
    public function get linkInitialHoverFormat():ICharacterFormat
    public function set linkInitialHoverFormat(value:ICharacterFormat):void

See also

LinkElement
linkInitialLinkFormatproperty 
linkInitialLinkFormat:ICharacterFormat  [read-write]

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

Specifies the initial link attributes for all LinkElement objects in the text flow. These are default values for new LinkElement objects that don't specify values for these attributes.

The default values are: LinkElement.linkCharacterFormat.color = blue; LinkElement.linkCharacterFormat.textDecoration = flashx.textLayout.formats.TextDecoration.UNDERLINE.



Implementation
    public function get linkInitialLinkFormat():ICharacterFormat
    public function set linkInitialLinkFormat(value:ICharacterFormat):void

See also

LinkElement
manageEnterKeyproperty 
manageEnterKey:Boolean  [read-write]

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

Specifies whether the Enter / Return key is entered as text by Text Layout, to split a paragraph for example, or the client code handles it. The client code might handle it by committing a form that has a default button for that purpose, for example.

Default value is true.



Implementation
    public function get manageEnterKey():Boolean
    public function set manageEnterKey(value:Boolean):void
manageTabKeyproperty 
manageTabKey:Boolean  [read-write]

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

Specifies whether the TAB key is entered as text by Text Layout, or Flash Player or AIR handles it and turns it into a tabbed panel event.

Default value is false.



Implementation
    public function get manageTabKey():Boolean
    public function set manageTabKey(value:Boolean):void
noFocusSelectionFormatproperty 
noFocusSelectionFormat:SelectionFormat  [read-write]

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

The initial selection format that Text Layout uses to draw the selection when the window is active but none of the containers in the TextFlow have focus. You can override this format using SelectionManager.noFocusSelectionFormat , if desired.

If you do not override noFocusSelectionFormat the SelectionFormat values used are: color = 0xffffff (white); alpha = 0; blendMode = flash.display.BlendMode.DIFFERENCE.The result is no selection is displayed.



Implementation
    public function get noFocusSelectionFormat():SelectionFormat
    public function set noFocusSelectionFormat(value:SelectionFormat):void

See also

TextFlow
scrollDragDelayproperty 
scrollDragDelay:int  [read-write]

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

When scrolling, you can specify a timed delay between one scroll and the next to prevent scrolling from going too fast. This value specifies what the delay should be in milliseconds. The default value is 35.



Implementation
    public function get scrollDragDelay():int
    public function set scrollDragDelay(value:int):void
scrollDragPixelsproperty 
scrollDragPixels:int  [read-write]

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

Specifies the default number of pixels to scroll when the user initiates auto scrolling by dragging the selection. Default value is 20.



Implementation
    public function get scrollDragPixels():int
    public function set scrollDragPixels(value:int):void
scrollMouseWheelMultiplierproperty 
scrollMouseWheelMultiplier:int  [read-write]

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

Specifies the default number of pixels to scroll for Mouse wheel events. Default value is 20.



Implementation
    public function get scrollMouseWheelMultiplier():int
    public function set scrollMouseWheelMultiplier(value:int):void
scrollPagePercentageproperty 
scrollPagePercentage:Number  [read-write]

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

Specifies the default percentage of the text flow to scroll for page scrolls. Default value is 7.0 / 8.0, or .875.



Implementation
    public function get scrollPagePercentage():Number
    public function set scrollPagePercentage(value:Number):void
textFlowInitialCharacterFormatproperty 
textFlowInitialCharacterFormat:ICharacterFormat  [read-write]

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

Specifies the initial character format (CharacterFormat) for a text flow (TextFlow). Default is null .



Implementation
    public function get textFlowInitialCharacterFormat():ICharacterFormat
    public function set textFlowInitialCharacterFormat(value:ICharacterFormat):void

See also

TextFlow
textFlowInitialContainerFormatproperty 
textFlowInitialContainerFormat:IContainerFormat  [read-write]

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

Specifies the initial container format (ContainerFormat) for the text flow (TextFlow). Default is null .



Implementation
    public function get textFlowInitialContainerFormat():IContainerFormat
    public function set textFlowInitialContainerFormat(value:IContainerFormat):void

See also

TextFlow
textFlowInitialParagraphFormatproperty 
textFlowInitialParagraphFormat:IParagraphFormat  [read-write]

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

Specifies the initial paragraph format (ParagraphFormat) for a text flow (TextFlow). Default is null .



Implementation
    public function get textFlowInitialParagraphFormat():IParagraphFormat
    public function set textFlowInitialParagraphFormat(value:IParagraphFormat):void

See also

TextFlow
Constructor Detail
Configuration()Constructor
public function Configuration()

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

Constructor - creates a default configuration.

See also

flashx.textLayout.formats.ICharacterFormat
flashx.textLayout.formats.IContainerFormat
flashx.textLayout.formats.IParagraphFormat
flashx.textLayout.edit.SelectionFormat
flashx.textLayout.formats.TextDecoration
Method Detail
clone()method
public function clone():Configuration

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

Creates a clone of the Configuration object.

Returns
Configuration



© 2004-2008 Adobe Systems Incorporated. All rights reserved.
Thu Nov 20 2008, 04:03 AM -08:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/labs/textlayout/flashx/textLayout/elements/Configuration.html