Package | com.adobe.incopy |
Class | public class HeaderFooterBreakTypes |
Inheritance | HeaderFooterBreakTypes ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
enumCache : CSEnumSharedCache [static] [read-only] | HeaderFooterBreakTypes | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
inAllTextColumns : HeaderFooterBreakTypes [static] [read-only] Alias for IN_ALL_TEXT_COLUMNS. | HeaderFooterBreakTypes | ||
IN_ALL_TEXT_COLUMNS : HeaderFooterBreakTypes [static] [read-only]
Places headers or footers in each text column. | HeaderFooterBreakTypes | ||
oncePerPage : HeaderFooterBreakTypes [static] [read-only] Alias for ONCE_PER_PAGE. | HeaderFooterBreakTypes | ||
ONCE_PER_PAGE : HeaderFooterBreakTypes [static] [read-only]
Places one instance of headers or footers per page. | HeaderFooterBreakTypes | ||
oncePerTextFrame : HeaderFooterBreakTypes [static] [read-only] Alias for ONCE_PER_TEXT_FRAME. | HeaderFooterBreakTypes | ||
ONCE_PER_TEXT_FRAME : HeaderFooterBreakTypes [static] [read-only]
Repeats headers or footers in each text frame. | HeaderFooterBreakTypes | ||
![]() | value : Object [read-only]
Returns the numerical value
| CSEnumBase |
Method | Defined By | ||
---|---|---|---|
HeaderFooterBreakTypes(ho:HostObject = null, enum:Number)
Constructor
| HeaderFooterBreakTypes | ||
![]() | 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 | |
![]() | 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 | |
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
enumCache | property |
enumCache:CSEnumSharedCache
[read-only] Since : | CS5 |
public static function get enumCache():CSEnumSharedCache
IN_ALL_TEXT_COLUMNS | property |
IN_ALL_TEXT_COLUMNS:HeaderFooterBreakTypes
[read-only] Since : | CS5 |
Places headers or footers in each text column.
public static function get IN_ALL_TEXT_COLUMNS():HeaderFooterBreakTypes
inAllTextColumns | property |
inAllTextColumns:HeaderFooterBreakTypes
[read-only] Since : | CS5 |
Alias for IN_ALL_TEXT_COLUMNS. Places headers or footers in each text column.
public static function get inAllTextColumns():HeaderFooterBreakTypes
ONCE_PER_PAGE | property |
ONCE_PER_PAGE:HeaderFooterBreakTypes
[read-only] Since : | CS5 |
Places one instance of headers or footers per page.
public static function get ONCE_PER_PAGE():HeaderFooterBreakTypes
ONCE_PER_TEXT_FRAME | property |
ONCE_PER_TEXT_FRAME:HeaderFooterBreakTypes
[read-only] Since : | CS5 |
Repeats headers or footers in each text frame.
public static function get ONCE_PER_TEXT_FRAME():HeaderFooterBreakTypes
oncePerPage | property |
oncePerPage:HeaderFooterBreakTypes
[read-only] Since : | CS5 |
Alias for ONCE_PER_PAGE. Places one instance of headers or footers per page.
public static function get oncePerPage():HeaderFooterBreakTypes
oncePerTextFrame | property |
oncePerTextFrame:HeaderFooterBreakTypes
[read-only] Since : | CS5 |
Alias for ONCE_PER_TEXT_FRAME. Repeats headers or footers in each text frame.
public static function get oncePerTextFrame():HeaderFooterBreakTypes
HeaderFooterBreakTypes | () | Constructor |
public function HeaderFooterBreakTypes(ho:HostObject = null, enum:Number)
Since : | CS5 |
Constructor
Parametersho:HostObject (default = null ) — Enumerations value
| |
enum:Number (default = NaN )
|