Package | com.adobe.indesign |
Class | public class GridPreference |
Inheritance | GridPreference ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
baselineColor : Object
The color of the baseline grid, specified either as an array of three doubles, each in the range 0 to 255, representing R, G, and B values, or as a UI color. | GridPreference | ||
baselineDivision : Object
The amount of space between baseline grid lines. | GridPreference | ||
baselineGridRelativeOption : BaselineGridRelativeOption
The zero point for the baseline grid offset. | GridPreference | ||
baselineGridShown : Boolean
If true, displays the baseline grid. | GridPreference | ||
baselineStart : Object
The amount to offset the baseline grid from the zero point. | GridPreference | ||
baselineViewThreshold : Number
The magnification (as a percentage) less than which ruler guides do not appear. | GridPreference | ||
documentGridShown : Boolean
If true, displays the document grid. | GridPreference | ||
documentGridSnapto : Boolean
If true, an object snaps to the nearest grid line when the object is created, moved, or resized. | GridPreference | ||
eventListeners : EventListeners [override] [read-only]
A collection of event listeners. | GridPreference | ||
events : Events [override] [read-only]
A collection of events. | GridPreference | ||
gridColor : Object
The color of the document grid, specified either as an array of three doubles, each in the range 0 to 255, representing R, G, and B values, or as a UI color. | GridPreference | ||
gridsInBack : Boolean
If true, places grids behind all other objects on the spread. | GridPreference | ||
horizontalGridlineDivision : Object
The amount of space between major horizontal lines in the document grid. | GridPreference | ||
horizontalGridSubdivision : Number
The number of rows into which to subdivide the space between horizontal document grid lines. | GridPreference | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
isValid : Boolean [override] [read-only]
Returns true if the object specifier resolves to valid objects. | GridPreference | ||
parent : Object [override] [read-only]
The parent of the GridPreference (a Application or Document). | GridPreference | ||
properties : Object [override]
A property that allows setting of several properties at the same time. | GridPreference | ||
verticalGridlineDivision : Object
The amount of space between major vertical lines in the document grid. | GridPreference | ||
verticalGridSubdivision : Number
The number of columns into which to subdivide the space between vertical document grid lines. | GridPreference |
Method | Defined By | ||
---|---|---|---|
addEventListenerGridPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | GridPreference | ||
![]() | 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. | GridPreference | ||
![]() | 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 | |
removeEventListenerGridPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | GridPreference | ||
![]() | 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. | GridPreference | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
baselineColor | property |
baselineColor:Object
Since : | CS5 |
The color of the baseline grid, specified either as an array of three doubles, each in the range 0 to 255, representing R, G, and B values, or as a UI color. . Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.
public function get baselineColor():Object
public function set baselineColor(value:Object):void
baselineDivision | property |
baselineDivision:Object
Since : | CS5 |
The amount of space between baseline grid lines.
public function get baselineDivision():Object
public function set baselineDivision(value:Object):void
baselineGridRelativeOption | property |
baselineGridRelativeOption:BaselineGridRelativeOption
Since : | CS5 |
The zero point for the baseline grid offset.
public function get baselineGridRelativeOption():BaselineGridRelativeOption
public function set baselineGridRelativeOption(value:BaselineGridRelativeOption):void
baselineGridShown | property |
baselineGridShown:Boolean
Since : | CS5 |
If true, displays the baseline grid.
public function get baselineGridShown():Boolean
public function set baselineGridShown(value:Boolean):void
baselineStart | property |
baselineStart:Object
Since : | CS5 |
The amount to offset the baseline grid from the zero point.
public function get baselineStart():Object
public function set baselineStart(value:Object):void
baselineViewThreshold | property |
baselineViewThreshold:Number
Since : | CS5 |
The magnification (as a percentage) less than which ruler guides do not appear. (Range: 5 to 4000)
public function get baselineViewThreshold():Number
public function set baselineViewThreshold(value:Number):void
documentGridShown | property |
documentGridShown:Boolean
Since : | CS5 |
If true, displays the document grid.
public function get documentGridShown():Boolean
public function set documentGridShown(value:Boolean):void
documentGridSnapto | property |
documentGridSnapto:Boolean
Since : | CS5 |
If true, an object snaps to the nearest grid line when the object is created, moved, or resized.
public function get documentGridSnapto():Boolean
public function set documentGridSnapto(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
gridColor | property |
gridColor:Object
Since : | CS5 |
The color of the document grid, specified either as an array of three doubles, each in the range 0 to 255, representing R, G, and B values, or as a UI color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.
public function get gridColor():Object
public function set gridColor(value:Object):void
gridsInBack | property |
gridsInBack:Boolean
Since : | CS5 |
If true, places grids behind all other objects on the spread.
public function get gridsInBack():Boolean
public function set gridsInBack(value:Boolean):void
horizontalGridlineDivision | property |
horizontalGridlineDivision:Object
Since : | CS5 |
The amount of space between major horizontal lines in the document grid.
public function get horizontalGridlineDivision():Object
public function set horizontalGridlineDivision(value:Object):void
horizontalGridSubdivision | property |
horizontalGridSubdivision:Number
Since : | CS5 |
The number of rows into which to subdivide the space between horizontal document grid lines.
public function get horizontalGridSubdivision():Number
public function set horizontalGridSubdivision(value:Number):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
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the GridPreference (a Application or Document).
public function get parent():Object
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
verticalGridlineDivision | property |
verticalGridlineDivision:Object
Since : | CS5 |
The amount of space between major vertical lines in the document grid.
public function get verticalGridlineDivision():Object
public function set verticalGridlineDivision(value:Object):void
verticalGridSubdivision | property |
verticalGridSubdivision:Number
Since : | CS5 |
The number of columns into which to subdivide the space between vertical document grid lines.
public function get verticalGridSubdivision():Number
public function set verticalGridSubdivision(value:Number):void
addEventListenerGridPreference | () | method |
public function addEventListenerGridPreference(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 |
removeEventListenerGridPreference | () | method |
public function removeEventListenerGridPreference(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 |