Packagecom.adobe.indesign
Classpublic class Footnote
InheritanceFootnote Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  allGraphics : Object
[read-only] Lists all graphics contained by the Footnote.
Footnote
  allPageItems : Object
[read-only] Lists all page items contained by the Footnote.
Footnote
  characters : Characters
[read-only] A collection of characters.
Footnote
  contents : Object
The text contents of the footnote.
Footnote
  epstexts : EPSTexts
[read-only] EPSTexts
Footnote
  eventListeners : EventListeners
[read-only] A collection of event listeners.
Footnote
  events : Events
[read-only] A collection of events.
Footnote
  graphicLines : GraphicLines
[read-only] A collection of graphic lines.
Footnote
  groups : Groups
[read-only] A collection of groups.
Footnote
  hiddenTexts : HiddenTexts
[read-only] A collection of hidden text objects.
Footnote
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  id : Number
[read-only] The unique ID of the Footnote.
Footnote
  index : Number
[read-only] The index of the Footnote within its containing object.
Footnote
  insertionPoints : InsertionPoints
[read-only] A collection of insertion points.
Footnote
  isValid : Boolean
[read-only] Returns true if the object specifier resolves to valid objects.
Footnote
  label : String
A property that can be set to any string.
Footnote
  lines : Lines
[read-only] A collection of lines.
Footnote
  name : String
The name of the Footnote; this is an alias to the Footnote's label property.
Footnote
  ovals : Ovals
[read-only] A collection of ellipses.
Footnote
  pageItems : PageItems
[read-only] The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type.
Footnote
  paragraphs : Paragraphs
[read-only] A collection of paragraphs.
Footnote
  parent : Object
[read-only] The parent of the Footnote (a XmlStory, Story, TextFrame or InsertionPoint).
Footnote
  polygons : Polygons
[read-only] A collection of polygons.
Footnote
  properties : Object
A property that allows setting of several properties at the same time.
Footnote
  rectangles : Rectangles
[read-only] A collection of rectangles.
Footnote
  splineItems : SplineItems
[read-only] The spline items collection.
Footnote
  storyOffset : InsertionPoint
[read-only] The location of the footnote marker in the parent story.
Footnote
  textColumns : TextColumns
[read-only] A collection of text columns.
Footnote
  textFrames : TextFrames
[read-only] A collection of text frames.
Footnote
  texts : Texts
[read-only] A collection of text objects.
Footnote
  textStyleRanges : TextStyleRanges
[read-only] A collection of text style ranges.
Footnote
  textVariableInstances : TextVariableInstances
[read-only] A collection of text variable instances.
Footnote
  words : Words
[read-only] A collection of words.
Footnote
Public Methods
 MethodDefined By
  
addEventListenerFootnote(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Footnote
  
Converts the footnote to part of the story text and places the converted text at the former location of the footnote marker in the text.
Footnote
  
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key.
Footnote
 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.
Footnote
 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.
Footnote
 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 Footnote.
Footnote
  
removeEventListenerFootnote(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Footnote
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
Retrieves the object specifier.
Footnote
 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
allGraphicsproperty
allGraphics:Object  [read-only]

Lists all graphics contained by the Footnote.


Implementation
    public function get allGraphics():Object
allPageItemsproperty 
allPageItems:Object  [read-only]

Lists all page items contained by the Footnote.


Implementation
    public function get allPageItems():Object
charactersproperty 
characters:Characters  [read-only]

A collection of characters.


Implementation
    public function get characters():Characters
contentsproperty 
contents:Object

The text contents of the footnote. Can return: String, SpecialCharacters enumerator or Array of Strings or SpecialCharacters enumerators. Can also accept: NothingEnum enumerator or Array of Strings, SpecialCharacters enumerators or NothingEnum enumerators.


Implementation
    public function get contents():Object
    public function set contents(value:Object):void
epstextsproperty 
epstexts:EPSTexts  [read-only]

EPSTexts


Implementation
    public function get epstexts():EPSTexts
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
graphicLinesproperty 
graphicLines:GraphicLines  [read-only]

A collection of graphic lines.


Implementation
    public function get graphicLines():GraphicLines
groupsproperty 
groups:Groups  [read-only]

A collection of groups.


Implementation
    public function get groups():Groups
hiddenTextsproperty 
hiddenTexts:HiddenTexts  [read-only]

A collection of hidden text objects.


Implementation
    public function get hiddenTexts():HiddenTexts
idproperty 
id:Number  [read-only]

The unique ID of the Footnote.


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

The index of the Footnote 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 Footnote; this is an alias to the Footnote's label property.


Implementation
    public function get name():String
    public function set name(value:String):void
ovalsproperty 
ovals:Ovals  [read-only]

A collection of ellipses.


Implementation
    public function get ovals():Ovals
pageItemsproperty 
pageItems:PageItems  [read-only]

The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type.


Implementation
    public function get pageItems():PageItems
paragraphsproperty 
paragraphs:Paragraphs  [read-only]

A collection of paragraphs.


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

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


Implementation
    public function get parent():Object
polygonsproperty 
polygons:Polygons  [read-only]

A collection of polygons.


Implementation
    public function get polygons():Polygons
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
rectanglesproperty 
rectangles:Rectangles  [read-only]

A collection of rectangles.


Implementation
    public function get rectangles():Rectangles
splineItemsproperty 
splineItems:SplineItems  [read-only]

The spline items collection.


Implementation
    public function get splineItems():SplineItems
storyOffsetproperty 
storyOffset:InsertionPoint  [read-only]

The location of the footnote marker in the parent story.


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

A collection of text columns.


Implementation
    public function get textColumns():TextColumns
textFramesproperty 
textFrames:TextFrames  [read-only]

A collection of text frames.


Implementation
    public function get textFrames():TextFrames
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
textVariableInstancesproperty 
textVariableInstances:TextVariableInstances  [read-only]

A collection of text variable instances.


Implementation
    public function get textVariableInstances():TextVariableInstances
wordsproperty 
words:Words  [read-only]

A collection of words.


Implementation
    public function get words():Words
Method Detail
addEventListenerFootnote()method
public function addEventListenerFootnote(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
convertToText()method 
public function convertToText():Text

Converts the footnote to part of the story text and places the converted text at the former location of the footnote marker in the text.

Returns
Text
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.

remove()method 
public function remove():void

Deletes the Footnote.

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