| Package | flashx.textLayout.formats |
| Class | public class TabStopFormat |
| Inheritance | TabStopFormat  Object |
| Implements | ITabStopFormat |
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
TextLayoutFormat.tabstops property to an array of TabStopFormat objects.
Related API Elements
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| alignment : *
The tab alignment for this tab stop. | TabStopFormat | ||
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| decimalAlignmentToken : *
The alignment token to be used if the alignment is DECIMAL. | TabStopFormat | ||
| defaultFormat : flashx.textLayout.formats:ITabStopFormat [static] [read-only]
Returns a TabStopFormat object with default settings. | TabStopFormat | ||
| position : *
The position of the tab stop, in pixels, relative to the start edge of the column. | TabStopFormat | ||
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| Method | Defined By | ||
|---|---|---|---|
TabStopFormat(initialValues:flashx.textLayout.formats:ITabStopFormat = null)
Creates a new TabStopFormat object. | TabStopFormat | ||
Replaces property values in this TabStopFormat object with the values of properties that are set in
the incoming ITabStopFormat instance. | TabStopFormat | ||
Concatenates the values of properties in the incoming ITabStopFormat instance
with the values of this TabStopFormat object. | TabStopFormat | ||
Concatenates the values of properties in the incoming ITabStopFormat instance
with the values of this TabStopFormat object. | TabStopFormat | ||
Copies TabStopFormat settings from the values ITabStopFormat instance into this TabStopFormat object. | TabStopFormat | ||
Return the value of the style specified by the styleProp parameter
which specifies the style name. | TabStopFormat | ||
|
Indicates whether an object has a specified property defined. | Object | |
isEqual(p1:flashx.textLayout.formats:ITabStopFormat, p2:flashx.textLayout.formats:ITabStopFormat):Boolean [static]
Compares properties in ITabStopFormat instance p1 with properties in ITabStopFormat instance p2
and returns true if all properties match. | TabStopFormat | ||
|
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 properties in this TabStopFormat object to undefined if they do not match those in the
incoming ITabStopFormat instance. | TabStopFormat | ||
Sets properties in this TabStopFormat object to undefined if they match those in the incoming
ITabStopFormat instance. | TabStopFormat | ||
|
Sets the availability of a dynamic property for loop operations. | Object | |
Set the value of the style specified by the styleProp parameter
which specifies the style name to value. | TabStopFormat | ||
|
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 | |
alignment | property |
alignment:*| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The tab alignment for this tab stop.
Legal values are TabAlignment.START, TabAlignment.CENTER, TabAlignment.END, TabAlignment.DECIMAL, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of TabAlignment.START.
Implementation
public function get alignment():* public function set alignment(value:any):voidThrows
RangeError — when set value is not within range for this property
|
Related API Elements
decimalAlignmentToken | property |
decimalAlignmentToken:*| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The alignment token to be used if the alignment is DECIMAL.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of null.
Implementation
public function get decimalAlignmentToken():* public function set decimalAlignmentToken(value:any):voidThrows
RangeError — when set value is not within range for this property
|
defaultFormat | property |
defaultFormat:flashx.textLayout.formats:ITabStopFormat [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Returns a TabStopFormat object with default settings. This function always returns the same object.
Implementation
public static function get defaultFormat():flashx.textLayout.formats:ITabStopFormatposition | property |
position:*| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The position of the tab stop, in pixels, relative to the start edge of the column.
Legal values are numbers from 0 to 10000 and FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of 0.
Implementation
public function get position():* public function set position(value:any):voidThrows
RangeError — when set value is not within range for this property
|
Related API Elements
TabStopFormat | () | Constructor |
public function TabStopFormat(initialValues:flashx.textLayout.formats:ITabStopFormat = null)| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Creates a new TabStopFormat object. All settings are empty or, optionally, are initialized from the
supplied initialValues object.
initialValues:flashx.textLayout.formats:ITabStopFormat (default = null) |
Related API Elements
apply | () | method |
public function apply(incoming:flashx.textLayout.formats:ITabStopFormat):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Replaces property values in this TabStopFormat object with the values of properties that are set in
the incoming ITabStopFormat instance. Properties that are undefined in the incoming
ITabStopFormat instance are not changed in this object.
Parameters
incoming:flashx.textLayout.formats:ITabStopFormat — instance whose property values are applied to this TabStopFormat object.
|
concat | () | method |
public function concat(incoming:flashx.textLayout.formats:ITabStopFormat):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Concatenates the values of properties in the incoming ITabStopFormat instance
with the values of this TabStopFormat object. In this (the receiving) TabStopFormat object, properties whose values are FormatValue.INHERIT,
and inheriting properties whose values are undefined will get new values from the incoming object.
Non-inheriting properties whose values are undefined will get their default values.
All other property values will remain unmodified.
Parameters
incoming:flashx.textLayout.formats:ITabStopFormat — instance from which values are concatenated.
|
Related API Elements
concatInheritOnly | () | method |
public function concatInheritOnly(incoming:flashx.textLayout.formats:ITabStopFormat):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Concatenates the values of properties in the incoming ITabStopFormat instance
with the values of this TabStopFormat object. In this (the receiving) TabStopFormat object, properties whose values are FormatValue.INHERIT,
and inheriting properties whose values are undefined will get new values from the incoming object.
All other property values will remain unmodified.
Parameters
incoming:flashx.textLayout.formats:ITabStopFormat — instance from which values are concatenated.
|
Related API Elements
copy | () | method |
public function copy(values:flashx.textLayout.formats:ITabStopFormat):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Copies TabStopFormat settings from the values ITabStopFormat instance into this TabStopFormat object.
If values is null, this TabStopFormat object is initialized with undefined values for all properties.
Parameters
values:flashx.textLayout.formats:ITabStopFormat — optional instance from which to copy values.
|
getStyle | () | method |
public function getStyle(styleName:String):*| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Return the value of the style specified by the styleProp parameter
which specifies the style name.
Parameters
styleName:String — The name of the style whose value is to be retrieved.
|
* — The value of the specified style. The type varies depending on the type of the style being
accessed. Returns undefined if the style is not set.
|
isEqual | () | method |
public static function isEqual(p1:flashx.textLayout.formats:ITabStopFormat, p2:flashx.textLayout.formats:ITabStopFormat):Boolean| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Compares properties in ITabStopFormat instance p1 with properties in ITabStopFormat instance p2
and returns true if all properties match.
Parameters
p1:flashx.textLayout.formats:ITabStopFormat — instance to compare to p2.
| |
p2:flashx.textLayout.formats:ITabStopFormat — instance to compare to p1.
|
Boolean — true if all properties match, false otherwise.
|
removeClashing | () | method |
public function removeClashing(incoming:flashx.textLayout.formats:ITabStopFormat):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Sets properties in this TabStopFormat object to undefined if they do not match those in the
incoming ITabStopFormat instance.
Parameters
incoming:flashx.textLayout.formats:ITabStopFormat — instance against which to compare this TabStopFormat object's property values.
|
removeMatching | () | method |
public function removeMatching(incoming:flashx.textLayout.formats:ITabStopFormat):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Sets properties in this TabStopFormat object to undefined if they match those in the incoming
ITabStopFormat instance.
Parameters
incoming:flashx.textLayout.formats:ITabStopFormat — instance against which to compare this TabStopFormat object's property values.
|
setStyle | () | method |
public function setStyle(styleName:String, value:*):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Set the value of the style specified by the styleProp parameter
which specifies the style name to value.
Parameters
styleName:String — The name of the style whose value is to be set.
| |
value:* — The value to set.
|
package flashx.textLayout.formats.examples {
import flash.display.Sprite;
import flash.text.engine.TabAlignment;
import flashx.textLayout.container.ContainerController;
import flashx.textLayout.compose.StandardFlowComposer;
import flashx.textLayout.elements.ParagraphElement;
import flashx.textLayout.elements.SpanElement;
import flashx.textLayout.elements.TextFlow;
import flashx.textLayout.formats.TabStopFormat;
import flashx.textLayout.formats.TextLayoutFormat;
public class TabStopFormat_example extends Sprite
{
public function TabStopFormat_example()
{
var firstContainer:Sprite = new Sprite();
this.stage.addChild( firstContainer );
var textFlow:TextFlow = new TextFlow();
var format:TextLayoutFormat = new TextLayoutFormat();
var tabStop1:TabStopFormat = new TabStopFormat();
var tabStop2:TabStopFormat = new TabStopFormat();
var tabStop3:TabStopFormat = new TabStopFormat();
tabStop1.alignment = flash.text.engine.TabAlignment.START;
tabStop1.position = 50;
tabStop2.alignment = flash.text.engine.TabAlignment.CENTER;
tabStop2.position = 150;
tabStop3.alignment = flash.text.engine.TabAlignment.END;
tabStop3.position = 250;
format.tabStops = new Array(tabStop1,tabStop2,tabStop3);
textFlow.hostFormat = format;
var p:ParagraphElement = new ParagraphElement();
var span:SpanElement = new SpanElement();
span.text = "1\txxx\txxx\txxx\n2\tyyyyyy\tyyyyyy<\tyyyyyy\n3\tzz\tzz\tzz";
p.addChild(span);
textFlow.addChild(p);
textFlow.flowComposer = new StandardFlowComposer();
var firstController:ContainerController = new ContainerController(firstContainer, 300, 100 );
textFlow.flowComposer.addController(firstController);
textFlow.flowComposer.updateAllControllers();
}
}
}
Mon Nov 28 2011, 06:48 AM -08:00