com.esri.arcgis.display
Class GraphicAttributeEnumType

java.lang.Object
  extended by com.esri.arcgis.display.GraphicAttributeEnumType
All Implemented Interfaces:
IGraphicAttributeEnumType, IGraphicAttributeType, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class GraphicAttributeEnumType
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGraphicAttributeType, IGraphicAttributeEnumType

Enumeration graphic attribute type.

Description

GraphicAttributeEnumType is a type of graphic attribute used for defining enumerations.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:
Serialized Form

Constructor Summary
GraphicAttributeEnumType()
          Constructs a GraphicAttributeEnumType using ArcGIS Engine.
GraphicAttributeEnumType(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GraphicAttributeEnumType theGraphicAttributeEnumType = (GraphicAttributeEnumType) obj;
 
Method Summary
 void addValue(int value, String text)
          Adds a new value to the graphic attribute enumeration.
 void drawValue(Object value, tagRECT rect, int hDC, boolean readOnly)
          Draws a value on the device context.
 boolean equals(Object o)
          Compare this object with another
 Object formatValue(Object value)
          Formats the graphic attribute value.
static String getClsid()
          getClsid.
 int getType()
          The graphic attribute type.
 int hashCode()
          the hashcode for this object
 int nextValue()
          Returns the next value in the enumeration.
 void reset()
          Resets the enumeration.
 Object textToValue(String text)
          Converts text to the graphic attribute value.
 String valueToText(Object value)
          Converts the graphic attribute value to text.
 
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

GraphicAttributeEnumType

public GraphicAttributeEnumType()
                         throws IOException,
                                UnknownHostException
Constructs a GraphicAttributeEnumType using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

GraphicAttributeEnumType

public GraphicAttributeEnumType(Object obj)
                         throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GraphicAttributeEnumType theGraphicAttributeEnumType = (GraphicAttributeEnumType) obj;

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

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getType

public int getType()
            throws IOException,
                   AutomationException
The graphic attribute type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getType in interface IGraphicAttributeType
Returns:
A com.esri.arcgis.display.esriGraphicAttributeType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

formatValue

public Object formatValue(Object value)
                   throws IOException,
                          AutomationException
Formats the graphic attribute value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
formatValue in interface IGraphicAttributeType
Parameters:
value - A Variant (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

textToValue

public Object textToValue(String text)
                   throws IOException,
                          AutomationException
Converts text to the graphic attribute value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
textToValue in interface IGraphicAttributeType
Parameters:
text - The text (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

valueToText

public String valueToText(Object value)
                   throws IOException,
                          AutomationException
Converts the graphic attribute value to text.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
valueToText in interface IGraphicAttributeType
Parameters:
value - A Variant (in)
Returns:
The text
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

drawValue

public void drawValue(Object value,
                      tagRECT rect,
                      int hDC,
                      boolean readOnly)
               throws IOException,
                      AutomationException
Draws a value on the device context.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
drawValue in interface IGraphicAttributeType
Parameters:
value - A Variant (in)
rect - A Structure: com.esri.arcgis.display.tagRECT (in)
hDC - The hDC (A COM typedef) (in)
readOnly - The readOnly (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException
Resets the enumeration.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
reset in interface IGraphicAttributeEnumType
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

nextValue

public int nextValue()
              throws IOException,
                     AutomationException
Returns the next value in the enumeration.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
nextValue in interface IGraphicAttributeEnumType
Returns:
The val
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addValue

public void addValue(int value,
                     String text)
              throws IOException,
                     AutomationException
Adds a new value to the graphic attribute enumeration.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
addValue in interface IGraphicAttributeEnumType
Parameters:
value - The value (in)
text - The text (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.