Packagecom.adobe.indesign
Classpublic class SatinSetting
InheritanceSatinSetting Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy
Subclasses FindChangeSatinSetting

Preference



Public Properties
 PropertyDefined By
  angle : Number
The light angle of the satin effect.
SatinSetting
  applied : Boolean
If true, applies the satin effect.
SatinSetting
  blendMode : BlendMode
The blending mode for the satin effect.
SatinSetting
  distance : Object
The distance (in pixels) from the SatinSetting to the satin effect.
SatinSetting
  effectColor : Swatch
The color applied to the satin effect, specified as a swatch (color, gradient, tint, or mixed ink), a color library color, a hex value, or as an array of color values.
SatinSetting
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
SatinSetting
  events : Events
[override] [read-only] A collection of events.
SatinSetting
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  invertEffect : Boolean
If true, inverts the satin effect.
SatinSetting
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
SatinSetting
  opacity : Number
The opacity of the satin effect (as a percentage).
SatinSetting
  parent : Object
[override] [read-only] The parent of the SatinSetting (a TransparencySetting, StrokeTransparencySetting, FillTransparencySetting or ContentTransparencySetting).
SatinSetting
  properties : Object
[override] A property that allows setting of several properties at the same time.
SatinSetting
  size : Object
The width (in pixels) of the satin effect.
SatinSetting
Public Methods
 MethodDefined By
 Inherited
addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Preference
  
addEventListenerSatinSetting(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
SatinSetting
 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
  
getElements():Object
[override] Resolves the object specifier, creating an array of object references.
SatinSetting
 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
 Inherited
removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Preference
  
removeEventListenerSatinSetting(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
SatinSetting
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
[override] Retrieves the object specifier.
SatinSetting
 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
angleproperty
angle:Number

The light angle of the satin effect. (Range: -360 to 360)


Implementation
    public function get angle():Number
    public function set angle(value:Number):void
appliedproperty 
applied:Boolean

If true, applies the satin effect.


Implementation
    public function get applied():Boolean
    public function set applied(value:Boolean):void
blendModeproperty 
blendMode:BlendMode

The blending mode for the satin effect.


Implementation
    public function get blendMode():BlendMode
    public function set blendMode(value:BlendMode):void
distanceproperty 
distance:Object

The distance (in pixels) from the SatinSetting to the satin effect.


Implementation
    public function get distance():Object
    public function set distance(value:Object):void
effectColorproperty 
effectColor:Swatch

The color applied to the satin effect, specified as a swatch (color, gradient, tint, or mixed ink), a color library color, a hex value, or as an array of color values. The color mode dictates the array values: for RGB, specify three values, each in the range 0 to 255, in the format [R,G,B]; for CMYK, specify four values, each as a percentage and each in the range 0 to 100, in the format [C,M,Y,K]; for LAB, specify three values in the format [L,A,B], with L in the range 0 to 100 and A and B in the range -128 to 127; for HSB, specify three colors in the format [H,S,B], with H in the range 0 to 360 and S and B as percentages in the range 0 to 100.


Implementation
    public function get effectColor():Swatch
    public function set effectColor(value:Swatch):void
eventListenersproperty 
eventListeners:EventListeners  [read-only] [override]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only] [override]

A collection of events.


Implementation
    public function get events():Events
invertEffectproperty 
invertEffect:Boolean

If true, inverts the satin effect.


Implementation
    public function get invertEffect():Boolean
    public function set invertEffect(value:Boolean):void
isValidproperty 
isValid:Boolean  [read-only] [override]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
opacityproperty 
opacity:Number

The opacity of the satin effect (as a percentage). (Range: 0 to 100)


Implementation
    public function get opacity():Number
    public function set opacity(value:Number):void
parentproperty 
parent:Object  [read-only] [override]

The parent of the SatinSetting (a TransparencySetting, StrokeTransparencySetting, FillTransparencySetting or ContentTransparencySetting).


Implementation
    public function get parent():Object
propertiesproperty 
properties:Object[override]

A property that allows setting of several properties at the same time.


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
sizeproperty 
size:Object

The width (in pixels) of the satin effect.


Implementation
    public function get size():Object
    public function set size(value:Object):void
Method Detail
addEventListenerSatinSetting()method
public function addEventListenerSatinSetting(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener

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)

Returns
EventListener
getElements()method 
override public function getElements():Object

Resolves the object specifier, creating an array of object references.

Returns
Object
removeEventListenerSatinSetting()method 
public function removeEventListenerSatinSetting(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean

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)

Returns
Boolean
toSpecifier()method 
override public function toSpecifier():String

Retrieves the object specifier.

Returns
String