Package | com.adobe.incopy |
Class | public class FootnoteOption |
Inheritance | FootnoteOption ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined 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 | ||
![]() | hostObjectDelegate : 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 |
Method | Defined By | ||
---|---|---|---|
addEventListenerFootnoteOption(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | FootnoteOption | ||
![]() | addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Preference | |
![]() | 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 [override]
Resolves the object specifier, creating an array of object references. | FootnoteOption | ||
![]() | 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 | |
![]() | 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 | ||
![]() | removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Preference | |
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String [override]
Retrieves the object specifier. | FootnoteOption | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
continuingRuleColor | property |
continuingRuleColor:Object
Since : | CS5 |
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.
public function get continuingRuleColor():Object
public function set continuingRuleColor(value:Object):void
continuingRuleGapColor | property |
continuingRuleGapColor:Object
Since : | CS5 |
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.
public function get continuingRuleGapColor():Object
public function set continuingRuleGapColor(value:Object):void
continuingRuleGapOverprint | property |
continuingRuleGapOverprint:Boolean
Since : | CS5 |
If true, overprints the gap color of the rule above continued footnote text. Note: Valid when continuing rule type is not solid.
public function get continuingRuleGapOverprint():Boolean
public function set continuingRuleGapOverprint(value:Boolean):void
continuingRuleGapTint | property |
continuingRuleGapTint:Number
Since : | CS5 |
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.
public function get continuingRuleGapTint():Number
public function set continuingRuleGapTint(value:Number):void
continuingRuleLeftIndent | property |
continuingRuleLeftIndent:Object
Since : | CS5 |
The amount to left indent the rule above continued footnote text. Note: Valid when continuing rule on is true.
public function get continuingRuleLeftIndent():Object
public function set continuingRuleLeftIndent(value:Object):void
continuingRuleLineWeight | property |
continuingRuleLineWeight:Object
Since : | CS5 |
The stroke weight of the rule above continued footnote text. (Range: 0 to 1000) Note: Valid when continuing rule on is true.
public function get continuingRuleLineWeight():Object
public function set continuingRuleLineWeight(value:Object):void
continuingRuleOffset | property |
continuingRuleOffset:Object
Since : | CS5 |
The vertical offset of the rule above continued footnote text. Note: Valid when continuing rule on is true.
public function get continuingRuleOffset():Object
public function set continuingRuleOffset(value:Object):void
continuingRuleOn | property |
continuingRuleOn:Boolean
Since : | CS5 |
If true, draws a rule above footnote text that continues from a previous column. Note: Valid when no splitting is false or undefined.
public function get continuingRuleOn():Boolean
public function set continuingRuleOn(value:Boolean):void
continuingRuleOverprint | property |
continuingRuleOverprint:Boolean
Since : | CS5 |
If true, overprints the rule above continued footnote text. Note: Valid when continuing rule on is true.
public function get continuingRuleOverprint():Boolean
public function set continuingRuleOverprint(value:Boolean):void
continuingRuleTint | property |
continuingRuleTint:Number
Since : | CS5 |
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.
public function get continuingRuleTint():Number
public function set continuingRuleTint(value:Number):void
continuingRuleType | property |
continuingRuleType:Object
Since : | CS5 |
The stroke type of the rule above continued footnote text. Note: Valid when continuing rule on is true. Can return: StrokeStyle or String.
public function get continuingRuleType():Object
public function set continuingRuleType(value:Object):void
continuingRuleWidth | property |
continuingRuleWidth:Object
Since : | CS5 |
The length of the rule above continued footnote text. Note: Valid when continuing rule on is true.
public function get continuingRuleWidth():Object
public function set continuingRuleWidth(value:Object):void
eosPlacement | property |
eosPlacement:Boolean
Since : | CS5 |
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.
public function get eosPlacement():Boolean
public function set eosPlacement(value:Boolean):void
eventListeners | property |
eventListeners:EventListeners
[read-only] [override] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] [override] Since : | CS5 |
A collection of events.
public function get events():Events
footnoteFirstBaselineOffset | property |
footnoteFirstBaselineOffset:FootnoteFirstBaseline
Since : | CS5 |
The distance between the top of the footnote container and the footnote text.
public function get footnoteFirstBaselineOffset():FootnoteFirstBaseline
public function set footnoteFirstBaselineOffset(value:FootnoteFirstBaseline):void
footnoteMarkerStyle | property |
footnoteMarkerStyle:CharacterStyle
Since : | CS5 |
The character style to apply to footnote reference numbers in the main text.
public function get footnoteMarkerStyle():CharacterStyle
public function set footnoteMarkerStyle(value:CharacterStyle):void
footnoteMinimumFirstBaselineOffset | property |
footnoteMinimumFirstBaselineOffset:Object
Since : | CS5 |
The minimum distance between the baseline of the text and the top of the footnote container.
public function get footnoteMinimumFirstBaselineOffset():Object
public function set footnoteMinimumFirstBaselineOffset(value:Object):void
footnoteNumberingStyle | property |
footnoteNumberingStyle:Object
Since : | CS5 |
The footnote numbering style. Can return: FootnoteNumberingStyle enumerator or String.
public function get footnoteNumberingStyle():Object
public function set footnoteNumberingStyle(value:Object):void
footnoteTextStyle | property |
footnoteTextStyle:ParagraphStyle
Since : | CS5 |
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.
public function get footnoteTextStyle():ParagraphStyle
public function set footnoteTextStyle(value:ParagraphStyle):void
isValid | property |
isValid:Boolean
[read-only] [override] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
markerPositioning | property |
markerPositioning:Object
Since : | CS5 |
The position of footnote reference numbers in the main text. Can return: FootnoteMarkerPositioning enumerator or String.
public function get markerPositioning():Object
public function set markerPositioning(value:Object):void
noSplitting | property |
noSplitting:Boolean
Since : | CS5 |
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.
public function get noSplitting():Boolean
public function set noSplitting(value:Boolean):void
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the FootnoteOption (a Application or Document).
public function get parent():Object
prefix | property |
prefix:String
Since : | CS5 |
The prefix text of the footnote. (Limit: 0 to 100 characters)
public function get prefix():String
public function set prefix(value:String):void
properties | property |
properties:Object
[override] 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
restartNumbering | property |
restartNumbering:Object
Since : | CS5 |
The point at which to restart footnote numbering. Can return: FootnoteRestarting enumerator or String.
public function get restartNumbering():Object
public function set restartNumbering(value:Object):void
ruleColor | property |
ruleColor:Object
Since : | CS5 |
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.
public function get ruleColor():Object
public function set ruleColor(value:Object):void
ruleGapColor | property |
ruleGapColor:Object
Since : | CS5 |
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.
public function get ruleGapColor():Object
public function set ruleGapColor(value:Object):void
ruleGapOverprint | property |
ruleGapOverprint:Boolean
Since : | CS5 |
If true, overprints the gap color of the rule above the first footnote in the column. Note: Valid when rule type is not solid.
public function get ruleGapOverprint():Boolean
public function set ruleGapOverprint(value:Boolean):void
ruleGapTint | property |
ruleGapTint:Number
Since : | CS5 |
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.
public function get ruleGapTint():Number
public function set ruleGapTint(value:Number):void
ruleLeftIndent | property |
ruleLeftIndent:Object
Since : | CS5 |
The amount to left indent the rule above the first footnote in the column. Note: Valid when rule on is true.
public function get ruleLeftIndent():Object
public function set ruleLeftIndent(value:Object):void
ruleLineWeight | property |
ruleLineWeight:Object
Since : | CS5 |
The stroke weight of the rule above the first footnote in the column. (Range: 0 to 1000) Note: Valid when rule on is true.
public function get ruleLineWeight():Object
public function set ruleLineWeight(value:Object):void
ruleOffset | property |
ruleOffset:Object
Since : | CS5 |
The vertical offset of the rule above the first footnote in the column. Note: Valid when rule on is true.
public function get ruleOffset():Object
public function set ruleOffset(value:Object):void
ruleOn | property |
ruleOn:Boolean
Since : | CS5 |
If true, draws a rule between the text and the first footnote in the column.
public function get ruleOn():Boolean
public function set ruleOn(value:Boolean):void
ruleOverprint | property |
ruleOverprint:Boolean
Since : | CS5 |
If true, overprints the rule above the first footnote in the column. Note: Valid when rule on is true.
public function get ruleOverprint():Boolean
public function set ruleOverprint(value:Boolean):void
ruleTint | property |
ruleTint:Number
Since : | CS5 |
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.
public function get ruleTint():Number
public function set ruleTint(value:Number):void
ruleType | property |
ruleType:Object
Since : | CS5 |
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.
public function get ruleType():Object
public function set ruleType(value:Object):void
ruleWidth | property |
ruleWidth:Object
Since : | CS5 |
The length of the rule above the first footnote in the column. Note: Valid when rule on is true.
public function get ruleWidth():Object
public function set ruleWidth(value:Object):void
separatorText | property |
separatorText:String
Since : | CS5 |
The text to insert between the footnote marker number and the footnote text. (Range: 0 to 100 characters)
public function get separatorText():String
public function set separatorText(value:String):void
showPrefixSuffix | property |
showPrefixSuffix:Object
Since : | CS5 |
The position of the footnote prefix and/or suffix. Can return: FootnotePrefixSuffix enumerator or String.
public function get showPrefixSuffix():Object
public function set showPrefixSuffix(value:Object):void
spaceBetween | property |
spaceBetween:Object
Since : | CS5 |
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.
public function get spaceBetween():Object
public function set spaceBetween(value:Object):void
spacer | property |
spacer:Object
Since : | CS5 |
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.
public function get spacer():Object
public function set spacer(value:Object):void
startAt | property |
startAt:Number
Since : | CS5 |
The number at which to start footnote numbering.
public function get startAt():Number
public function set startAt(value:Number):void
suffix | property |
suffix:String
Since : | CS5 |
The suffix text of the footnote. (Limit: 0 to 100 characters)
public function get suffix():String
public function set suffix(value:String):void
addEventListenerFootnoteOption | () | method |
public function addEventListenerFootnoteOption(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 |
getElements | () | method |
override public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
removeEventListenerFootnoteOption | () | method |
public function removeEventListenerFootnoteOption(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 |
override public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |