Package | com.adobe.incopy |
Class | public class GraphicLayer |
Inheritance | GraphicLayer ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
adjustmentLayer : Boolean [read-only]
If true, the layer is an adjustment layer. | GraphicLayer | ||
currentVisibility : Boolean
If true, the layer is visible in the document. | GraphicLayer | ||
eventListeners : EventListeners [read-only]
A collection of event listeners. | GraphicLayer | ||
events : Events [read-only]
A collection of events. | GraphicLayer | ||
exportState : Boolean [read-only]
If true, the export state is on. | GraphicLayer | ||
fxLayer : Boolean [read-only]
If true, layer effects have been applied to the layer. | GraphicLayer | ||
graphicLayers : GraphicLayers [read-only]
A collection of graphic layers. | GraphicLayer | ||
hasExportState : Boolean [read-only]
If true, the layer has an export state. | GraphicLayer | ||
hasPrintState : Boolean [read-only]
If true, the layer has a print state. | GraphicLayer | ||
hasViewState : Boolean [read-only]
If true, the layer has a view state. | GraphicLayer | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
id : Number [read-only]
The unique ID of the GraphicLayer. | GraphicLayer | ||
index : Number [read-only]
The index of the GraphicLayer within its containing object. | GraphicLayer | ||
isValid : Boolean [read-only]
Returns true if the object specifier resolves to valid objects. | GraphicLayer | ||
locked : Boolean [read-only]
If true, the GraphicLayer is locked. | GraphicLayer | ||
name : String [read-only]
The name of the GraphicLayer. | GraphicLayer | ||
originalVisibility : Boolean [read-only]
Returns the visibility setting set for the layer before the graphic file was imported. | GraphicLayer | ||
parent : Object [read-only]
The parent of the GraphicLayer (a GraphicLayerOption or GraphicLayer). | GraphicLayer | ||
printState : Boolean [read-only]
If true, the print state is on. | GraphicLayer | ||
properties : Object
A property that allows setting of several properties at the same time. | GraphicLayer | ||
sectionDividerLayer : Boolean [read-only]
If true, the layer is a section divider layer. | GraphicLayer | ||
separatorLayer : Boolean [read-only]
If true, the layer is a separator layer. | GraphicLayer | ||
viewState : Boolean [read-only]
If true, the view state is on. | GraphicLayer |
Method | Defined By | ||
---|---|---|---|
addEventListenerGraphicLayer(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | GraphicLayer | ||
![]() | 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. | GraphicLayer | ||
![]() | 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 | |
removeEventListenerGraphicLayer(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | GraphicLayer | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String
Retrieves the object specifier. | GraphicLayer | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
adjustmentLayer | property |
adjustmentLayer:Boolean
[read-only] Since : | CS5 |
If true, the layer is an adjustment layer. Note: Must occur in the script before overriding the visibility state of the layer with a current visibility statement.
public function get adjustmentLayer():Boolean
currentVisibility | property |
currentVisibility:Boolean
Since : | CS5 |
If true, the layer is visible in the document.
public function get currentVisibility():Boolean
public function set currentVisibility(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
exportState | property |
exportState:Boolean
[read-only] Since : | CS5 |
If true, the export state is on.
public function get exportState():Boolean
fxLayer | property |
fxLayer:Boolean
[read-only] Since : | CS5 |
If true, layer effects have been applied to the layer. Note: Must occur in the script before overriding the visibility state of the layer with a current visibility statement.
public function get fxLayer():Boolean
graphicLayers | property |
graphicLayers:GraphicLayers
[read-only] Since : | CS5 |
A collection of graphic layers.
public function get graphicLayers():GraphicLayers
hasExportState | property |
hasExportState:Boolean
[read-only] Since : | CS5 |
If true, the layer has an export state.
public function get hasExportState():Boolean
hasPrintState | property |
hasPrintState:Boolean
[read-only] Since : | CS5 |
If true, the layer has a print state.
public function get hasPrintState():Boolean
hasViewState | property |
hasViewState:Boolean
[read-only] Since : | CS5 |
If true, the layer has a view state.
public function get hasViewState():Boolean
id | property |
id:Number
[read-only] Since : | CS5 |
The unique ID of the GraphicLayer.
public function get id():Number
index | property |
index:Number
[read-only] Since : | CS5 |
The index of the GraphicLayer 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
locked | property |
locked:Boolean
[read-only] Since : | CS5 |
If true, the GraphicLayer is locked.
public function get locked():Boolean
name | property |
name:String
[read-only] Since : | CS5 |
The name of the GraphicLayer.
public function get name():String
originalVisibility | property |
originalVisibility:Boolean
[read-only] Since : | CS5 |
Returns the visibility setting set for the layer before the graphic file was imported. Note: Must occur in the script before overriding the visibility state with a current visibility statement.
public function get originalVisibility():Boolean
parent | property |
parent:Object
[read-only] Since : | CS5 |
The parent of the GraphicLayer (a GraphicLayerOption or GraphicLayer).
public function get parent():Object
printState | property |
printState:Boolean
[read-only] Since : | CS5 |
If true, the print state is on.
public function get printState():Boolean
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
sectionDividerLayer | property |
sectionDividerLayer:Boolean
[read-only] Since : | CS5 |
If true, the layer is a section divider layer.
public function get sectionDividerLayer():Boolean
separatorLayer | property |
separatorLayer:Boolean
[read-only] Since : | CS5 |
If true, the layer is a separator layer.
public function get separatorLayer():Boolean
viewState | property |
viewState:Boolean
[read-only] Since : | CS5 |
If true, the view state is on.
public function get viewState():Boolean
addEventListenerGraphicLayer | () | method |
public function addEventListenerGraphicLayer(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 |
public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
removeEventListenerGraphicLayer | () | method |
public function removeEventListenerGraphicLayer(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 |
public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |