Package | com.adobe.indesign |
Class | public class Tint |
Inheritance | Tint ![]() ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
baseColor : Color [read-only]
The color that the tint is based on. | Tint | ||
colorValue : Object [override]
The ink values that create the color, specified as a percentage for each ink. | Tint | ||
eventListeners : EventListeners [override] [read-only]
A collection of event listeners. | Tint | ||
events : Events [override] [read-only]
A collection of events. | Tint | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
id : Number [override] [read-only]
The unique ID of the Tint. | Tint | ||
index : Number [override] [read-only]
The index of the Tint within its containing object. | Tint | ||
isValid : Boolean [override] [read-only]
Returns true if the object specifier resolves to valid objects. | Tint | ||
label : String [override]
A property that can be set to any string. | Tint | ||
model : ColorModel [override]
The color model. | Tint | ||
name : String [override]
The name of the Tint. | Tint | ||
parent : Object [override] [read-only]
The parent of the Tint (a Application or Document). | Tint | ||
properties : Object [override]
A property that allows setting of several properties at the same time. | Tint | ||
space : ColorSpace [override]
The color space. | Tint | ||
tintValue : Number
The percent of the base color. | Tint |
Method | Defined By | ||
---|---|---|---|
![]() | addEventListenerColor(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Color | |
![]() | addEventListenerSwatch(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Swatch | |
addEventListenerTint(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Tint | ||
[override]
Duplicates the Tint. | Tint | ||
extractLabel(keyParam:String = null):String [override]
Gets the label value associated with the specified key. | Tint | ||
![]() | 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 [override]
Resolves the object specifier, creating an array of object references. | Tint | ||
![]() | 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 [override]
Sets the label to the value associated with the specified key. | Tint | ||
![]() | 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 | |
[override]
Merges the specified swatches with the swatch. | Tint | ||
[override]
Deletes the swatch. | Tint | ||
![]() | removeEventListenerColor(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Color | |
![]() | removeEventListenerSwatch(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Swatch | |
removeEventListenerTint(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Tint | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String [override]
Retrieves the object specifier. | Tint | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
baseColor | property |
baseColor:Color
[read-only] Since : | CS5 |
The color that the tint is based on.
public function get baseColor():Color
colorValue | property |
colorValue:Object
[override] Since : | CS5 |
The ink values that create the color, specified as a percentage for each ink. Note: The number of values required and the range depends on the color space. For RGB, specify three values, with each value in the range 0 to 255; for CMYK, specify four values representing C, M, Y, and K, with each value in the range 0 to 100; for LAB, specify three values representing L (Range: 0 to 100), A (Range: -128 to 127), and B (Range: -128 to 127); for mixed ink, specify values for each ink in the ink list, with each value in the range 0 to 100.
public function get colorValue():Object
public function set colorValue(value:Object):void
eventListeners | property |
eventListeners:EventListeners
[read-only] [override] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] [override] Since : | CS5 |
A collection of events.
public function get events():Events
id | property |
id:Number
[read-only] [override] Since : | CS5 |
The unique ID of the Tint.
public function get id():Number
index | property |
index:Number
[read-only] [override] Since : | CS5 |
The index of the Tint within its containing object.
public function get index():Number
isValid | property |
isValid:Boolean
[read-only] [override] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
label | property |
label:String
[override] Since : | CS5 |
A property that can be set to any string.
public function get label():String
public function set label(value:String):void
model | property |
model:ColorModel
[override] Since : | CS5 |
The color model.
public function get model():ColorModel
public function set model(value:ColorModel):void
name | property |
name:String
[override] Since : | CS5 |
The name of the Tint.
public function get name():String
public function set name(value:String):void
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the Tint (a Application or Document).
public function get parent():Object
properties | property |
properties:Object
[override] 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
space | property |
space:ColorSpace
[override] Since : | CS5 |
The color space.
public function get space():ColorSpace
public function set space(value:ColorSpace):void
tintValue | property |
tintValue:Number
Since : | CS5 |
The percent of the base color. (Range: 0 to 100)
public function get tintValue():Number
public function set tintValue(value:Number):void
addEventListenerTint | () | method |
public function addEventListenerTint(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 |
override 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 |
override public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
insertLabel | () | method |
override 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 |
override public function merge(withParam:Object = null):Swatch
Since : | CS5 |
Merges the specified swatches with the swatch.
Parameters
withParam:Object (default = null ) — (Object) The swatches to merge. Can accept: Array of Swatches, Swatch or String.
|
Swatch |
remove | () | method |
override public function remove(replacingWithParam:Swatch = null):void
Since : | CS5 |
Deletes the swatch.
Parameters
replacingWithParam:Swatch (default = null ) — (Swatch) The swatch to apply in place of the deleted swatch. (Optional)
|
removeEventListenerTint | () | method |
public function removeEventListenerTint(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 |
override public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |