Package | com.adobe.incopy |
Class | public class StoryTypes |
Inheritance | StoryTypes ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
enumCache : CSEnumSharedCache [static] [read-only] | StoryTypes | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
indexingStory : StoryTypes [static] [read-only] Alias for INDEXING_STORY. | StoryTypes | ||
INDEXING_STORY : StoryTypes [static] [read-only]
The story is an index. | StoryTypes | ||
regularStory : StoryTypes [static] [read-only] Alias for REGULAR_STORY. | StoryTypes | ||
REGULAR_STORY : StoryTypes [static] [read-only]
The story is a regular text story. | StoryTypes | ||
tocStory : StoryTypes [static] [read-only] Alias for TOC_STORY. | StoryTypes | ||
TOC_STORY : StoryTypes [static] [read-only]
The story is a table of contents. | StoryTypes | ||
![]() | value : Object [read-only]
Returns the numerical value
| CSEnumBase |
Method | Defined By | ||
---|---|---|---|
StoryTypes(ho:HostObject = null, enum:Number)
Constructor
| StoryTypes | ||
![]() | 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
INDEXING_STORY | property |
INDEXING_STORY:StoryTypes
[read-only] Since : | CS5 |
The story is an index.
public static function get INDEXING_STORY():StoryTypes
indexingStory | property |
indexingStory:StoryTypes
[read-only] Since : | CS5 |
Alias for INDEXING_STORY. The story is an index.
public static function get indexingStory():StoryTypes
REGULAR_STORY | property |
REGULAR_STORY:StoryTypes
[read-only] Since : | CS5 |
The story is a regular text story.
public static function get REGULAR_STORY():StoryTypes
regularStory | property |
regularStory:StoryTypes
[read-only] Since : | CS5 |
Alias for REGULAR_STORY. The story is a regular text story.
public static function get regularStory():StoryTypes
TOC_STORY | property |
TOC_STORY:StoryTypes
[read-only] Since : | CS5 |
The story is a table of contents.
public static function get TOC_STORY():StoryTypes
tocStory | property |
tocStory:StoryTypes
[read-only] Since : | CS5 |
Alias for TOC_STORY. The story is a table of contents.
public static function get tocStory():StoryTypes
StoryTypes | () | Constructor |
public function StoryTypes(ho:HostObject = null, enum:Number)
Since : | CS5 |
Constructor
Parametersho:HostObject (default = null ) — Enumerations value
| |
enum:Number (default = NaN )
|