com.esri.arcgis.carto
Class DimensionClassExtension

java.lang.Object
  com.esri.arcgis.carto.DimensionClassExtension

All Implemented Interfaces:

IDimensionClassExtension, IDimensionClassExtension2, IClassExtension, IFeatureClassExtension, IObjectClassEvents, IObjectClassExtension, IPersistCustomFeaturesExtension, com.esri.arcgis.interop.RemoteObjRef, Serializable, EventListener

public class DimensionClassExtension
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IClassExtension, IDimensionClassExtension, IDimensionClassExtension2, IFeatureClassExtension, IObjectClassExtension, IObjectClassEvents, IPersistCustomFeaturesExtension

A class extension which contains all the style properties for a dimension feature class.

Description

The DimensionClassExtension CoClass manages the drawing of DimensionFeatures.

Remarks

The DimensionClassExtension is used to configure the drawing properties and symbology for DimensionFeatures.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

DimensionClassExtension()
Constructs a DimensionClassExtension using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
IDimensionStyles	getDimensionStyles() The collection of dimension styles associated with the dimension feature class.
ITransformation	getNativeTransformation() The native display transformation of the dimension feature class.
ITransformation	getNativeTransformation(IDimensionGraphic pGraphic) The native display transformation of the dimension feature class, centered on the given graphic.
double	getReferenceScale() The reference scale of the dimension feature class.
int	getReferenceScaleUnits() The reference scale units of the dimension feature class.
int	hashCode() the hashcode for this object
void	init(IClassHelper classHelper, IPropertySet extensionProperties) Initializes the extension, passing in a reference to its class helper.
void	loadClass(IStream stream, boolean[] canLoad) Looks at the class information and determines if it can load the features.
void	loadFeature(IStream stream, IFeature feature) Loads the feature information and updates the feature.
void	onChange(IObjectClassEventsOnChangeEvent theEvent) This event is fired when an object's attributes or geometry is updated.
void	onCreate(IObjectClassEventsOnCreateEvent theEvent) This event is fired when a new object is created in the object class.
void	onDelete(IObjectClassEventsOnDeleteEvent theEvent) This event is fired when an object is deleted from the object class.
void	resetProperties() Resets the in state of the dimension feature class properties.
void	saveClass(IStream stream) Writes out to the stream, class information used to aid loading.
void	saveFeature(IStream stream, IFeature feature) Writes out to the stream, feature infomation used to aid loading.
void	setReferenceScale(double scale) The reference scale of the dimension feature class.
void	setReferenceScaleUnits(int units) The reference scale units of the dimension feature class.
void	shutdown() Informs the extension that its class helper is going away.
void	updateProperties() Updates the dimension featrue class' properties.

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

DimensionClassExtension

public DimensionClassExtension()
                        throws IOException,
                               UnknownHostException

Constructs a DimensionClassExtension using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

DimensionClassExtension

public DimensionClassExtension(Object obj)
                        throws IOException

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

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

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

init

public void init(IClassHelper classHelper,
                 IPropertySet extensionProperties)
          throws IOException,
                 AutomationException

Initializes the extension, passing in a reference to its class helper.

Remarks

If a reference to the class is required by other class extension members, the class helper should be stored in a member variable. Storing an object or feature class directly within a class extension is strongly discouraged.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

init in interface IClassExtension

Parameters:

classHelper - A reference to a com.esri.arcgis.geodatabase.IClassHelper (in)

extensionProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

shutdown

public void shutdown()
              throws IOException,
                     AutomationException

Informs the extension that its class helper is going away.

Remarks

Shutdown is called when the extension's class is cleared from the client's memory, or when the extension is removed from the class. Note that if a class is deleted from a geodatabase, it may remain in memory, so this should not be relied upon for behavior that should be triggered by a class' deletion.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

shutdown in interface IClassExtension

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDimensionStyles

public IDimensionStyles getDimensionStyles()
                                    throws IOException,
                                           AutomationException

The collection of dimension styles associated with the dimension feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDimensionStyles in interface IDimensionClassExtension

Returns:

A reference to a com.esri.arcgis.carto.IDimensionStyles

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateProperties

public void updateProperties()
                      throws IOException,
                             AutomationException

Updates the dimension featrue class' properties.

Remarks

As with any schema related modifications, an exclusive schema lock should be obtained on the feature class before calling UpdateProperties().

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

updateProperties in interface IDimensionClassExtension

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resetProperties

public void resetProperties()
                     throws IOException,
                            AutomationException

Resets the in state of the dimension feature class properties.

