Package | com.adobe.indesign |
Class | public class ColorSetting |
Inheritance | ColorSetting ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
accurateLABSpots : Boolean
If true, uses LAB alternates for spot colors when available. | ColorSetting | ||
cmsSettings : String
The current color management system settings configuration. | ColorSetting | ||
cmsSettingsList : Object [read-only]
A list of valid color management system settings configurations. | ColorSetting | ||
cmsSettingsPath : File
The file path of the CSF file to use. | ColorSetting | ||
cmykPolicy : ColorSettingsPolicy
The policy for handling colors in a CMYK color model, including reading and embedding color profiles, resolving mismatches between embedded color profiles and the working space, and moving colors between documents. | ColorSetting | ||
enableColorManagement : Boolean
If true, enables color management. | ColorSetting | ||
engine : String
The color management module (CMM) for mapping color space gamuts between documents. | ColorSetting | ||
engineList : Object [read-only]
The available color engines. | ColorSetting | ||
eventListeners : EventListeners [override] [read-only]
A collection of event listeners. | ColorSetting | ||
events : Events [override] [read-only]
A collection of events. | ColorSetting | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
idealizedBlackToExport : Boolean
If true, uses idealized black for CMYK-to-RGB or CMYK-to-Gray conversions to print or export. | ColorSetting | ||
idealizedBlackToScreen : Boolean
If true, uses idealized black for CMYK-to-RGB or CMYK-to-Gray conversions to the screen. | ColorSetting | ||
intent : DefaultRenderingIntent
The default rendering intent. | ColorSetting | ||
isValid : Boolean [override] [read-only]
Returns true if the object specifier resolves to valid objects. | ColorSetting | ||
mismatchAskWhenOpening : Boolean
If true, displays a prompt when opening a file whose embedded color profile does not match the current working space. | ColorSetting | ||
mismatchAskWhenPasting : Boolean
If true, displays a prompt when importing an object (via pasting, drag-and-drop, or other similar methods) whose colors do not match the current working space. | ColorSetting | ||
missingAskWhenOpening : Boolean
If true, displays a prompt when opening a file that does not have an embedded color profile. | ColorSetting | ||
parent : Object [override] [read-only]
The parent of the ColorSetting (a Application). | ColorSetting | ||
properties : Object [override]
A property that allows setting of several properties at the same time. | ColorSetting | ||
rgbPolicy : ColorSettingsPolicy
The policy for handling colors in an RGB color model, including reading and embedding color profiles, handling mismatches between embedded color profiles and the working space, and moving colors from one document to another. | ColorSetting | ||
useBPC : Boolean
If true, uses black point compensation to ensure that shadow detail is preserved by simulating the full dynamic range of the output device. | ColorSetting | ||
workingSpaceCMYK : String
The current CMYK profile. | ColorSetting | ||
workingSpaceCMYKList : Object [read-only]
A list of valid CMYK color profiles. | ColorSetting | ||
workingSpaceRGB : String
The current RGB profile. | ColorSetting | ||
workingSpaceRGBList : Object [read-only]
A list of valid RGB color profiles. | ColorSetting |
Method | Defined By | ||
---|---|---|---|
addEventListenerColorSetting(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | ColorSetting | ||
![]() | addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Preference | |
![]() | 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. | ColorSetting | ||
![]() | 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 | |
![]() | 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 | |
removeEventListenerColorSetting(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | ColorSetting | ||
![]() | removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Preference | |
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String [override]
Retrieves the object specifier. | ColorSetting | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
accurateLABSpots | property |
accurateLABSpots:Boolean
Since : | CS5 |
If true, uses LAB alternates for spot colors when available.
public function get accurateLABSpots():Boolean
public function set accurateLABSpots(value:Boolean):void
cmsSettings | property |
cmsSettings:String
Since : | CS5 |
The current color management system settings configuration. Note: For information on possible values, see CMS settings list.
public function get cmsSettings():String
public function set cmsSettings(value:String):void
cmsSettingsList | property |
cmsSettingsList:Object
[read-only] Since : | CS5 |
A list of valid color management system settings configurations.
public function get cmsSettingsList():Object
cmsSettingsPath | property |
cmsSettingsPath:File
Since : | CS5 |
The file path of the CSF file to use.
public function get cmsSettingsPath():File
public function set cmsSettingsPath(value:File):void
cmykPolicy | property |
cmykPolicy:ColorSettingsPolicy
Since : | CS5 |
The policy for handling colors in a CMYK color model, including reading and embedding color profiles, resolving mismatches between embedded color profiles and the working space, and moving colors between documents.
public function get cmykPolicy():ColorSettingsPolicy
public function set cmykPolicy(value:ColorSettingsPolicy):void
enableColorManagement | property |
enableColorManagement:Boolean
Since : | CS5 |
If true, enables color management.
public function get enableColorManagement():Boolean
public function set enableColorManagement(value:Boolean):void
engine | property |
engine:String
Since : | CS5 |
The color management module (CMM) for mapping color space gamuts between documents.
public function get engine():String
public function set engine(value:String):void
engineList | property |
engineList:Object
[read-only] Since : | CS5 |
The available color engines.
public function get engineList():Object
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
idealizedBlackToExport | property |
idealizedBlackToExport:Boolean
Since : | CS5 |
If true, uses idealized black for CMYK-to-RGB or CMYK-to-Gray conversions to print or export.
public function get idealizedBlackToExport():Boolean
public function set idealizedBlackToExport(value:Boolean):void
idealizedBlackToScreen | property |
idealizedBlackToScreen:Boolean
Since : | CS5 |
If true, uses idealized black for CMYK-to-RGB or CMYK-to-Gray conversions to the screen.
public function get idealizedBlackToScreen():Boolean
public function set idealizedBlackToScreen(value:Boolean):void
intent | property |
intent:DefaultRenderingIntent
Since : | CS5 |
The default rendering intent.
public function get intent():DefaultRenderingIntent
public function set intent(value:DefaultRenderingIntent):void
isValid | property |
isValid:Boolean
[read-only] [override] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
mismatchAskWhenOpening | property |
mismatchAskWhenOpening:Boolean
Since : | CS5 |
If true, displays a prompt when opening a file whose embedded color profile does not match the current working space. The prompt provides the option to override the default mismatch behavior.
public function get mismatchAskWhenOpening():Boolean
public function set mismatchAskWhenOpening(value:Boolean):void
mismatchAskWhenPasting | property |
mismatchAskWhenPasting:Boolean
Since : | CS5 |
If true, displays a prompt when importing an object (via pasting, drag-and-drop, or other similar methods) whose colors do not match the current working space. The prompt provides the option to override the default mismatch behavior.
public function get mismatchAskWhenPasting():Boolean
public function set mismatchAskWhenPasting(value:Boolean):void
missingAskWhenOpening | property |
missingAskWhenOpening:Boolean
Since : | CS5 |
If true, displays a prompt when opening a file that does not have an embedded color profile. The prompt provides the option to assign a color profile.
public function get missingAskWhenOpening():Boolean
public function set missingAskWhenOpening(value:Boolean):void
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the ColorSetting (a Application).
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
rgbPolicy | property |
rgbPolicy:ColorSettingsPolicy
Since : | CS5 |
The policy for handling colors in an RGB color model, including reading and embedding color profiles, handling mismatches between embedded color profiles and the working space, and moving colors from one document to another.
public function get rgbPolicy():ColorSettingsPolicy
public function set rgbPolicy(value:ColorSettingsPolicy):void
useBPC | property |
useBPC:Boolean
Since : | CS5 |
If true, uses black point compensation to ensure that shadow detail is preserved by simulating the full dynamic range of the output device.
public function get useBPC():Boolean
public function set useBPC(value:Boolean):void
workingSpaceCMYK | property |
workingSpaceCMYK:String
Since : | CS5 |
The current CMYK profile.
public function get workingSpaceCMYK():String
public function set workingSpaceCMYK(value:String):void
workingSpaceCMYKList | property |
workingSpaceCMYKList:Object
[read-only] Since : | CS5 |
A list of valid CMYK color profiles.
public function get workingSpaceCMYKList():Object
workingSpaceRGB | property |
workingSpaceRGB:String
Since : | CS5 |
The current RGB profile.
public function get workingSpaceRGB():String
public function set workingSpaceRGB(value:String):void
workingSpaceRGBList | property |
workingSpaceRGBList:Object
[read-only] Since : | CS5 |
A list of valid RGB color profiles.
public function get workingSpaceRGBList():Object
addEventListenerColorSetting | () | method |
public function addEventListenerColorSetting(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 |
getElements | () | method |
override public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
removeEventListenerColorSetting | () | method |
public function removeEventListenerColorSetting(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 |