Package | com.adobe.indesign |
Class | public class Footnote |
Inheritance | Footnote ![]() ![]() |
Since : | CS5 |
Property | Defined 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 | ||
![]() | hostObjectDelegate : 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 |
Method | Defined 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 | ||
![]() | filterArgsForHBAPI(args:Array):Array [static]
Function to clean up the argument list and put it into a format that
makes sense for HBAPI. | CSHostObject | |
![]() | filterSingleObjectForHBAPI(value:Object):Object [static]
| CSHostObject | |
![]() | 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 | ||
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
![]() | hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
| CSHostObject | |
![]() | hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):* [static]
Implements a safe call of a static method on the host
| CSHostObject | |
![]() | hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
| CSHostObject | |
![]() | hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
| CSHostObject | |
![]() | 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 | |
![]() | hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
| CSHostObject | |
![]() | 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 | ||
![]() | 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 | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String
Retrieves the object specifier. | Footnote | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
allGraphics | property |
allGraphics:Object
[read-only] Since : | CS5 |
Lists all graphics contained by the Footnote.
public function get allGraphics():Object
allPageItems | property |
allPageItems:Object
[read-only] Since : | CS5 |
Lists all page items contained by the Footnote.
public function get allPageItems():Object
characters | property |
characters:Characters
[read-only] Since : | CS5 |
A collection of characters.
public function get characters():Characters
contents | property |
contents:Object
Since : | CS5 |
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.
public function get contents():Object
public function set contents(value:Object):void
epstexts | property |
epstexts:EPSTexts
[read-only] Since : | CS5 |
EPSTexts
public function get epstexts():EPSTexts
eventListeners | property |
eventListeners:EventListeners
[read-only] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] Since : | CS5 |
A collection of events.
public function get events():Events
graphicLines | property |
graphicLines:GraphicLines
[read-only] Since : | CS5 |
A collection of graphic lines.
public function get graphicLines():GraphicLines
groups | property |
groups:Groups
[read-only] Since : | CS5 |
A collection of groups.
public function get groups():Groups
hiddenTexts | property |
hiddenTexts:HiddenTexts
[read-only] Since : | CS5 |
A collection of hidden text objects.
public function get hiddenTexts():HiddenTexts
id | property |
id:Number
[read-only] Since : | CS5 |
The unique ID of the Footnote.
public function get id():Number
index | property |
index:Number
[read-only] Since : | CS5 |
The index of the Footnote within its containing object.
public function get index():Number
insertionPoints | property |
insertionPoints:InsertionPoints
[read-only] Since : | CS5 |
A collection of insertion points.
public function get insertionPoints():InsertionPoints
isValid | property |
isValid:Boolean
[read-only] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
label | property |
label:String
Since : | CS5 |
A property that can be set to any string.
public function get label():String
public function set label(value:String):void
lines | property |
lines:Lines
[read-only] Since : | CS5 |
A collection of lines.
public function get lines():Lines
name | property |
name:String
Since : | CS5 |
The name of the Footnote; this is an alias to the Footnote's label property.
public function get name():String
public function set name(value:String):void
ovals | property |
ovals:Ovals
[read-only] Since : | CS5 |
A collection of ellipses.
public function get ovals():Ovals
pageItems | property |
pageItems:PageItems
[read-only] Since : | CS5 |
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.
public function get pageItems():PageItems
paragraphs | property |
paragraphs:Paragraphs
[read-only] Since : | CS5 |
A collection of paragraphs.
public function get paragraphs():Paragraphs
parent | property |
parent:Object
[read-only] Since : | CS5 |
The parent of the Footnote (a XmlStory, Story, TextFrame or InsertionPoint).
public function get parent():Object
polygons | property |
polygons:Polygons
[read-only] Since : | CS5 |
A collection of polygons.
public function get polygons():Polygons
properties | property |
properties:Object
Since : | CS5 |
A property that allows setting of several properties at the same time.
public function get properties():Object
public function set properties(value:Object):void
rectangles | property |
rectangles:Rectangles
[read-only] Since : | CS5 |
A collection of rectangles.
public function get rectangles():Rectangles
splineItems | property |
splineItems:SplineItems
[read-only] Since : | CS5 |
The spline items collection.
public function get splineItems():SplineItems
storyOffset | property |
storyOffset:InsertionPoint
[read-only] Since : | CS5 |
The location of the footnote marker in the parent story.
public function get storyOffset():InsertionPoint
textColumns | property |
textColumns:TextColumns
[read-only] Since : | CS5 |
A collection of text columns.
public function get textColumns():TextColumns
textFrames | property |
textFrames:TextFrames
[read-only] Since : | CS5 |
A collection of text frames.
public function get textFrames():TextFrames
texts | property |
texts:Texts
[read-only] Since : | CS5 |
A collection of text objects.
public function get texts():Texts
textStyleRanges | property |
textStyleRanges:TextStyleRanges
[read-only] Since : | CS5 |
A collection of text style ranges.
public function get textStyleRanges():TextStyleRanges
textVariableInstances | property |
textVariableInstances:TextVariableInstances
[read-only] Since : | CS5 |
A collection of text variable instances.
public function get textVariableInstances():TextVariableInstances
words | property |
words:Words
[read-only] Since : | CS5 |
A collection of words.
public function get words():Words
addEventListenerFootnote | () | method |
public function addEventListenerFootnote(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Since : | CS5 |
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)
|
EventListener |
convertToText | () | method |
public function convertToText():Text
Since : | CS5 |
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.
ReturnsText |
extractLabel | () | method |
public function extractLabel(keyParam:String = null):String
Since : | CS5 |
Gets the label value associated with the specified key.
Parameters
keyParam:String (default = null ) — (String) The key.
|
String |
getElements | () | method |
public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
insertLabel | () | method |
public function insertLabel(keyParam:String = null, valueParam:String = null):void
Since : | CS5 |
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
Since : | CS5 |
Deletes the Footnote.
removeEventListenerFootnote | () | method |
public function removeEventListenerFootnote(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Since : | CS5 |
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)
|
Boolean |
toSpecifier | () | method |
public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |