Packagecom.adobe.indesign
Classpublic class HiddenText
InheritanceHiddenText Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  characters : Characters
[read-only] A collection of characters.
HiddenText
  eventListeners : EventListeners
[read-only] A collection of event listeners.
HiddenText
  events : Events
[read-only] A collection of events.
HiddenText
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  id : Number
[read-only] The unique ID of the HiddenText.
HiddenText
  index : Number
[read-only] The index of the HiddenText within its containing object.
HiddenText
  insertionPoints : InsertionPoints
[read-only] A collection of insertion points.
HiddenText
  isValid : Boolean
[read-only] Returns true if the object specifier resolves to valid objects.
HiddenText
  label : String
A property that can be set to any string.
HiddenText
  lines : Lines
[read-only] A collection of lines.
HiddenText
  name : String
The name of the HiddenText; this is an alias to the HiddenText's label property.
HiddenText
  paragraphs : Paragraphs
[read-only] A collection of paragraphs.
HiddenText
  parent : Object
[read-only] The parent of the HiddenText (a Story, XmlStory, TextFrame, InsertionPoint, Note, Cell or Footnote).
HiddenText
  properties : Object
A property that allows setting of several properties at the same time.
HiddenText
  storyOffset : InsertionPoint
[read-only] The insertion point before the table in the story containing the table.
HiddenText
  textColumns : TextColumns
[read-only] A collection of text columns.
HiddenText
  texts : Texts
[read-only] A collection of text objects.
HiddenText
  textStyleRanges : TextStyleRanges
[read-only] A collection of text style ranges.
HiddenText
  words : Words
[read-only] A collection of words.
HiddenText
Public Methods
 MethodDefined By
  
addEventListenerHiddenText(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
HiddenText
  
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key.
HiddenText
 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.
HiddenText
 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
  
insertLabel(keyParam:String = null, valueParam:String = null):void
Sets the label to the value associated with the specified key.
HiddenText
 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
  
removeEventListenerHiddenText(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
HiddenText
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
Retrieves the object specifier.
HiddenText
 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
charactersproperty
characters:Characters  [read-only]

A collection of characters.


Implementation
    public function get characters():Characters
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
idproperty 
id:Number  [read-only]

The unique ID of the HiddenText.


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

The index of the HiddenText within its containing object.


Implementation
    public function get index():Number
insertionPointsproperty 
insertionPoints:InsertionPoints  [read-only]

A collection of insertion points.


Implementation
    public function get insertionPoints():InsertionPoints
isValidproperty 
isValid:Boolean  [read-only]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
labelproperty 
label:String

A property that can be set to any string.


Implementation
    public function get label():String
    public function set label(value:String):void
linesproperty 
lines:Lines  [read-only]

A collection of lines.


Implementation
    public function get lines():Lines
nameproperty 
name:String

The name of the HiddenText; this is an alias to the HiddenText's label property.


Implementation
    public function get name():String
    public function set name(value:String):void
paragraphsproperty 
paragraphs:Paragraphs  [read-only]

A collection of paragraphs.


Implementation
    public function get paragraphs():Paragraphs
parentproperty 
parent:Object  [read-only]

The parent of the HiddenText (a Story, XmlStory, TextFrame, InsertionPoint, Note, Cell or Footnote).


Implementation
    public function get parent():Object
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
storyOffsetproperty 
storyOffset:InsertionPoint  [read-only]

The insertion point before the table in the story containing the table.


Implementation
    public function get storyOffset():InsertionPoint
textColumnsproperty 
textColumns:TextColumns  [read-only]

A collection of text columns.


Implementation
    public function get textColumns():TextColumns
textsproperty 
texts:Texts  [read-only]

A collection of text objects.


Implementation
    public function get texts():Texts
textStyleRangesproperty 
textStyleRanges:TextStyleRanges  [read-only]

A collection of text style ranges.


Implementation
    public function get textStyleRanges():TextStyleRanges
wordsproperty 
words:Words  [read-only]

A collection of words.


Implementation
    public function get words():Words
Method Detail
addEventListenerHiddenText()method
public function addEventListenerHiddenText(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
extractLabel()method 
public function extractLabel(keyParam:String = null):String

Gets the label value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.

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

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

Returns
Object
insertLabel()method 
public function insertLabel(keyParam:String = null, valueParam:String = null):void

Sets the label to the value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.
 
valueParam:String (default = null) — (String) The value.

removeEventListenerHiddenText()method 
public function removeEventListenerHiddenText(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