|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.display.HlsColor
public class HlsColor
A color in the HLS(Hue, Luminance, Saturation) color system.
Constructor Summary | |
---|---|
HlsColor()
Constructs a HlsColor using ArcGIS Engine. |
|
HlsColor(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(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 String |
getClsid()
getClsid. |
int |
getCMYK()
The CMYK value of color. |
int |
getHue()
The hue component of an IHlsColor (0-360). |
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(ObjectInput in)
|
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(ObjectOutput out)
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
---|
getJintegraDispatch, release |
Constructor Detail |
---|
public HlsColor() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic HlsColor(Object obj) throws IOException
HlsColor theHlsColor = (HlsColor) obj;
obj
to HlsColor
.
obj
- an object returned from ArcGIS Engine or Server
IOException
- if there are interop problemsMethod Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public void setHue(int hue) throws IOException, AutomationException
setHue
in interface IHlsColor
hue
- The hue (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getHue() throws IOException, AutomationException
getHue
in interface IHlsColor
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setLightness(int lightness) throws IOException, AutomationException
setLightness
in interface IHlsColor
lightness
- The lightness (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getLightness() throws IOException, AutomationException
getLightness
in interface IHlsColor
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSaturation(int saturation) throws IOException, AutomationException
setSaturation
in interface IHlsColor
saturation
- The saturation (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getSaturation() throws IOException, AutomationException
getSaturation
in interface IHlsColor
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setRGB(int rGB) throws IOException, AutomationException
setRGB
in interface IColor
rGB
- The rGB (A COM typedef) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.It is easiest to specify the rgb values in hexadecimal. The following code creates an RGBColor for black -
RGBColor black = new RGBColor();
black.setRGB(0xFFFFFF);
public int getRGB() throws IOException, AutomationException
getRGB
in interface IColor
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCMYK(int cMYK) throws IOException, AutomationException
setCMYK
in interface IColor
cMYK
- The cMYK (A COM typedef) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getCMYK() throws IOException, AutomationException
CMYK returns the Long (ASCII) number calculated from the Cyan, Magenta, Yellow and Black color attributes.
getCMYK
in interface IColor
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setUseWindowsDithering(boolean useDithering) throws IOException, AutomationException
setUseWindowsDithering
in interface IColor
useDithering
- The useDithering (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isUseWindowsDithering() throws IOException, AutomationException
isUseWindowsDithering
in interface IColor
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCIELAB(double l, double a, double b) throws IOException, AutomationException
setCIELAB
in interface IColor
l
- The l (in)a
- The a (in)b
- The b (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getCIELAB(double[] l, double[] a, double[] b) throws IOException, AutomationException
getCIELAB
in interface IColor
l
- The l (out: use single element array)a
- The a (out: use single element array)b
- The b (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTransparency(byte alphaValue) throws IOException, AutomationException
setTransparency
in interface IColor
alphaValue
- An unsigned byte (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public byte getTransparency() throws IOException, AutomationException
getTransparency
in interface IColor
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setNullColor(boolean flag) throws IOException, AutomationException
Boolean indicator that specifies if the color will be Null or Transparent. The default for NullColor is False.
setNullColor
in interface IColor
flag
- The flag (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isNullColor() throws IOException, AutomationException
Boolean indicator that specifies if the color will be Null or Transparent. The default for NullColor is False.
isNullColor
in interface IColor
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IClone esri_clone() throws IOException, AutomationException
esri_clone
in interface IClone
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void assign(IClone src) throws IOException, AutomationException
assign
in interface IClone
src
- A reference to a com.esri.arcgis.system.IClone (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isEqual(IClone other) throws IOException, AutomationException
IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.
isEqual
in interface IClone
other
- A reference to a com.esri.arcgis.system.IClone (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isIdentical(IClone other) throws IOException, AutomationException
IsIdentical returns true if the receiver and the source reference the same object.
isIdentical
in interface IClone
other
- A reference to a com.esri.arcgis.system.IClone (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getClassID(GUID[] pClassID) throws IOException, AutomationException
IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID
in interface IPersist
pClassID
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void isDirty() throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
isDirty
in interface IPersistStream
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void load(IStream pstm) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
load
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void save(IStream pstm, int fClearDirty) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
save
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)fClearDirty
- The fClearDirty (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getSizeMax(_ULARGE_INTEGER[] pcbSize) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
getSizeMax
in interface IPersistStream
pcbSize
- A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void serialize(IXMLSerializeData data) throws IOException, AutomationException
serialize
in interface IXMLSerialize
data
- A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void deserialize(IXMLSerializeData data) throws IOException, AutomationException
deserialize
in interface IXMLSerialize
data
- A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void writeExternal(ObjectOutput out) throws IOException
writeExternal
in interface Externalizable
IOException
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
readExternal
in interface Externalizable
IOException
ClassNotFoundException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |