Package | com.adobe.incopy |
Class | public class Ink |
Inheritance | Ink ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
aliasInkName : String
The ink object to map this ink to. | Ink | ||
angle : Number
The angle of the ink. | Ink | ||
convertToProcess : Boolean
Converts spot inks to process inks. | Ink | ||
eventListeners : EventListeners [read-only]
A collection of event listeners. | Ink | ||
events : Events [read-only]
A collection of events. | Ink | ||
frequency : Number
The frequency of the ink. | Ink | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
id : Number [read-only]
The unique ID of the Ink. | Ink | ||
index : Number [read-only]
The index of the Ink within its containing object. | Ink | ||
inkType : InkTypes
The trapping type of the ink. | Ink | ||
isProcessInk : Boolean [read-only]
If true, the ink is a process ink. | Ink | ||
isValid : Boolean [read-only]
Returns true if the object specifier resolves to valid objects. | Ink | ||
label : String
A property that can be set to any string. | Ink | ||
name : String [read-only]
The name of the Ink. | Ink | ||
neutralDensity : Number
The neutral density of the ink. | Ink | ||
parent : Object [read-only]
The parent of the Ink (a Application or Document). | Ink | ||
printInk : Boolean
If true, prints the ink. | Ink | ||
properties : Object
A property that allows setting of several properties at the same time. | Ink | ||
solidity : Number [read-only]
The solidity value of the ink. | Ink | ||
trapOrder : Number
The place of the ink in the trapping sequence. | Ink |
Method | Defined By | ||
---|---|---|---|
addEventListenerInk(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Ink | ||
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key. | Ink | ||
![]() | 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. | Ink | ||
![]() | 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. | Ink | ||
![]() | 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 | |
removeEventListenerInk(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Ink | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String
Retrieves the object specifier. | Ink | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
aliasInkName | property |
aliasInkName:String
Since : | CS5 |
The ink object to map this ink to.
public function get aliasInkName():String
public function set aliasInkName(value:String):void
angle | property |
angle:Number
Since : | CS5 |
The angle of the ink. (Range: 0 to 360)
public function get angle():Number
public function set angle(value:Number):void
convertToProcess | property |
convertToProcess:Boolean
Since : | CS5 |
Converts spot inks to process inks.
public function get convertToProcess():Boolean
public function set convertToProcess(value:Boolean):void
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
frequency | property |
frequency:Number
Since : | CS5 |
The frequency of the ink. (Range: 1 to 500)
public function get frequency():Number
public function set frequency(value:Number):void
id | property |
id:Number
[read-only] Since : | CS5 |
The unique ID of the Ink.
public function get id():Number
index | property |
index:Number
[read-only] Since : | CS5 |
The index of the Ink within its containing object.
public function get index():Number
inkType | property |
inkType:InkTypes
Since : | CS5 |
The trapping type of the ink.
public function get inkType():InkTypes
public function set inkType(value:InkTypes):void
isProcessInk | property |
isProcessInk:Boolean
[read-only] Since : | CS5 |
If true, the ink is a process ink.
public function get isProcessInk():Boolean
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
name | property |
name:String
[read-only] Since : | CS5 |
The name of the Ink.
public function get name():String
neutralDensity | property |
neutralDensity:Number
Since : | CS5 |
The neutral density of the ink. (Range: 0.001 to 10.0)
public function get neutralDensity():Number
public function set neutralDensity(value:Number):void
parent | property |
parent:Object
[read-only] Since : | CS5 |
The parent of the Ink (a Application or Document).
public function get parent():Object
printInk | property |
printInk:Boolean
Since : | CS5 |
If true, prints the ink. Only valid when printing separations.
public function get printInk():Boolean
public function set printInk(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
solidity | property |
solidity:Number
[read-only] Since : | CS5 |
The solidity value of the ink. (Range: 0.0 to 1.0)
public function get solidity():Number
trapOrder | property |
trapOrder:Number
Since : | CS5 |
The place of the ink in the trapping sequence.
public function get trapOrder():Number
public function set trapOrder(value:Number):void
addEventListenerInk | () | method |
public function addEventListenerInk(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 |
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.
|
removeEventListenerInk | () | method |
public function removeEventListenerInk(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 |