Packagecom.adobe.indesign
Classpublic class FootnoteOption
InheritanceFootnoteOption Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Preference



Public Properties
 PropertyDefined By
  continuingRuleColor : Object
The swatch (color, gradient, tint, or mixed ink) applied to the rule above continued footnote text.
FootnoteOption
  continuingRuleGapColor : Object
The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap of the rule above continued footnote text.
FootnoteOption
  continuingRuleGapOverprint : Boolean
If true, overprints the gap color of the rule above continued footnote text.
FootnoteOption
  continuingRuleGapTint : Number
The tint (as a percentage) of the gap color of the rule above continued footnote text.
FootnoteOption
  continuingRuleLeftIndent : Object
The amount to left indent the rule above continued footnote text.
FootnoteOption
  continuingRuleLineWeight : Object
The stroke weight of the rule above continued footnote text.
FootnoteOption
  continuingRuleOffset : Object
The vertical offset of the rule above continued footnote text.
FootnoteOption
  continuingRuleOn : Boolean
If true, draws a rule above footnote text that continues from a previous column.
FootnoteOption
  continuingRuleOverprint : Boolean
If true, overprints the rule above continued footnote text.
FootnoteOption
  continuingRuleTint : Number
The tint (as a percentage) of the rule above continued footnote text.
FootnoteOption
  continuingRuleType : Object
The stroke type of the rule above continued footnote text.
FootnoteOption
  continuingRuleWidth : Object
The length of the rule above continued footnote text.
FootnoteOption
  eosPlacement : Boolean
If true, footnotes at the end of the story are placed just below the text.
FootnoteOption
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
FootnoteOption
  events : Events
[override] [read-only] A collection of events.
FootnoteOption
  footnoteFirstBaselineOffset : FootnoteFirstBaseline
The distance between the top of the footnote container and the footnote text.
FootnoteOption
  footnoteMarkerStyle : CharacterStyle
The character style to apply to footnote reference numbers in the main text.
FootnoteOption
  footnoteMinimumFirstBaselineOffset : Object
The minimum distance between the baseline of the text and the top of the footnote container.
FootnoteOption
  footnoteNumberingStyle : Object
The footnote numbering style.
FootnoteOption
  footnoteTextStyle : ParagraphStyle
The paragraph style to apply to footnotes.
FootnoteOption
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
FootnoteOption
  markerPositioning : Object
The position of footnote reference numbers in the main text.
FootnoteOption
  noSplitting : Boolean
If true, footnotes cannot split across columns.
FootnoteOption
  parent : Object
[override] [read-only] The parent of the FootnoteOption (a Application or Document).
FootnoteOption
  prefix : String
The prefix text of the footnote.
FootnoteOption
  properties : Object
[override] A property that allows setting of several properties at the same time.
FootnoteOption
  restartNumbering : Object
The point at which to restart footnote numbering.
FootnoteOption
  ruleColor : Object
The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the rule above the first footnote in the column.
FootnoteOption
  ruleGapColor : Object
The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap of the rule above the first footnote in the column.
FootnoteOption
  ruleGapOverprint : Boolean
If true, overprints the gap color of the rule above the first footnote in the column.
FootnoteOption
  ruleGapTint : Number
The tint (as a percentage) of the gap color of the rule above the first footnote in the column.
FootnoteOption
  ruleLeftIndent : Object
The amount to left indent the rule above the first footnote in the column.
FootnoteOption
  ruleLineWeight : Object
The stroke weight of the rule above the first footnote in the column.
FootnoteOption
  ruleOffset : Object
The vertical offset of the rule above the first footnote in the column.
FootnoteOption
  ruleOn : Boolean
If true, draws a rule between the text and the first footnote in the column.
FootnoteOption
  ruleOverprint : Boolean
If true, overprints the rule above the first footnote in the column.
FootnoteOption
  ruleTint : Number
The tint (as a percentage) of the rule above the first footnote in the column.
FootnoteOption
  ruleType : Object
The stroke type of the rule above the first footnote in a column.
FootnoteOption
  ruleWidth : Object
The length of the rule above the first footnote in the column.
FootnoteOption
  separatorText : String
The text to insert between the footnote marker number and the footnote text.
FootnoteOption
  showPrefixSuffix : Object
The position of the footnote prefix and/or suffix.
FootnoteOption
  spaceBetween : Object
The amount of vertical space between footnotes.
FootnoteOption
  spacer : Object
The minimum amount of vertical space between the bottom of the text column and the first footnote.
FootnoteOption
  startAt : Number
The number at which to start footnote numbering.
FootnoteOption
  suffix : String
The suffix text of the footnote.
FootnoteOption
Public Methods
 MethodDefined By
  
addEventListenerFootnoteOption(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
FootnoteOption
 Inherited
addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Preference
 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
[override] Resolves the object specifier, creating an array of object references.
FootnoteOption
 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
  
removeEventListenerFootnoteOption(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
FootnoteOption
 Inherited
removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Preference
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
[override] Retrieves the object specifier.
FootnoteOption
 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
continuingRuleColorproperty
continuingRuleColor:Object

The swatch (color, gradient, tint, or mixed ink) applied to the rule above continued footnote text. Note: Valid when continuing rule on is true. Can return: Swatch or String.


Implementation
    public function get continuingRuleColor():Object
    public function set continuingRuleColor(value:Object):void
continuingRuleGapColorproperty 
continuingRuleGapColor:Object

The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap of the rule above continued footnote text. Note: Valid when continuing rule type is not solid. Can return: Swatch or String.


Implementation
    public function get continuingRuleGapColor():Object
    public function set continuingRuleGapColor(value:Object):void
continuingRuleGapOverprintproperty 
continuingRuleGapOverprint:Boolean

If true, overprints the gap color of the rule above continued footnote text. Note: Valid when continuing rule type is not solid.


Implementation
    public function get continuingRuleGapOverprint():Boolean
    public function set continuingRuleGapOverprint(value:Boolean):void
continuingRuleGapTintproperty 
continuingRuleGapTint:Number

The tint (as a percentage) of the gap color of the rule above continued footnote text. (Range: 0 to 100) Note: Valid when continuing rule type is not solid.


Implementation
    public function get continuingRuleGapTint():Number
    public function set continuingRuleGapTint(value:Number):void
continuingRuleLeftIndentproperty 
continuingRuleLeftIndent:Object

The amount to left indent the rule above continued footnote text. Note: Valid when continuing rule on is true.


Implementation
    public function get continuingRuleLeftIndent():Object
    public function set continuingRuleLeftIndent(value:Object):void
continuingRuleLineWeightproperty 
continuingRuleLineWeight:Object

The stroke weight of the rule above continued footnote text. (Range: 0 to 1000) Note: Valid when continuing rule on is true.


Implementation
    public function get continuingRuleLineWeight():Object
    public function set continuingRuleLineWeight(value:Object):void
continuingRuleOffsetproperty 
continuingRuleOffset:Object

The vertical offset of the rule above continued footnote text. Note: Valid when continuing rule on is true.


Implementation
    public function get continuingRuleOffset():Object
    public function set continuingRuleOffset(value:Object):void
continuingRuleOnproperty 
continuingRuleOn:Boolean

If true, draws a rule above footnote text that continues from a previous column. Note: Valid when no splitting is false or undefined.


Implementation
    public function get continuingRuleOn():Boolean
    public function set continuingRuleOn(value:Boolean):void
continuingRuleOverprintproperty 
continuingRuleOverprint:Boolean

If true, overprints the rule above continued footnote text. Note: Valid when continuing rule on is true.


Implementation
    public function get continuingRuleOverprint():Boolean
    public function set continuingRuleOverprint(value:Boolean):void
continuingRuleTintproperty 
continuingRuleTint:Number

The tint (as a percentage) of the rule above continued footnote text. (Range: 0 to 100) Note: Valid when continuing rule type is not solid.


Implementation
    public function get continuingRuleTint():Number
    public function set continuingRuleTint(value:Number):void
continuingRuleTypeproperty 
continuingRuleType:Object

The stroke type of the rule above continued footnote text. Note: Valid when continuing rule on is true. Can return: StrokeStyle or String.


Implementation
    public function get continuingRuleType():Object
    public function set continuingRuleType(value:Object):void
continuingRuleWidthproperty 
continuingRuleWidth:Object

The length of the rule above continued footnote text. Note: Valid when continuing rule on is true.


Implementation
    public function get continuingRuleWidth():Object
    public function set continuingRuleWidth(value:Object):void
eosPlacementproperty 
eosPlacement:Boolean

If true, footnotes at the end of the story are placed just below the text. If false, footnotes at the end of the story are placed at the bottom of the column.


Implementation
    public function get eosPlacement():Boolean
    public function set eosPlacement(value:Boolean):void
eventListenersproperty 
eventListeners:EventListeners  [read-only] [override]

A collection of event listeners.


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

A collection of events.


Implementation
    public function get events():Events
footnoteFirstBaselineOffsetproperty 
footnoteFirstBaselineOffset:FootnoteFirstBaseline

The distance between the top of the footnote container and the footnote text.


Implementation
    public function get footnoteFirstBaselineOffset():FootnoteFirstBaseline
    public function set footnoteFirstBaselineOffset(value:FootnoteFirstBaseline):void
footnoteMarkerStyleproperty 
footnoteMarkerStyle:CharacterStyle

The character style to apply to footnote reference numbers in the main text.


Implementation
    public function get footnoteMarkerStyle():CharacterStyle
    public function set footnoteMarkerStyle(value:CharacterStyle):void
footnoteMinimumFirstBaselineOffsetproperty 
footnoteMinimumFirstBaselineOffset:Object

The minimum distance between the baseline of the text and the top of the footnote container.


Implementation
    public function get footnoteMinimumFirstBaselineOffset():Object
    public function set footnoteMinimumFirstBaselineOffset(value:Object):void
footnoteNumberingStyleproperty 
footnoteNumberingStyle:Object

The footnote numbering style. Can return: FootnoteNumberingStyle enumerator or String.


Implementation
    public function get footnoteNumberingStyle():Object
    public function set footnoteNumberingStyle(value:Object):void
footnoteTextStyleproperty 
footnoteTextStyle:ParagraphStyle

The paragraph style to apply to footnotes. Note: The space before and after the paragraph defined in the paragraph style is ignored for footnotes. To define space above and between footnotes, see spacer and space between.


Implementation
    public function get footnoteTextStyle():ParagraphStyle
    public function set footnoteTextStyle(value:ParagraphStyle):void
isValidproperty 
isValid:Boolean  [read-only] [override]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
markerPositioningproperty 
markerPositioning:Object

The position of footnote reference numbers in the main text. Can return: FootnoteMarkerPositioning enumerator or String.


Implementation
    public function get markerPositioning():Object
    public function set markerPositioning(value:Object):void
noSplittingproperty 
noSplitting:Boolean

If true, footnotes cannot split across columns. If false, footnotes flow into succeeding columns when the footnote text causes the footnote area to expand upward to reach the footnote reference number in the main text.


Implementation
    public function get noSplitting():Boolean
    public function set noSplitting(value:Boolean):void
parentproperty 
parent:Object  [read-only] [override]

The parent of the FootnoteOption (a Application or Document).


Implementation
    public function get parent():Object
prefixproperty 
prefix:String

The prefix text of the footnote. (Limit: 0 to 100 characters)


Implementation
    public function get prefix():String
    public function set prefix(value:String):void
propertiesproperty 
properties:Object[override]

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
restartNumberingproperty 
restartNumbering:Object

The point at which to restart footnote numbering. Can return: FootnoteRestarting enumerator or String.


Implementation
    public function get restartNumbering():Object
    public function set restartNumbering(value:Object):void
ruleColorproperty 
ruleColor:Object

The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the rule above the first footnote in the column. Note: Valid when rule on is true. Can return: Swatch or String.


Implementation
    public function get ruleColor():Object
    public function set ruleColor(value:Object):void
ruleGapColorproperty 
ruleGapColor:Object

The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap of the rule above the first footnote in the column. Note: Valid when rule type is not solid. Can return: Swatch or String.


Implementation
    public function get ruleGapColor():Object
    public function set ruleGapColor(value:Object):void
ruleGapOverprintproperty 
ruleGapOverprint:Boolean

If true, overprints the gap color of the rule above the first footnote in the column. Note: Valid when rule type is not solid.


Implementation
    public function get ruleGapOverprint():Boolean
    public function set ruleGapOverprint(value:Boolean):void
ruleGapTintproperty 
ruleGapTint:Number

The tint (as a percentage) of the gap color of the rule above the first footnote in the column. (Range: 0 to 100) Note: Valid when rule type is not solid.


Implementation
    public function get ruleGapTint():Number
    public function set ruleGapTint(value:Number):void
ruleLeftIndentproperty 
ruleLeftIndent:Object

The amount to left indent the rule above the first footnote in the column. Note: Valid when rule on is true.


Implementation
    public function get ruleLeftIndent():Object
    public function set ruleLeftIndent(value:Object):void
ruleLineWeightproperty 
ruleLineWeight:Object

The stroke weight of the rule above the first footnote in the column. (Range: 0 to 1000) Note: Valid when rule on is true.


Implementation
    public function get ruleLineWeight():Object
    public function set ruleLineWeight(value:Object):void
ruleOffsetproperty 
ruleOffset:Object

The vertical offset of the rule above the first footnote in the column. Note: Valid when rule on is true.


Implementation
    public function get ruleOffset():Object
    public function set ruleOffset(value:Object):void
ruleOnproperty 
ruleOn:Boolean

If true, draws a rule between the text and the first footnote in the column.


Implementation
    public function get ruleOn():Boolean
    public function set ruleOn(value:Boolean):void
ruleOverprintproperty 
ruleOverprint:Boolean

If true, overprints the rule above the first footnote in the column. Note: Valid when rule on is true.


Implementation
    public function get ruleOverprint():Boolean
    public function set ruleOverprint(value:Boolean):void
ruleTintproperty 
ruleTint:Number

The tint (as a percentage) of the rule above the first footnote in the column. (Range: 0 to 100) Note: Valid when rule on is true.


Implementation
    public function get ruleTint():Number
    public function set ruleTint(value:Number):void
ruleTypeproperty 
ruleType:Object

The stroke type of the rule above the first footnote in a column. Note: Valid when rule on is true. Can return: StrokeStyle or String.


Implementation
    public function get ruleType():Object
    public function set ruleType(value:Object):void
ruleWidthproperty 
ruleWidth:Object

The length of the rule above the first footnote in the column. Note: Valid when rule on is true.


Implementation
    public function get ruleWidth():Object
    public function set ruleWidth(value:Object):void
separatorTextproperty 
separatorText:String

The text to insert between the footnote marker number and the footnote text. (Range: 0 to 100 characters)


Implementation
    public function get separatorText():String
    public function set separatorText(value:String):void
showPrefixSuffixproperty 
showPrefixSuffix:Object

The position of the footnote prefix and/or suffix. Can return: FootnotePrefixSuffix enumerator or String.


Implementation
    public function get showPrefixSuffix():Object
    public function set showPrefixSuffix(value:Object):void
spaceBetweenproperty 
spaceBetween:Object

The amount of vertical space between footnotes. Note: The space before and space after defined for the paragraph style applied to the footnote is ignored.


Implementation
    public function get spaceBetween():Object
    public function set spaceBetween(value:Object):void
spacerproperty 
spacer:Object

The minimum amount of vertical space between the bottom of the text column and the first footnote. Note: The space before amount defined in the paragraph style applied to the footnote is ignored for the first footnote.


Implementation
    public function get spacer():Object
    public function set spacer(value:Object):void
startAtproperty 
startAt:Number

The number at which to start footnote numbering.


Implementation
    public function get startAt():Number
    public function set startAt(value:Number):void
suffixproperty 
suffix:String

The suffix text of the footnote. (Limit: 0 to 100 characters)


Implementation
    public function get suffix():String
    public function set suffix(value:String):void
Method Detail
addEventListenerFootnoteOption()method
public function addEventListenerFootnoteOption(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 
override public function getElements():Object

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

Returns
Object
removeEventListenerFootnoteOption()method 
public function removeEventListenerFootnoteOption(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 
override public function toSpecifier():String

Retrieves the object specifier.

Returns
String