Package | com.adobe.indesign |
Class | public class GuidePreference |
Inheritance | GuidePreference ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
eventListeners : EventListeners [override] [read-only]
A collection of event listeners. | GuidePreference | ||
events : Events [override] [read-only]
A collection of events. | GuidePreference | ||
guidesInBack : Boolean
If true, places guides behind all other objects on the spread. | GuidePreference | ||
guidesLocked : Boolean
If true, guides cannot be moved, added, or deleted. | GuidePreference | ||
guidesShown : Boolean
If true, displays the guides. | GuidePreference | ||
guidesSnapto : Boolean
If true, an object within the specified range snaps to the nearest guide when the object is created, moved, or resized. | GuidePreference | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
isValid : Boolean [override] [read-only]
Returns true if the object specifier resolves to valid objects. | GuidePreference | ||
parent : Object [override] [read-only]
The parent of the GuidePreference (a Application or Document). | GuidePreference | ||
properties : Object [override]
A property that allows setting of several properties at the same time. | GuidePreference | ||
rulerGuidesColor : Object
The color of the guide, 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. | GuidePreference | ||
rulerGuidesViewThreshold : Number
The magnification (as a percentage) less than which ruler guides do not appear. | GuidePreference |
Method | Defined By | ||
---|---|---|---|
addEventListenerGuidePreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | GuidePreference | ||
![]() | 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. | GuidePreference | ||
![]() | 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 | |
removeEventListenerGuidePreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | GuidePreference | ||
![]() | 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. | GuidePreference | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
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
guidesInBack | property |
guidesInBack:Boolean
Since : | CS5 |
If true, places guides behind all other objects on the spread.
public function get guidesInBack():Boolean
public function set guidesInBack(value:Boolean):void
guidesLocked | property |
guidesLocked:Boolean
Since : | CS5 |
If true, guides cannot be moved, added, or deleted.
public function get guidesLocked():Boolean
public function set guidesLocked(value:Boolean):void
guidesShown | property |
guidesShown:Boolean
Since : | CS5 |
If true, displays the guides.
public function get guidesShown():Boolean
public function set guidesShown(value:Boolean):void
guidesSnapto | property |
guidesSnapto:Boolean
Since : | CS5 |
If true, an object within the specified range snaps to the nearest guide when the object is created, moved, or resized. For range information, see guide snapto zone.
public function get guidesSnapto():Boolean
public function set guidesSnapto(value:Boolean):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 GuidePreference (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
rulerGuidesColor | property |
rulerGuidesColor:Object
Since : | CS5 |
The color of the guide, 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.
public function get rulerGuidesColor():Object
public function set rulerGuidesColor(value:Object):void
rulerGuidesViewThreshold | property |
rulerGuidesViewThreshold:Number
Since : | CS5 |
The magnification (as a percentage) less than which ruler guides do not appear. (Range: 5 to 4000)
public function get rulerGuidesViewThreshold():Number
public function set rulerGuidesViewThreshold(value:Number):void
addEventListenerGuidePreference | () | method |
public function addEventListenerGuidePreference(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 |
removeEventListenerGuidePreference | () | method |
public function removeEventListenerGuidePreference(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 |