Packagecom.adobe.indesign
Classpublic class StoryGridDataInformation
InheritanceStoryGridDataInformation Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Preference



Public Properties
 PropertyDefined By
  appliedFont : Object
The font applied to the StoryGridDataInformation, specified as either a font object or the name of font family.
StoryGridDataInformation
  characterAki : Number
The amount of white space between characters.
StoryGridDataInformation
  characterAlignment : CharacterAlignment
The alignment of small characters to the largest character in the line.
StoryGridDataInformation
  characterCountLocation : CharacterCountLocation
The character count location.
StoryGridDataInformation
  characterCountSize : Number
The character size for the character count display.
StoryGridDataInformation
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
StoryGridDataInformation
  events : Events
[override] [read-only] A collection of events.
StoryGridDataInformation
  fontStyle : String
The name of the font style.
StoryGridDataInformation
  gridAlignment : GridAlignment
The alignment to the frame grid or baseline grid.
StoryGridDataInformation
  gridView : GridViewSettings
The grid view setting.
StoryGridDataInformation
  horizontalScale : Number
The horizontal scaling applied to the StoryGridDataInformation.
StoryGridDataInformation
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
StoryGridDataInformation
  lineAki : Number
The amount of white space between lines.
StoryGridDataInformation
  lineAlignment : LineAlignment
The line justification.
StoryGridDataInformation
  parent : Object
[override] [read-only] The parent of the StoryGridDataInformation (a Application or Document).
StoryGridDataInformation
  pointSize : Object
The text size.
StoryGridDataInformation
  properties : Object
[override] A property that allows setting of several properties at the same time.
StoryGridDataInformation
  verticalScale : Number
The vertical scaling applied to the StoryGridDataInformation.
StoryGridDataInformation
Public Methods
 MethodDefined By
 Inherited
addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Preference
  
addEventListenerStoryGridDataInformation(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
StoryGridDataInformation
 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.
StoryGridDataInformation
 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
 Inherited
removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Preference
  
removeEventListenerStoryGridDataInformation(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
StoryGridDataInformation
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
[override] Retrieves the object specifier.
StoryGridDataInformation
 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
appliedFontproperty
appliedFont:Object

The font applied to the StoryGridDataInformation, specified as either a font object or the name of font family. Can return: Font or String.


Implementation
    public function get appliedFont():Object
    public function set appliedFont(value:Object):void
characterAkiproperty 
characterAki:Number

The amount of white space between characters.


Implementation
    public function get characterAki():Number
    public function set characterAki(value:Number):void
characterAlignmentproperty 
characterAlignment:CharacterAlignment

The alignment of small characters to the largest character in the line.


Implementation
    public function get characterAlignment():CharacterAlignment
    public function set characterAlignment(value:CharacterAlignment):void
characterCountLocationproperty 
characterCountLocation:CharacterCountLocation

The character count location. Note: Valid when show character count is true.


Implementation
    public function get characterCountLocation():CharacterCountLocation
    public function set characterCountLocation(value:CharacterCountLocation):void
characterCountSizeproperty 
characterCountSize:Number

The character size for the character count display.


Implementation
    public function get characterCountSize():Number
    public function set characterCountSize(value:Number):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
fontStyleproperty 
fontStyle:String

The name of the font style.


Implementation
    public function get fontStyle():String
    public function set fontStyle(value:String):void
gridAlignmentproperty 
gridAlignment:GridAlignment

The alignment to the frame grid or baseline grid.


Implementation
    public function get gridAlignment():GridAlignment
    public function set gridAlignment(value:GridAlignment):void
gridViewproperty 
gridView:GridViewSettings

The grid view setting.


Implementation
    public function get gridView():GridViewSettings
    public function set gridView(value:GridViewSettings):void
horizontalScaleproperty 
horizontalScale:Number

The horizontal scaling applied to the StoryGridDataInformation.


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

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
lineAkiproperty 
lineAki:Number

The amount of white space between lines.


Implementation
    public function get lineAki():Number
    public function set lineAki(value:Number):void
lineAlignmentproperty 
lineAlignment:LineAlignment

The line justification.


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

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


Implementation
    public function get parent():Object
pointSizeproperty 
pointSize:Object

The text size.


Implementation
    public function get pointSize():Object
    public function set pointSize(value:Object):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
verticalScaleproperty 
verticalScale:Number

The vertical scaling applied to the StoryGridDataInformation.


Implementation
    public function get verticalScale():Number
    public function set verticalScale(value:Number):void
Method Detail
addEventListenerStoryGridDataInformation()method
public function addEventListenerStoryGridDataInformation(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
removeEventListenerStoryGridDataInformation()method 
public function removeEventListenerStoryGridDataInformation(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