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 |
Note: Application code does not typically need to create or use a TextLineFactoryBase object directly. Use one of the derived text factory classes instead.
See also
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 | ||
prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | ||
textLineCreator : flashx.textLayout.compose:ITextLineCreator
The ITextLineCreator instance used to create lines of text. | 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 |
Method | Defined By | ||
---|---|---|---|
Base-class constructor for text line factories. | TextLineFactoryBase | ||
The smallest rectangle in which the layed-out content fits. | TextLineFactoryBase | ||
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 |
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.
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
).
public function get horizontalScrollPolicy():String
public function set horizontalScrollPolicy(value:String):void
See also
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.
public function get isTruncated():Boolean
textLineCreator | property |
textLineCreator:flashx.textLayout.compose:ITextLineCreator
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
The ITextLineCreator instance used to create lines of text.
Applications can provide a custom implementation of ITextLineCreator to use fonts embedded in a different SWF file or to cache and reuse text lines.
public function get textLineCreator():flashx.textLayout.compose:ITextLineCreator
public function set textLineCreator(value:flashx.textLayout.compose:ITextLineCreator):void
See also
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.
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
).
public function get verticalScrollPolicy():String
public function set verticalScrollPolicy(value:String):void
See also
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.
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.
ReturnsRectangle |