Packagecom.adobe.indesign
Classpublic class TabStop
InheritanceTabStop Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  alignment : TabStopAlignment
The tab stop alignment.
TabStop
  alignmentCharacter : String
The tab stop alignment character.
TabStop
  eventListeners : EventListeners
[read-only] A collection of event listeners.
TabStop
  events : Events
[read-only] A collection of events.
TabStop
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  index : Number
[read-only] The index of the TabStop within its containing object.
TabStop
  isValid : Boolean
[read-only] Returns true if the object specifier resolves to valid objects.
TabStop
  leader : String
The tab stop leader.
TabStop
  parent : Object
[read-only] The parent of the TabStop (a TextDefault, Paragraph, ParagraphStyle, Text, InsertionPoint, TextStyleRange, TextColumn, Line, Word, Character, Story or XmlStory).
TabStop
  position : Object
The position of the tab stop.
TabStop
  properties : Object
A property that allows setting of several properties at the same time.
TabStop
Public Methods
 MethodDefined By
  
addEventListenerTabStop(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
TabStop
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
  
getElements():Object
Resolves the object specifier, creating an array of object references.
TabStop
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
  
remove():void
Deletes the TabStop.
TabStop
  
removeEventListenerTabStop(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
TabStop
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
Retrieves the object specifier.
TabStop
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
alignmentproperty
alignment:TabStopAlignment

The tab stop alignment.


Implementation
    public function get alignment():TabStopAlignment
    public function set alignment(value:TabStopAlignment):void
alignmentCharacterproperty 
alignmentCharacter:String

The tab stop alignment character. Note: Valid when alignment is character align.


Implementation
    public function get alignmentCharacter():String
    public function set alignmentCharacter(value:String):void
eventListenersproperty 
eventListeners:EventListeners  [read-only]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only]

A collection of events.


Implementation
    public function get events():Events
indexproperty 
index:Number  [read-only]

The index of the TabStop within its containing object.


Implementation
    public function get index():Number
isValidproperty 
isValid:Boolean  [read-only]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
leaderproperty 
leader:String

The tab stop leader.


Implementation
    public function get leader():String
    public function set leader(value:String):void
parentproperty 
parent:Object  [read-only]

The parent of the TabStop (a TextDefault, Paragraph, ParagraphStyle, Text, InsertionPoint, TextStyleRange, TextColumn, Line, Word, Character, Story or XmlStory).


Implementation
    public function get parent():Object
positionproperty 
position:Object

The position of the tab stop.


Implementation
    public function get position():Object
    public function set position(value:Object):void
propertiesproperty 
properties:Object

A property that allows setting of several properties at the same time.


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
Method Detail
addEventListenerTabStop()method
public function addEventListenerTabStop(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener

Adds an event listener.

Parameters

eventTypeParam:String (default = null) — (String) The event type.
 
handlerParam:Object (default = null) — (Object) The event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
EventListener
getElements()method 
public function getElements():Object

Resolves the object specifier, creating an array of object references.

Returns
Object
remove()method 
public function remove():void

Deletes the TabStop.

removeEventListenerTabStop()method 
public function removeEventListenerTabStop(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean

Removes the event listener.

Parameters

eventTypeParam:String (default = null) — (String) The registered event type.
 
handlerParam:Object (default = null) — (Object) The registered event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
Boolean
toSpecifier()method 
public function toSpecifier():String

Retrieves the object specifier.

Returns
String