Packagecom.adobe.indesign
Classpublic class ColorSetting
InheritanceColorSetting Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Preference



Public Properties
 PropertyDefined 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
 InheritedhostObjectDelegate : 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
Public Methods
 MethodDefined By
  
addEventListenerColorSetting(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
ColorSetting
 Inherited
addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Preference
 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.
ColorSetting
 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
  
removeEventListenerColorSetting(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
ColorSetting
 Inherited
removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Preference
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
[override] Retrieves the object specifier.
ColorSetting
 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
accurateLABSpotsproperty
accurateLABSpots:Boolean

If true, uses LAB alternates for spot colors when available.


Implementation
    public function get accurateLABSpots():Boolean
    public function set accurateLABSpots(value:Boolean):void
cmsSettingsproperty 
cmsSettings:String

The current color management system settings configuration. Note: For information on possible values, see CMS settings list.


Implementation
    public function get cmsSettings():String
    public function set cmsSettings(value:String):void
cmsSettingsListproperty 
cmsSettingsList:Object  [read-only]

A list of valid color management system settings configurations.


Implementation
    public function get cmsSettingsList():Object
cmsSettingsPathproperty 
cmsSettingsPath:File

The file path of the CSF file to use.


Implementation
    public function get cmsSettingsPath():File
    public function set cmsSettingsPath(value:File):void
cmykPolicyproperty 
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.


Implementation
    public function get cmykPolicy():ColorSettingsPolicy
    public function set cmykPolicy(value:ColorSettingsPolicy):void
enableColorManagementproperty 
enableColorManagement:Boolean

If true, enables color management.


Implementation
    public function get enableColorManagement():Boolean
    public function set enableColorManagement(value:Boolean):void
engineproperty 
engine:String

The color management module (CMM) for mapping color space gamuts between documents.


Implementation
    public function get engine():String
    public function set engine(value:String):void
engineListproperty 
engineList:Object  [read-only]

The available color engines.


Implementation
    public function get engineList():Object
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
idealizedBlackToExportproperty 
idealizedBlackToExport:Boolean

If true, uses idealized black for CMYK-to-RGB or CMYK-to-Gray conversions to print or export.


Implementation
    public function get idealizedBlackToExport():Boolean
    public function set idealizedBlackToExport(value:Boolean):void
idealizedBlackToScreenproperty 
idealizedBlackToScreen:Boolean

If true, uses idealized black for CMYK-to-RGB or CMYK-to-Gray conversions to the screen.


Implementation
    public function get idealizedBlackToScreen():Boolean
    public function set idealizedBlackToScreen(value:Boolean):void
intentproperty 
intent:DefaultRenderingIntent

The default rendering intent.


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

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
mismatchAskWhenOpeningproperty 
mismatchAskWhenOpening:Boolean

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.


Implementation
    public function get mismatchAskWhenOpening():Boolean
    public function set mismatchAskWhenOpening(value:Boolean):void
mismatchAskWhenPastingproperty 
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. The prompt provides the option to override the default mismatch behavior.


Implementation
    public function get mismatchAskWhenPasting():Boolean
    public function set mismatchAskWhenPasting(value:Boolean):void
missingAskWhenOpeningproperty 
missingAskWhenOpening:Boolean

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.


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

The parent of the ColorSetting (a Application).


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
rgbPolicyproperty 
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.


Implementation
    public function get rgbPolicy():ColorSettingsPolicy
    public function set rgbPolicy(value:ColorSettingsPolicy):void
useBPCproperty 
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.


Implementation
    public function get useBPC():Boolean
    public function set useBPC(value:Boolean):void
workingSpaceCMYKproperty 
workingSpaceCMYK:String

The current CMYK profile.


Implementation
    public function get workingSpaceCMYK():String
    public function set workingSpaceCMYK(value:String):void
workingSpaceCMYKListproperty 
workingSpaceCMYKList:Object  [read-only]

A list of valid CMYK color profiles.


Implementation
    public function get workingSpaceCMYKList():Object
workingSpaceRGBproperty 
workingSpaceRGB:String

The current RGB profile.


Implementation
    public function get workingSpaceRGB():String
    public function set workingSpaceRGB(value:String):void
workingSpaceRGBListproperty 
workingSpaceRGBList:Object  [read-only]

A list of valid RGB color profiles.


Implementation
    public function get workingSpaceRGBList():Object
Method Detail
addEventListenerColorSetting()method
public function addEventListenerColorSetting(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
removeEventListenerColorSetting()method 
public function removeEventListenerColorSetting(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