com.esri.arcgis.carto
Class DimensionStyles

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

All Implemented Interfaces:

IDimensionStyles, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, Externalizable, Serializable

public class DimensionStyles
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDimensionStyles, IPersistStream, Externalizable

A collection of DimensionStyle objects.

Description

The DimensionStyles class manages a collection of DimensionStyle objects.

Remarks

The DimensionStyles class is used to retrieve, create, and delete DimensionStyles.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

DimensionStyles()
Constructs a DimensionStyles using ArcGIS Engine.

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

Method Summary

void	addStyle(IDimensionStyle style) Adds a style to the collection.
void	deleteStyle(int iD) Deletes a dimension style.
boolean	equals(Object o) Compare this object with another
IDimensionStyle	findStyle(String name) Find a dimension style by name.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
int	getDefaultStyleID() The ID of the defualt dimension style.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
IDimensionStyle	getStyle(int iD) A dimension style.
IEnumDimensionStyle	getStyles() All the dimension styles in the collection.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	renameStyle(int iD, String name) Renames a dimension style.
void	save(IStream pstm, int fClearDirty) save
void	setDefaultStyleID(int iD) The ID of the defualt dimension style.
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

DimensionStyles

public DimensionStyles()
                throws IOException,
                       UnknownHostException

Constructs a DimensionStyles using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

DimensionStyles

public DimensionStyles(Object obj)
                throws IOException

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

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

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

addStyle

public void addStyle(IDimensionStyle style)
              throws IOException,
                     AutomationException

Adds a style to the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

addStyle in interface IDimensionStyles

Parameters:

style - A reference to a com.esri.arcgis.carto.IDimensionStyle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStyle

public IDimensionStyle getStyle(int iD)
                         throws IOException,
                                AutomationException

A dimension style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getStyle in interface IDimensionStyles

Parameters:

iD - The iD (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findStyle

public IDimensionStyle findStyle(String name)
                          throws IOException,
                                 AutomationException

Find a dimension style by name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

findStyle in interface IDimensionStyles

Parameters:

name - The name (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStyles

public IEnumDimensionStyle getStyles()
                              throws IOException,
                                     AutomationException

All the dimension styles in the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getStyles in interface IDimensionStyles

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultStyleID

public int getDefaultStyleID()
                      throws IOException,
                             AutomationException

The ID of the defualt dimension style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDefaultStyleID in interface IDimensionStyles

Returns:

The iD

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultStyleID

public void setDefaultStyleID(int iD)
                       throws IOException,
                              AutomationException

The ID of the defualt dimension style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDefaultStyleID in interface IDimensionStyles

Parameters:

iD - The iD (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteStyle

public void deleteStyle(int iD)
                 throws IOException,
                        AutomationException

Deletes a dimension style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deleteStyle in interface IDimensionStyles

Parameters:

iD - The iD (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

renameStyle

public void renameStyle(int iD,
                        String name)
                 throws IOException,
                        AutomationException

Renames a dimension style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

renameStyle in interface IDimensionStyles

Parameters:

iD - The iD (in)

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

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

save

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

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException