Adobe InCopy CS5 (7.0) Object Model JS: GraphicLayer

InCopy CS5

previous page next page

Class

GraphicLayer

A layer in a PSD image or PDF file.

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

GraphicLayer | GraphicLayerOption

GraphicLayer

Event | EventListener | GraphicLayer | MutationEvent

Properties

Property	Type	Access	Description
adjustmentLayer	bool	readonly	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.
currentVisibility	bool	r/w	If true, the layer is visible in the document.
eventListeners	EventListeners	readonly	A collection of event listeners.
events	Events	readonly	A collection of events.
exportState	bool	readonly	If true, the export state is on.
fxLayer	bool	readonly	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.
graphicLayers	GraphicLayers	readonly	A collection of graphic layers.
hasExportState	bool	readonly	If true, the layer has an export state.
hasPrintState	bool	readonly	If true, the layer has a print state.
hasViewState	bool	readonly	If true, the layer has a view state.
id	number	readonly	The unique ID of the GraphicLayer.
index	number	readonly	The index of the GraphicLayer within its containing object.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
locked	bool	readonly	If true, the GraphicLayer is locked.
name	string	readonly	The name of the GraphicLayer.
originalVisibility	bool	readonly	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.
parent	GraphicLayerGraphicLayerOption	readonly	The parent of the GraphicLayer (a GraphicLayerOption or GraphicLayer).
printState	bool	readonly	If true, the print state is on.
properties	Object	r/w	A property that allows setting of several properties at the same time.
sectionDividerLayer	bool	readonly	If true, the layer is a section divider layer.
separatorLayer	bool	readonly	If true, the layer is a separator layer.
viewState	bool	readonly	If true, the view state is on.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

Array of GraphicLayer getElements ()
Resolves the object specifier, creating an array of object references.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)