Packagecom.adobe.indesign
Classpublic class SmartGuidePreference
InheritanceSmartGuidePreference Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Preference



Public Properties
 PropertyDefined By
  alignToObjectCenter : Boolean
If true, smart alignment to object centers is enabled.
SmartGuidePreference
  alignToObjectEdges : Boolean
If true, smart alignment to object edges is enabled.
SmartGuidePreference
  enabled : Boolean
If true, smart guides are enabled.
SmartGuidePreference
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
SmartGuidePreference
  events : Events
[override] [read-only] A collection of events.
SmartGuidePreference
  guideColor : 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.
SmartGuidePreference
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
SmartGuidePreference
  parent : Object
[override] [read-only] The parent of the SmartGuidePreference (a Application).
SmartGuidePreference
  properties : Object
[override] A property that allows setting of several properties at the same time.
SmartGuidePreference
  smartDimensions : Boolean
If true, smart dimensions guides are enabled.
SmartGuidePreference
  smartSpacing : Boolean
If true, smart spacing guides are enabled.
SmartGuidePreference
Public Methods
 MethodDefined By
 Inherited
addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Preference
  
addEventListenerSmartGuidePreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
SmartGuidePreference
 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.
SmartGuidePreference
 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
  
removeEventListenerSmartGuidePreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
SmartGuidePreference
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
[override] Retrieves the object specifier.
SmartGuidePreference
 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
alignToObjectCenterproperty
alignToObjectCenter:Boolean

If true, smart alignment to object centers is enabled.


Implementation
    public function get alignToObjectCenter():Boolean
    public function set alignToObjectCenter(value:Boolean):void
alignToObjectEdgesproperty 
alignToObjectEdges:Boolean

If true, smart alignment to object edges is enabled.


Implementation
    public function get alignToObjectEdges():Boolean
    public function set alignToObjectEdges(value:Boolean):void
enabledproperty 
enabled:Boolean

If true, smart guides are enabled.


Implementation
    public function get enabled():Boolean
    public function set enabled(value:Boolean):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
guideColorproperty 
guideColor: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. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.


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

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
parentproperty 
parent:Object  [read-only] [override]

The parent of the SmartGuidePreference (a Application).


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
smartDimensionsproperty 
smartDimensions:Boolean

If true, smart dimensions guides are enabled.


Implementation
    public function get smartDimensions():Boolean
    public function set smartDimensions(value:Boolean):void
smartSpacingproperty 
smartSpacing:Boolean

If true, smart spacing guides are enabled.


Implementation
    public function get smartSpacing():Boolean
    public function set smartSpacing(value:Boolean):void
Method Detail
addEventListenerSmartGuidePreference()method
public function addEventListenerSmartGuidePreference(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
removeEventListenerSmartGuidePreference()method 
public function removeEventListenerSmartGuidePreference(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