com.esri.arcgis.display
Class GraphicAttributeDashType

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

All Implemented Interfaces:

IGraphicAttributeDashType, IGraphicAttributeType, IGraphicAttributeTypeUsingUnits, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class GraphicAttributeDashType
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGraphicAttributeType, IGraphicAttributeDashType, IGraphicAttributeTypeUsingUnits

Dash graphic attribute type.

Description

GraphicAttributeDashType is a type of graphic attribute used for defining dash patterns. GeometricEffectDash objects uses this type to define its pattern.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

GraphicAttributeDashType()
Constructs a GraphicAttributeDashType using ArcGIS Engine.

GraphicAttributeDashType(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GraphicAttributeDashType theGraphicAttributeDashType = (GraphicAttributeDashType) obj;

Method Summary

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
void	formatForDisplay(int units, Object[] val) Formats a graphic attribute value according to a given unit before displaying it.
void	formatFromDisplay(int units, Object[] val) Converts a graphic attribute value coming from the UI to points.
Object	formatValue(Object value) Formats the graphic attribute value.
static String	getClsid() getClsid.
int	getDashType() Type of dash attribute.
int	getType() The graphic attribute type.
int	hashCode() the hashcode for this object
void	setDashType(int val) Type of dash attribute.
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

GraphicAttributeDashType

public GraphicAttributeDashType()
                         throws IOException,
                                UnknownHostException

Constructs a GraphicAttributeDashType using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GraphicAttributeDashType

public GraphicAttributeDashType(Object obj)
                         throws IOException

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

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

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

getDashType

public int getDashType()
                throws IOException,
                       AutomationException

Type of dash attribute.

Product Availability

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

Specified by:

getDashType in interface IGraphicAttributeDashType

Returns:

A com.esri.arcgis.display.esriDashAttributeType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDashType

public void setDashType(int val)
                 throws IOException,
                        AutomationException

Type of dash attribute.

Product Availability

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

Specified by:

setDashType in interface IGraphicAttributeDashType

Parameters:

val - A com.esri.arcgis.display.esriDashAttributeType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

formatForDisplay

public void formatForDisplay(int units,
                             Object[] val)
                      throws IOException,
                             AutomationException

Formats a graphic attribute value according to a given unit before displaying it.

Product Availability

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

Specified by:

formatForDisplay in interface IGraphicAttributeTypeUsingUnits

Parameters:

units - A com.esri.arcgis.system.esriUnits constant (in)

val - A Variant (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

formatFromDisplay

public void formatFromDisplay(int units,
                              Object[] val)
                       throws IOException,
                              AutomationException

Converts a graphic attribute value coming from the UI to points.

Product Availability

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

Specified by:

formatFromDisplay in interface IGraphicAttributeTypeUsingUnits

Parameters:

units - A com.esri.arcgis.system.esriUnits constant (in)

val - A Variant (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.