com.esri.arcgis.display
Class HlsColor

java.lang.Object
  com.esri.arcgis.display.HlsColor

All Implemented Interfaces:

IColor, IHlsColor, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class HlsColor
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IHlsColor, IColor, IClone, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable

COM Class 'HlsColor'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriDisplay.olb'

Description 'A color in the HLS(Hue, Luminance, Saturation) color system.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.display.IHlsColor

IID, IID7ee9c491_d123_11d0_8383_080009b996cc, xxDummy

Fields inherited from interface com.esri.arcgis.display.IColor

IID20cd40b0_8f3d_11d0_8590_0800091a2a72

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.system.IXMLSerialize

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Constructor Summary

HlsColor()
Constructs a HlsColor using ArcGIS Engine.

HlsColor(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
HlsColor theHlsColor = (HlsColor) obj;

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	getCIELAB(double[] l, double[] a, double[] b) The CIELAB value of color.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
int	getCMYK() The CMYK value of color.
int	getHue() The hue component of an IHlsColor (0-360).
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	getLightness() The lightness component of an IHlsColor (0-100).
int	getRGB() The RGB value of color.
int	getSaturation() The saturation component of an HlslColor (0-100).
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
byte	getTransparency() The Alpha Blending value.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isNullColor() Indicates whether this color is null.
boolean	isUseWindowsDithering() Indicates if colors should be dithered to simulate colors that aren't supported by the display.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a HlsColor.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setCIELAB(double l, double a, double b) The CIELAB value of color.
void	setCMYK(int cMYK) The CMYK value of color.
void	setHue(int hue) The hue component of an IHlsColor (0-360).
void	setLightness(int lightness) The lightness component of an IHlsColor (0-100).
void	setNullColor(boolean flag) Indicates whether this color is null.
void	setRGB(int rGB) The RGB value of color.
void	setSaturation(int saturation) The saturation component of an HlslColor (0-100).
void	setTransparency(byte alphaValue) The Alpha Blending value.
void	setUseWindowsDithering(boolean useDithering) Indicates if colors should be dithered to simulate colors that aren't supported by the display.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

HlsColor

public HlsColor()
         throws java.io.IOException,
                java.net.UnknownHostException

Constructs a HlsColor using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

HlsColor

public HlsColor(java.lang.Object obj)
         throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
HlsColor theHlsColor = (HlsColor) obj;

Construct a HlsColor using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to HlsColor.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a HlsColor.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

setHue

public void setHue(int hue)
            throws java.io.IOException,
                   AutomationException

The hue component of an IHlsColor (0-360).

Specified by:

setHue in interface IHlsColor

Parameters:

hue - The hue (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHue

public int getHue()
           throws java.io.IOException,
                  AutomationException

The hue component of an IHlsColor (0-360).

Specified by:

getHue in interface IHlsColor

Returns:

The hue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLightness

public void setLightness(int lightness)
                  throws java.io.IOException,
                         AutomationException

The lightness component of an IHlsColor (0-100).

Specified by:

setLightness in interface IHlsColor

Parameters:

lightness - The lightness (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLightness

public int getLightness()
                 throws java.io.IOException,
                        AutomationException

The lightness component of an IHlsColor (0-100).

Specified by:

getLightness in interface IHlsColor

Returns:

The lightness

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSaturation

public void setSaturation(int saturation)
                   throws java.io.IOException,
                          AutomationException

The saturation component of an HlslColor (0-100).

Specified by:

setSaturation in interface IHlsColor

Parameters:

saturation - The saturation (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSaturation

public int getSaturation()
                  throws java.io.IOException,
                         AutomationException

The saturation component of an HlslColor (0-100).

Specified by:

getSaturation in interface IHlsColor

Returns:

The saturation

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRGB

public void setRGB(int rGB)
            throws java.io.IOException,
                   AutomationException

The RGB value of color.

Specified by:

setRGB in interface IColor

Parameters:

rGB - The rGB (A COM typedef) (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRGB

public int getRGB()
           throws java.io.IOException,
                  AutomationException

The RGB value of color.

Specified by:

getRGB in interface IColor

Returns:

The rGB (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCMYK

public void setCMYK(int cMYK)
             throws java.io.IOException,
                    AutomationException

The CMYK value of color.

Specified by:

setCMYK in interface IColor

Parameters:

cMYK - The cMYK (A COM typedef) (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCMYK

public int getCMYK()
            throws java.io.IOException,
                   AutomationException

The CMYK value of color.

Specified by:

getCMYK in interface IColor

Returns:

The cMYK (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseWindowsDithering

public void setUseWindowsDithering(boolean useDithering)
                            throws java.io.IOException,
                                   AutomationException

Indicates if colors should be dithered to simulate colors that aren't supported by the display. This only applies on displays that have 256 or fewer colors.

Specified by:

setUseWindowsDithering in interface IColor

Parameters:

useDithering - The useDithering (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseWindowsDithering

public boolean isUseWindowsDithering()
                              throws java.io.IOException,
                                     AutomationException

Indicates if colors should be dithered to simulate colors that aren't supported by the display. This only applies on displays that have 256 or fewer colors.

Specified by:

isUseWindowsDithering in interface IColor

Returns:

The useDithering

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCIELAB

public void setCIELAB(double l,
                      double a,
                      double b)
               throws java.io.IOException,
                      AutomationException

The CIELAB value of color.

Specified by:

setCIELAB in interface IColor

Parameters:

l - The l (in)

a - The a (in)

b - The b (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCIELAB

public void getCIELAB(double[] l,
                      double[] a,
                      double[] b)
               throws java.io.IOException,
                      AutomationException

The CIELAB value of color.

Specified by:

getCIELAB in interface IColor

Parameters:

l - The l (out: use single element array)

a - The a (out: use single element array)

b - The b (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTransparency

public void setTransparency(byte alphaValue)
                     throws java.io.IOException,
                            AutomationException

The Alpha Blending value. (0 for transparent, 255 for opaque).

Specified by:

setTransparency in interface IColor

Parameters:

alphaValue - An unsigned byte (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTransparency

public byte getTransparency()
                     throws java.io.IOException,
                            AutomationException

The Alpha Blending value. (0 for transparent, 255 for opaque).

Specified by:

getTransparency in interface IColor

Returns:

An unsigned byte

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNullColor

public void setNullColor(boolean flag)
                  throws java.io.IOException,
                         AutomationException

Indicates whether this color is null.

Specified by:

setNullColor in interface IColor

Parameters:

flag - The flag (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isNullColor

public boolean isNullColor()
                    throws java.io.IOException,
                           AutomationException

Indicates whether this color is null.

Specified by:

isNullColor in interface IColor

Returns:

The flag

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException