Package | com.adobe.indesign |
Class | public class Layer |
Inheritance | Layer ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
allGraphics : Object [read-only]
Lists all graphics contained by the Layer. | Layer | ||
allPageItems : Object [read-only]
Lists all page items contained by the Layer. | Layer | ||
buttons : Buttons [read-only]
A collection of buttons. | Layer | ||
epstexts : EPSTexts [read-only]
EPSTexts
| Layer | ||
eventListeners : EventListeners [read-only]
A collection of event listeners. | Layer | ||
events : Events [read-only]
A collection of events. | Layer | ||
formFields : FormFields [read-only]
A collection of form fields. | Layer | ||
graphicLines : GraphicLines [read-only]
A collection of graphic lines. | Layer | ||
groups : Groups [read-only]
A collection of groups. | Layer | ||
guides : Guides [read-only]
A collection of guides. | Layer | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
id : Number [read-only]
The unique ID of the Layer. | Layer | ||
ignoreWrap : Boolean
If true, text wrap settings applied to objects on the layer will not affect text on other layers when the layer is hidden. | Layer | ||
index : Number [read-only]
The index of the Layer within its containing object. | Layer | ||
isValid : Boolean [read-only]
Returns true if the object specifier resolves to valid objects. | Layer | ||
label : String
A property that can be set to any string. | Layer | ||
layerColor : Object
The color of the layer, 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. | Layer | ||
locked : Boolean
If true, the Layer is locked. | Layer | ||
lockGuides : Boolean
If true, the guide positions on the layer are locked. | Layer | ||
multiStateObjects : MultiStateObjects [read-only]
A collection of multi-state objects. | Layer | ||
name : String
The name of the Layer. | Layer | ||
ovals : Ovals [read-only]
A collection of ellipses. | Layer | ||
pageItems : PageItems [read-only]
The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type. | Layer | ||
parent : Document [read-only]
The parent of the Layer (a Document). | Layer | ||
polygons : Polygons [read-only]
A collection of polygons. | Layer | ||
printable : Boolean
If true, the layer will print. | Layer | ||
properties : Object
A property that allows setting of several properties at the same time. | Layer | ||
rectangles : Rectangles [read-only]
A collection of rectangles. | Layer | ||
showGuides : Boolean
If true, guides are visible on the layer. | Layer | ||
splineItems : SplineItems [read-only]
The spline items collection. | Layer | ||
textFrames : TextFrames [read-only]
A collection of text frames. | Layer | ||
visible : Boolean
If true, the Layer is visible. | Layer |
Method | Defined By | ||
---|---|---|---|
addEventListenerLayer(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Layer | ||
Duplicates the Layer. | Layer | ||
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key. | Layer | ||
![]() | 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. | Layer | ||
![]() | 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. | Layer | ||
![]() | 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 | |
Merges the layer with other layer(s). | Layer | ||
Moves the Layer to the specified location. | Layer | ||
remove():void
Deletes the Layer. | Layer | ||
removeEventListenerLayer(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Layer | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String
Retrieves the object specifier. | Layer | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
allGraphics | property |
allGraphics:Object
[read-only] Since : | CS5 |
Lists all graphics contained by the Layer.
public function get allGraphics():Object
allPageItems | property |
allPageItems:Object
[read-only] Since : | CS5 |
Lists all page items contained by the Layer.
public function get allPageItems():Object
buttons | property |
buttons:Buttons
[read-only] Since : | CS5 |
A collection of buttons.
public function get buttons():Buttons
epstexts | property |
epstexts:EPSTexts
[read-only] Since : | CS5 |
EPSTexts
public function get epstexts():EPSTexts
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
formFields | property |
formFields:FormFields
[read-only] Since : | CS5 |
A collection of form fields.
public function get formFields():FormFields
graphicLines | property |
graphicLines:GraphicLines
[read-only] Since : | CS5 |
A collection of graphic lines.
public function get graphicLines():GraphicLines
groups | property |
groups:Groups
[read-only] Since : | CS5 |
A collection of groups.
public function get groups():Groups
guides | property |
guides:Guides
[read-only] Since : | CS5 |
A collection of guides.
public function get guides():Guides
id | property |
id:Number
[read-only] Since : | CS5 |
The unique ID of the Layer.
public function get id():Number
ignoreWrap | property |
ignoreWrap:Boolean
Since : | CS5 |
If true, text wrap settings applied to objects on the layer will not affect text on other layers when the layer is hidden.
public function get ignoreWrap():Boolean
public function set ignoreWrap(value:Boolean):void
index | property |
index:Number
[read-only] Since : | CS5 |
The index of the Layer 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
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
layerColor | property |
layerColor:Object
Since : | CS5 |
The color of the layer, 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 layerColor():Object
public function set layerColor(value:Object):void
locked | property |
locked:Boolean
Since : | CS5 |
If true, the Layer is locked.
public function get locked():Boolean
public function set locked(value:Boolean):void
lockGuides | property |
lockGuides:Boolean
Since : | CS5 |
If true, the guide positions on the layer are locked.
public function get lockGuides():Boolean
public function set lockGuides(value:Boolean):void
multiStateObjects | property |
multiStateObjects:MultiStateObjects
[read-only] Since : | CS5 |
A collection of multi-state objects.
public function get multiStateObjects():MultiStateObjects
name | property |
name:String
Since : | CS5 |
The name of the Layer.
public function get name():String
public function set name(value:String):void
ovals | property |
ovals:Ovals
[read-only] Since : | CS5 |
A collection of ellipses.
public function get ovals():Ovals
pageItems | property |
pageItems:PageItems
[read-only] Since : | CS5 |
The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type.
public function get pageItems():PageItems
parent | property |
parent:Document
[read-only] Since : | CS5 |
The parent of the Layer (a Document).
public function get parent():Document
polygons | property |
polygons:Polygons
[read-only] Since : | CS5 |
A collection of polygons.
public function get polygons():Polygons
printable | property |
printable:Boolean
Since : | CS5 |
If true, the layer will print.
public function get printable():Boolean
public function set printable(value:Boolean):void
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
rectangles | property |
rectangles:Rectangles
[read-only] Since : | CS5 |
A collection of rectangles.
public function get rectangles():Rectangles
showGuides | property |
showGuides:Boolean
Since : | CS5 |
If true, guides are visible on the layer.
public function get showGuides():Boolean
public function set showGuides(value:Boolean):void
splineItems | property |
splineItems:SplineItems
[read-only] Since : | CS5 |
The spline items collection.
public function get splineItems():SplineItems
textFrames | property |
textFrames:TextFrames
[read-only] Since : | CS5 |
A collection of text frames.
public function get textFrames():TextFrames
visible | property |
visible:Boolean
Since : | CS5 |
If true, the Layer is visible.
public function get visible():Boolean
public function set visible(value:Boolean):void
addEventListenerLayer | () | method |
public function addEventListenerLayer(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 |
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.
|
merge | () | method |
public function merge(withParam:Array = null):Layer
Since : | CS5 |
Merges the layer with other layer(s).
Parameters
withParam:Array (default = null ) — (Array) The layer(s) with which to merge.
|
Layer |
move | () | method |
public function move(toParam:LocationOptions = null, referenceParam:Layer = null):Layer
Since : | CS5 |
Moves the Layer to the specified location.
Parameters
toParam:LocationOptions (default = null ) — (LocationOptions) The location relative to the reference object or within the containing object.
| |
referenceParam:Layer (default = null ) — (Layer) The reference object. Note: Required when the to value specifies before or after. (Optional)
|
Layer |
remove | () | method |
public function remove():void
Since : | CS5 |
Deletes the Layer.
removeEventListenerLayer | () | method |
public function removeEventListenerLayer(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 |