Adobe InDesign CS5.5 Server (7.5) Object Model JS: TabStop

InDesign Server CS5.5

Class

TabStop

 A tab stop.

QuickLinks

addEventListener, getElements, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Character | InsertionPoint | Line | Paragraph | ParagraphStyle | Story | Text | TextColumn | TextDefault | TextStyleRange | Word | XmlStory
TabStop
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
alignmentTabStopAlignment:
TabStopAlignment.LEFT_ALIGN
TabStopAlignment.CENTER_ALIGN
TabStopAlignment.RIGHT_ALIGN
TabStopAlignment.CHARACTER_ALIGN
r/wThe tab stop alignment.
alignmentCharacterstring r/wThe tab stop alignment character. Note: Valid when alignment is character align.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
indexnumber readonlyThe index of the TabStop within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
leaderstring r/wThe tab stop leader.
parentCharacter
InsertionPoint
Line
Paragraph
ParagraphStyle
Story
Text
TextColumn
TextDefault
TextStyleRange
Word
XmlStory
readonlyThe parent of the TabStop (a TextDefault, Paragraph, ParagraphStyle, Text, InsertionPoint, TextStyleRange, TextColumn, Line, Word, Character, Story or XmlStory).
positionMeasurement Unit (Number or String) r/wThe position of the tab stop.
propertiesObject r/wA property that allows setting of several properties at the same time.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

Array of TabStop getElements ()
Resolves the object specifier, creating an array of object references.

void remove ()
Deletes the TabStop.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string toSource ()
Generates a string which, if executed, will return the TabStop.

string toSpecifier ()
Retrieves the object specifier.

Used in:

TabStop TabStops.nextItem (obj: TabStop)

TabStop TabStops.previousItem (obj: TabStop)

Return

Array of TabStop TabStop.getElements ()

TabStop TabStops.[] (index: number)

TabStop TabStops.add ([withProperties: Object])

TabStop TabStops.anyItem ()

Array of TabStop TabStops.everyItem ()

TabStop TabStops.firstItem ()

TabStop TabStops.item (index: varies)

Array of TabStop TabStops.itemByRange (from: varies, to: varies)

TabStop TabStops.lastItem ()

TabStop TabStops.middleItem ()

TabStop TabStops.nextItem (obj: TabStop)

TabStop TabStops.previousItem (obj: TabStop)

Jongware, 28-Apr-2012 v3.0.3iContents :: Index