com.esri.arcgis.cartoUI
Class DataFrameClippingDialog

java.lang.Object
  com.esri.arcgis.cartoUI.DataFrameClippingDialog

All Implemented Interfaces:

IDataFrameClippingDialog, IDataFrameShapeDialog, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class DataFrameClippingDialog
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDataFrameClippingDialog, IDataFrameShapeDialog

Data frame clipping dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

DataFrameClippingDialog()
Constructs a DataFrameClippingDialog using ArcGIS Engine.

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

Method Summary

boolean	doModal(IMapFrame pMapFrame, IGraphicsContainer pContainer, int parentWindow) Specify clip shape to data frame.
boolean	doModal(String title, IMapFrame pMapFrame, IGraphicsContainer pContainer, int hParentWnd) Opens and shows the dialog.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
IGeometry	getGeometry() Provides access to the shape.
int	hashCode() the hashcode for this object
void	setGeometry(IGeometry geometry) Provides access to the shape.

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

DataFrameClippingDialog

public DataFrameClippingDialog()
                        throws IOException,
                               UnknownHostException

Constructs a DataFrameClippingDialog using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

DataFrameClippingDialog

public DataFrameClippingDialog(Object obj)
                        throws IOException

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

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

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

doModal

public boolean doModal(IMapFrame pMapFrame,
                       IGraphicsContainer pContainer,
                       int parentWindow)
                throws IOException,
                       AutomationException

Specify clip shape to data frame.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

doModal in interface IDataFrameClippingDialog

Parameters:

pMapFrame - A reference to a com.esri.arcgis.carto.IMapFrame (in)

pContainer - A reference to a com.esri.arcgis.carto.IGraphicsContainer (in)

parentWindow - The parentWindow (A COM typedef) (in)

Returns:

The ok

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGeometry

public void setGeometry(IGeometry geometry)
                 throws IOException,
                        AutomationException

Provides access to the shape.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setGeometry in interface IDataFrameShapeDialog

Parameters:

geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeometry

public IGeometry getGeometry()
                      throws IOException,
                             AutomationException

Provides access to the shape.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getGeometry in interface IDataFrameShapeDialog

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

doModal

public boolean doModal(String title,
                       IMapFrame pMapFrame,
                       IGraphicsContainer pContainer,
                       int hParentWnd)
                throws IOException,
                       AutomationException

Opens and shows the dialog.

Product Availability

Available with ArcGIS Desktop.

Specified by:

doModal in interface IDataFrameShapeDialog

Parameters:

title - The title (in)

pMapFrame - A reference to a com.esri.arcgis.carto.IMapFrame (in)

pContainer - A reference to a com.esri.arcgis.carto.IGraphicsContainer (in)

hParentWnd - The hParentWnd (A COM typedef) (in)

Returns:

The ok

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.