Packageflashx.textLayout.formats
Classpublic class TabStopFormat
InheritanceTabStopFormat Inheritance Object
Implements ITabStopFormat

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

The TabStopFormat class represents the properties of a tab stop in a paragraph. You can set the TextLayoutFormat.tabstops property to an array of TabStopFormat objects.

See also

flashx.textLayout.elements.TabElement
flashx.textLayout.formats.TextLayoutFormat.tabStops

Public Properties
 PropertyDefined By
  alignment : *
The tab alignment for this tab stop.
TabStopFormat
  decimalAlignmentToken : *
The alignment token to be used if the alignment is DECIMAL.
TabStopFormat
  defaultFormat : 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
Public Methods
 MethodDefined By
  
TabStopFormat(initialValues:ITabStopFormat = null)
Creates a new TabStopFormat object.
TabStopFormat
  
apply(incoming:ITabStopFormat):void
Replaces property values in this TabStopFormat object with the values of properties that are set in the incoming ITabStopFormat instance.
TabStopFormat
  
concat(incoming:ITabStopFormat):void
Concatenates the values of properties in the incoming ITabStopFormat instance with the values of this TabStopFormat object.
TabStopFormat
  
concatInheritOnly(incoming:ITabStopFormat):void
Concatenates the values of properties in the incoming ITabStopFormat instance with the values of this TabStopFormat object.
TabStopFormat
  
copy(values:ITabStopFormat):void
Copies TabStopFormat settings from the values ITabStopFormat instance into this TabStopFormat object.
TabStopFormat
  
getStyle(styleName:String):*
Return the value of the style specified by the styleProp parameter which specifies the style name.
TabStopFormat
  
isEqual(p1:ITabStopFormat, p2:ITabStopFormat):Boolean
[static] Compares properties in ITabStopFormat instance p1 with properties in ITabStopFormat instance p2 and returns true if all properties match.
TabStopFormat
  
removeClashing(incoming:ITabStopFormat):void
Sets properties in this TabStopFormat object to undefined if they do not match those in the incoming ITabStopFormat instance.
TabStopFormat
  
removeMatching(incoming:ITabStopFormat):void
Sets properties in this TabStopFormat object to undefined if they match those in the incoming ITabStopFormat instance.
TabStopFormat
  
setStyle(styleName:String, value:*):void
Set the value of the style specified by the styleProp parameter which specifies the style name to value.
TabStopFormat
Property Detail
alignmentproperty
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):void

Throws
RangeError — when set value is not within range for this property

See also

FormatValue.INHERIT
flash.text.engine.TabAlignment
decimalAlignmentTokenproperty 
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):void

Throws
RangeError — when set value is not within range for this property
defaultFormatproperty 
defaultFormat: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():ITabStopFormat
positionproperty 
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):void

Throws
RangeError — when set value is not within range for this property

See also

FormatValue.INHERIT
Constructor Detail
TabStopFormat()Constructor
public function TabStopFormat(initialValues: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.

Parameters
initialValues:ITabStopFormat (default = null) — optional instance from which to copy initial values.

See also

defaultFormat
Method Detail
apply()method
public function apply(incoming: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:ITabStopFormat — instance whose property values are applied to this TabStopFormat object.

concat()method 
public function concat(incoming: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:ITabStopFormat — instance from which values are concatenated.

See also

flashx.textLayout.formats.FormatValue.INHERIT
concatInheritOnly()method 
public function concatInheritOnly(incoming: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:ITabStopFormat — instance from which values are concatenated.

See also

flashx.textLayout.formats.FormatValue.INHERIT
copy()method 
public function copy(values: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: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.

Returns
* — 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:ITabStopFormat, p2: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:ITabStopFormat — instance to compare to p2.
 
p2:ITabStopFormat — instance to compare to p1.

Returns
Boolean — true if all properties match, false otherwise.
removeClashing()method 
public function removeClashing(incoming: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:ITabStopFormat — instance against which to compare this TabStopFormat object's property values.

removeMatching()method 
public function removeMatching(incoming: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: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.




The Apache Software Foundation

Wed Nov 15 2017, 09:50 AM +01:00