Remarks

As with any schema related modifications, an exclusive schema lock should be obtained on the feature class before calling ResetProperties().

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

resetProperties in interface IDimensionClassExtension

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReferenceScale

public double getReferenceScale()
                         throws IOException,
                                AutomationException

The reference scale of the dimension feature class.

Remarks

The ReferenceScale property defines the scale at which symbols are drawn at their defined size. The ReferenceScaleUnits property is only used when the Dimension FeatureClass’s spatial reference is Unknown. Changing the ReferenceScale after the FeatureClass contains Features is not recommend as those Features’ geometries are controlled by the ReferenceScale property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getReferenceScale in interface IDimensionClassExtension

Returns:

The scale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReferenceScale

public void setReferenceScale(double scale)
                       throws IOException,
                              AutomationException

The reference scale of the dimension feature class.

Remarks

The ReferenceScale property defines the scale at which symbols are drawn at their defined size. Changing the ReferenceScale after the FeatureClass contains Features is not recommend as those Features’ geometries are controlled by the ReferenceScale property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setReferenceScale in interface IDimensionClassExtension

Parameters:

scale - The scale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReferenceScaleUnits

public int getReferenceScaleUnits()
                           throws IOException,
                                  AutomationException

The reference scale units of the dimension feature class.

Remarks

The ReferenceScaleUnits property is only used when the Dimension FeatureClass’s spatial reference is Unknown.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getReferenceScaleUnits in interface IDimensionClassExtension

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReferenceScaleUnits

public void setReferenceScaleUnits(int units)
                            throws IOException,
                                   AutomationException

The reference scale units of the dimension feature class.

Remarks

The ReferenceScaleUnits property is only used when the Dimension FeatureClass’s spatial reference is Unknown.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setReferenceScaleUnits in interface IDimensionClassExtension

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNativeTransformation

public ITransformation getNativeTransformation()
                                        throws IOException,
                                               AutomationException

The native display transformation of the dimension feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNativeTransformation in interface IDimensionClassExtension

Returns:

A reference to a com.esri.arcgis.geometry.ITransformation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNativeTransformation

public ITransformation getNativeTransformation(IDimensionGraphic pGraphic)
                                        throws IOException,
                                               AutomationException

The native display transformation of the dimension feature class, centered on the given graphic.

Product Availability

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

Specified by:

getNativeTransformation in interface IDimensionClassExtension2

Parameters:

pGraphic - A reference to a com.esri.arcgis.carto.IDimensionGraphic (in)

Returns:

A reference to a com.esri.arcgis.geometry.ITransformation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onCreate

public void onCreate(IObjectClassEventsOnCreateEvent theEvent)
              throws IOException,
                     AutomationException

This event is fired when a new object is created in the object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

onCreate in interface IObjectClassEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onDelete

public void onDelete(IObjectClassEventsOnDeleteEvent theEvent)
              throws IOException,
                     AutomationException

This event is fired when an object is deleted from the object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

onDelete in interface IObjectClassEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onChange

public void onChange(IObjectClassEventsOnChangeEvent theEvent)
              throws IOException,
                     AutomationException

This event is fired when an object's attributes or geometry is updated.

Remarks

In the event that a feature should be deleted due to an OnChange event, it is not recommended that the event handler delete the feature itself. Instead, an exception should be thrown to the application, where it can be made responsible for deleting the feature.

The OnChange event is not fired during a Topology Validation for performance reasons as a large number of features may be changed during a Validate. In addition, features may be changed many times.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

onChange in interface IObjectClassEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveClass

public void saveClass(IStream stream)
               throws IOException,
                      AutomationException

Writes out to the stream, class information used to aid loading.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

saveClass in interface IPersistCustomFeaturesExtension

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadClass

public void loadClass(IStream stream,
                      boolean[] canLoad)
               throws IOException,
                      AutomationException

Looks at the class information and determines if it can load the features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

loadClass in interface IPersistCustomFeaturesExtension

Parameters:

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

canLoad - The canLoad (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveFeature

public void saveFeature(IStream stream,
                        IFeature feature)
                 throws IOException,
                        AutomationException

Writes out to the stream, feature infomation used to aid loading.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

saveFeature in interface IPersistCustomFeaturesExtension

Parameters:

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

feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadFeature

public void loadFeature(IStream stream,
                        IFeature feature)
                 throws IOException,
                        AutomationException

Loads the feature information and updates the feature.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

loadFeature in interface IPersistCustomFeaturesExtension

Parameters:

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

feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.