Packagecom.adobe.photoshop
Classpublic class LayerComp
InheritanceLayerComp Inheritance PhotoshopHostObject Inheritance CSHostObject Inheritance flash.utils.Proxy

A snapshot of a state of the layers in a document (can be used to view different page layouts or compostions).



Public Properties
 PropertyDefined By
  appearance : Boolean
If true, uses layer appearance (layer styles) settings.
LayerComp
  comment : Object
The description of the layer comp.
LayerComp
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  name : String
The name of the layer comp.
LayerComp
 Inheritedparent : *
[read-only]
PhotoshopHostObject
  position : Boolean
If true, uses layer position.
LayerComp
  selected : Boolean
[read-only] If true, the layer comp is currently selected.
LayerComp
  visibility : Boolean
If true, the layer comp is visible.
LayerComp
Public Methods
 MethodDefined By
  
apply():void
Applies the layer comp to the document.
LayerComp
 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
 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
  
recapture():void
Recaptures the current layer state(s) for this layer comp.
LayerComp
  
remove():void
delete the object
LayerComp
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
Resets the layer comp state to the document state.
LayerComp
 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
appearanceproperty
appearance:Boolean

If true, uses layer appearance (layer styles) settings.


Implementation
    public function get appearance():Boolean
    public function set appearance(value:Boolean):void
commentproperty 
comment:Object

The description of the layer comp.


Implementation
    public function get comment():Object
    public function set comment(value:Object):void
nameproperty 
name:String

The name of the layer comp.


Implementation
    public function get name():String
    public function set name(value:String):void
positionproperty 
position:Boolean

If true, uses layer position.


Implementation
    public function get position():Boolean
    public function set position(value:Boolean):void
selectedproperty 
selected:Boolean  [read-only]

If true, the layer comp is currently selected.


Implementation
    public function get selected():Boolean
visibilityproperty 
visibility:Boolean

If true, the layer comp is visible.


Implementation
    public function get visibility():Boolean
    public function set visibility(value:Boolean):void
Method Detail
apply()method
public function apply():void

Applies the layer comp to the document.

recapture()method 
public function recapture():void

Recaptures the current layer state(s) for this layer comp.

remove()method 
public function remove():void

delete the object

resetFromComp()method 
public function resetFromComp():void

Resets the layer comp state to the document state.