Package | com.adobe.indesign |
Class | public class Guide |
Inheritance | Guide ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
AFTER_PLACE : String [static] [read-only]
Dispatched after a Guide is placed. | Guide | ||
allowOverrides : Boolean
If true, the master page item can be overridden. | Guide | ||
eventListeners : EventListeners [read-only]
A collection of event listeners. | Guide | ||
events : Events [read-only]
A collection of events. | Guide | ||
fitToPage : Boolean
If true, horizontal orientation guides stop at the edges of the specified page. | Guide | ||
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. | Guide | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
id : Number [read-only]
The unique ID of the Guide. | Guide | ||
index : Number [read-only]
The index of the Guide within its containing object. | Guide | ||
isValid : Boolean [read-only]
Returns true if the object specifier resolves to valid objects. | Guide | ||
itemLayer : Layer
The layer that the Guide is on. | Guide | ||
label : String
A property that can be set to any string. | Guide | ||
location : Object
The location at which to place the guide relative to the current ruler zero point. | Guide | ||
locked : Boolean
If true, the Guide is locked. | Guide | ||
name : String
The name of the Guide; this is an alias to the Guide's label property. | Guide | ||
orientation : HorizontalOrVertical
The orientation of the guide. | Guide | ||
overridden : Boolean [read-only]
If true, the object originated on a master spread and was overridden. | Guide | ||
overriddenMasterPageItem : Object [read-only]
An object that originated on a master page and has been overridden. | Guide | ||
parent : Object [read-only]
The parent of the Guide (a Spread or MasterSpread). | Guide | ||
parentPage : Page [read-only]
The page on which this page item appears. | Guide | ||
properties : Object
A property that allows setting of several properties at the same time. | Guide | ||
viewThreshold : Number
The view magnification as a percentage below which guides are no longer displayed. | Guide |
Method | Defined By | ||
---|---|---|---|
addEventListenerGuide(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Guide | ||
detach():void
Detaches an overridden master page item from the master page. | Guide | ||
Duplicates the Guide. | Guide | ||
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key. | Guide | ||
![]() | 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
Resolves the object specifier, creating an array of object references. | Guide | ||
![]() | 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 | |
insertLabel(keyParam:String = null, valueParam:String = null):void
Sets the label to the value associated with the specified key. | Guide | ||
![]() | 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 | |
move(toParam:Array = null, byParam:Array = null):void
Moves the guide to a new location. | Guide | ||
Overrides a master page item and places the item on the document page as a new object. | Guide | ||
remove():void
Deletes the Guide. | Guide | ||
removeEventListenerGuide(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Guide | ||
removeOverride():void
Removes the override from a previously overridden master page item. | Guide | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
select(existingSelectionParam:SelectionOptions = null):void
Selects the object. | Guide | ||
toSpecifier():String
Retrieves the object specifier. | Guide | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
AFTER_PLACE | property |
AFTER_PLACE:String
[read-only] Since : | CS5 |
Dispatched after a Guide is placed. This event bubbles. This event is not cancelable.
public static function get AFTER_PLACE():String
allowOverrides | property |
allowOverrides:Boolean
Since : | CS5 |
If true, the master page item can be overridden.
public function get allowOverrides():Boolean
public function set allowOverrides(value:Boolean):void
eventListeners | property |
eventListeners:EventListeners
[read-only] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] Since : | CS5 |
A collection of events.
public function get events():Events
fitToPage | property |
fitToPage:Boolean
Since : | CS5 |
If true, horizontal orientation guides stop at the edges of the specified page. If false, the guides extends across the width of the spread and into the pasteboard area.
public function get fitToPage():Boolean
public function set fitToPage(value:Boolean):void
guideColor | property |
guideColor: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 guideColor():Object
public function set guideColor(value:Object):void
id | property |
id:Number
[read-only] Since : | CS5 |
The unique ID of the Guide.
public function get id():Number
index | property |
index:Number
[read-only] Since : | CS5 |
The index of the Guide within its containing object.
public function get index():Number
isValid | property |
isValid:Boolean
[read-only] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
itemLayer | property |
itemLayer:Layer
Since : | CS5 |
The layer that the Guide is on.
public function get itemLayer():Layer
public function set itemLayer(value:Layer):void
label | property |
label:String
Since : | CS5 |
A property that can be set to any string.
public function get label():String
public function set label(value:String):void
location | property |
location:Object
Since : | CS5 |
The location at which to place the guide relative to the current ruler zero point.
public function get location():Object
public function set location(value:Object):void
locked | property |
locked:Boolean
Since : | CS5 |
If true, the Guide is locked.
public function get locked():Boolean
public function set locked(value:Boolean):void
name | property |
name:String
Since : | CS5 |
The name of the Guide; this is an alias to the Guide's label property.
public function get name():String
public function set name(value:String):void
orientation | property |
orientation:HorizontalOrVertical
Since : | CS5 |
The orientation of the guide.
public function get orientation():HorizontalOrVertical
public function set orientation(value:HorizontalOrVertical):void
overridden | property |
overridden:Boolean
[read-only] Since : | CS5 |
If true, the object originated on a master spread and was overridden. If false, the object either originated on a master spread and was not overridden, or the object did not originate on a master page.
public function get overridden():Boolean
overriddenMasterPageItem | property |
overriddenMasterPageItem:Object
[read-only] Since : | CS5 |
An object that originated on a master page and has been overridden. Can return: PageItem, Guide, Graphic, Movie or Sound.
public function get overriddenMasterPageItem():Object
parent | property |
parent:Object
[read-only] Since : | CS5 |
The parent of the Guide (a Spread or MasterSpread).
public function get parent():Object
parentPage | property |
parentPage:Page
[read-only] Since : | CS5 |
The page on which this page item appears.
public function get parentPage():Page
properties | property |
properties:Object
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
viewThreshold | property |
viewThreshold:Number
Since : | CS5 |
The view magnification as a percentage below which guides are no longer displayed. (Range: 5.0 to 4000.0)
public function get viewThreshold():Number
public function set viewThreshold(value:Number):void
addEventListenerGuide | () | method |
public function addEventListenerGuide(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 |
detach | () | method |
public function detach():void
Since : | CS5 |
Detaches an overridden master page item from the master page.
duplicate | () | method |
extractLabel | () | method |
public function extractLabel(keyParam:String = null):String
Since : | CS5 |
Gets the label value associated with the specified key.
Parameters
keyParam:String (default = null ) — (String) The key.
|
String |
getElements | () | method |
public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
insertLabel | () | method |
public function insertLabel(keyParam:String = null, valueParam:String = null):void
Since : | CS5 |
Sets the label to the value associated with the specified key.
Parameters
keyParam:String (default = null ) — (String) The key.
| |
valueParam:String (default = null ) — (String) The value.
|
move | () | method |
public function move(toParam:Array = null, byParam:Array = null):void
Since : | CS5 |
Moves the guide to a new location. Note: Either the to or the by parameter is required; if both parameters are defined, only the to value is used.
Parameters
toParam:Array (default = null ) — (Array) The new location of the guide, in the format [x, y]. (Optional)
| |
byParam:Array (default = null ) — (Array) The amount to move the guide relative to its current position, in the format [x, y]. (Optional)
|
override | () | method |
public function override(destinationPageParam:Page = null):Object
Since : | CS5 |
Overrides a master page item and places the item on the document page as a new object.
Parameters
destinationPageParam:Page (default = null ) — (Page) The document page that contains the master page item to override.
|
Object |
remove | () | method |
public function remove():void
Since : | CS5 |
Deletes the Guide.
removeEventListenerGuide | () | method |
public function removeEventListenerGuide(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 |
removeOverride | () | method |
public function removeOverride():void
Since : | CS5 |
Removes the override from a previously overridden master page item.
select | () | method |
public function select(existingSelectionParam:SelectionOptions = null):void
Since : | CS5 |
Selects the object.
Parameters
existingSelectionParam:SelectionOptions (default = null ) — (SelectionOptions) The selection status of the Guide in relation to previously selected objects. (Optional)
|
toSpecifier | () | method |
public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |