flashx.textLayout.factory

# TextLineFactoryBase - AS3

Package | flashx.textLayout.factory
Class | public class TextLineFactoryBase
Inheritance | TextLineFactoryBase Object
Subclasses | StringTextLineFactory, TextFlowTextLineFactory

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

The TextLineFactoryBase class serves as the base class for the Text Layout Framework text line factories.

Note: Application code does not typically need to create or use a TextLineFactoryBase object directly. Use one of the derived text factory classes instead.

Related API Elements

flashx.textLayout.elements.TextFlow

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | compositionBounds : Rectangle The rectangle within which text lines are created. | TextLineFactoryBase
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | horizontalScrollPolicy : String Specifies how lines are created when the composition bounds are not large enough. | TextLineFactoryBase
|  | isTruncated : Boolean [read-only] Indicates whether text was truncated when lines were last created. | TextLineFactoryBase
|  | swfContext : ISWFContext The ISWFContext instance used to make FTE calls as needed. | TextLineFactoryBase
|  | truncationOptions : flashx.textLayout.factory:TruncationOptions Specifies the options for truncating the text if it doesn't fit in the composition bounds. | TextLineFactoryBase
|  | verticalScrollPolicy : String Specifies how lines are created when the composition bounds are not large enough. | TextLineFactoryBase

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | TextLineFactoryBase() Base-class constructor for text line factories. | TextLineFactoryBase
|  | getContentBounds():Rectangle The smallest rectangle in which the layed-out content fits. | TextLineFactoryBase
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | 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
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns the string representation of the specified object. | Object
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Property Detail

### compositionBounds

property

`compositionBounds:Rectangle`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

The rectangle within which text lines are created.

Implementation
`public function get compositionBounds():Rectangle`
`public function set compositionBounds(value:Rectangle):void`

### horizontalScrollPolicy

property

`horizontalScrollPolicy:String`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Specifies how lines are created when the composition bounds are not large enough.

If set to `ScrollPolicy.ON` or `ScrollPolicy.AUTO`, all lines are created. It is the your responsibility to scroll lines in the viewable area (and to mask lines outside this area, if necessary). If set to `ScrollPolicy.OFF`, then only lines that fit within the composition bounds are created.

If the `truncationOptions` property is set, the scroll policy is ignored (and treated as `ScrollPolicy.OFF`).

Implementation
`public function get horizontalScrollPolicy():String`
`public function set horizontalScrollPolicy(value:String):void`

Related API Elements

flashx.textLayout.compose.StandardFlowComposer
flashx.textLayout.container.ScrollPolicy
truncationOptions

### isTruncated

property

`isTruncated:Boolean` [read-only]

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Indicates whether text was truncated when lines were last created.

Implementation
`public function get isTruncated():Boolean`

### swfContext

property

`swfContext:ISWFContext`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

The ISWFContext instance used to make FTE calls as needed.

By default, the ISWFContext implementation is this FlowComposerBase object. Applications can provide a custom implementation to use fonts embedded in a different SWF file or to cache and reuse text lines.

Implementation
`public function get swfContext():ISWFContext`
`public function set swfContext(value:ISWFContext):void`

Related API Elements

flashx.textLayout.compose.ISWFContext

### truncationOptions

property

`truncationOptions:flashx.textLayout.factory:TruncationOptions`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Specifies the options for truncating the text if it doesn't fit in the composition bounds.

Implementation
`public function get truncationOptions():flashx.textLayout.factory:TruncationOptions`
`public function set truncationOptions(value:flashx.textLayout.factory:TruncationOptions):void`

### verticalScrollPolicy

property

`verticalScrollPolicy:String`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Specifies how lines are created when the composition bounds are not large enough.

If set to `ScrollPolicy.ON` or `ScrollPolicy.AUTO`, all lines are created. It is the your responsibility to scroll lines in the viewable area (and to mask lines outside this area, if necessary). If set to `ScrollPolicy.OFF`, then only lines that fit within the composition bounds are created.

If the `truncationOptions` property is set, the scroll policy is ignored (and treated as `ScrollPolicy.OFF`).

Implementation
`public function get verticalScrollPolicy():String`
`public function set verticalScrollPolicy(value:String):void`

Related API Elements

flashx.textLayout.compose.StandardFlowComposer
flashx.textLayout.container.ScrollPolicy
truncationOptions
Constructor Detail

### TextLineFactoryBase

()
Constructor

`public function TextLineFactoryBase()`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Base-class constructor for text line factories.

Note: Application code does not typically need to create or use a TextLineFactoryBase object directly. Use one of the derived text factory classes instead.

Method Detail

### getContentBounds

()
method

`public function getContentBounds():Rectangle`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

The smallest rectangle in which the layed-out content fits.

Note: Truncated lines are not included in the size calculation.

Returns

| `Rectangle`

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00