Packagecom.adobe.indesign
Classpublic class CjkGridPreference
InheritanceCjkGridPreference Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Preference



Public Properties
 PropertyDefined By
  colorEveryNthCell : Number
Applies the grid color to every nth cell, where n is the value of this property.
CjkGridPreference
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
CjkGridPreference
  events : Events
[override] [read-only] A collection of events.
CjkGridPreference
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  icfMode : Boolean
If true, uses ICF mode for grid cells.
CjkGridPreference
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
CjkGridPreference
  layoutGridColorIndex : Object
The layout grid color, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color.
CjkGridPreference
  minimumScale : Number
The view magnification (as a percentage) less than which grids do not appear.
CjkGridPreference
  parent : Object
[override] [read-only] The parent of the CjkGridPreference (a Application or Document).
CjkGridPreference
  properties : Object
[override] A property that allows setting of several properties at the same time.
CjkGridPreference
  showAllFrameGrids : Boolean
If true, displays the frame (story) grids.
CjkGridPreference
  showAllLayoutGrids : Boolean
If true, displays the layout grids.
CjkGridPreference
  showCharacterCount : Boolean
If true, displays the character count for the frame.
CjkGridPreference
  singleLineColorMode : Boolean
If true, applies the grid color from the the edge of the line.
CjkGridPreference
  snapToLayoutGrid : Boolean
If true, objects snap to the layout grid.
CjkGridPreference
  useCircularCells : Boolean
If true, cell shape is circular.
CjkGridPreference
Public Methods
 MethodDefined By
  
addEventListenerCjkGridPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
CjkGridPreference
 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.
CjkGridPreference
 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
  
removeEventListenerCjkGridPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
CjkGridPreference
 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.
CjkGridPreference
 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
colorEveryNthCellproperty
colorEveryNthCell:Number

Applies the grid color to every nth cell, where n is the value of this property.


Implementation
    public function get colorEveryNthCell():Number
    public function set colorEveryNthCell(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
icfModeproperty 
icfMode:Boolean

If true, uses ICF mode for grid cells. If false, uses virtual body mode.


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

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
layoutGridColorIndexproperty 
layoutGridColorIndex:Object

The layout grid color, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.


Implementation
    public function get layoutGridColorIndex():Object
    public function set layoutGridColorIndex(value:Object):void
minimumScaleproperty 
minimumScale:Number

The view magnification (as a percentage) less than which grids do not appear. (Range: 5 to 4000)


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

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


Implementation
    public function get parent():Object
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
showAllFrameGridsproperty 
showAllFrameGrids:Boolean

If true, displays the frame (story) grids.


Implementation
    public function get showAllFrameGrids():Boolean
    public function set showAllFrameGrids(value:Boolean):void
showAllLayoutGridsproperty 
showAllLayoutGrids:Boolean

If true, displays the layout grids.


Implementation
    public function get showAllLayoutGrids():Boolean
    public function set showAllLayoutGrids(value:Boolean):void
showCharacterCountproperty 
showCharacterCount:Boolean

If true, displays the character count for the frame.


Implementation
    public function get showCharacterCount():Boolean
    public function set showCharacterCount(value:Boolean):void
singleLineColorModeproperty 
singleLineColorMode:Boolean

If true, applies the grid color from the the edge of the line. If false, applies the grid color from the corner of the frame.


Implementation
    public function get singleLineColorMode():Boolean
    public function set singleLineColorMode(value:Boolean):void
snapToLayoutGridproperty 
snapToLayoutGrid:Boolean

If true, objects snap to the layout grid.


Implementation
    public function get snapToLayoutGrid():Boolean
    public function set snapToLayoutGrid(value:Boolean):void
useCircularCellsproperty 
useCircularCells:Boolean

If true, cell shape is circular. If false, cell shape is rectangular.


Implementation
    public function get useCircularCells():Boolean
    public function set useCircularCells(value:Boolean):void
Method Detail
addEventListenerCjkGridPreference()method
public function addEventListenerCjkGridPreference(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
removeEventListenerCjkGridPreference()method 
public function removeEventListenerCjkGridPreference(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