com.esri.arcgis.systemUI
Class DataObjectHelper

java.lang.Object
  com.esri.arcgis.systemUI.DataObjectHelper

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, IDataObjectHelper, java.io.Serializable

public class DataObjectHelper
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IDataObjectHelper, ISupportErrorInfo

COM Class 'DataObjectHelper'. Generated 3/19/2015 1:20:47 PM from 'C:\ArcGIS\COM\esriSystemUI.olb'

Description 'Helper class for OLE drag and drop.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.systemUI.IDataObjectHelper

IID, IIDe0ccbcb0_cd47_11d5_a9e6_00104bb6fc1c, xxDummy

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

DataObjectHelper()
Constructs a DataObjectHelper using ArcGIS Engine.

DataObjectHelper(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DataObjectHelper theDataObjectHelper = (DataObjectHelper) obj;

Method Summary

boolean	canGetFiles() Indicates if files are available in the DataObject.
boolean	canGetNames() Indicates if Esri names are available in the DataObject.
boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
java.lang.Object	getData(int format) If specified DataObject format can be retrieved, returns the data as safe array of bytes.
java.lang.Object	getFiles() If the DataObject format supports files, returns a safe array of strings representing filenames.
boolean	getFormat(int format) Indicates if the DataObject supports the specified format.
java.lang.Object	getInternalObject() Provides access to the internal IDataObject pointer.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IEnumName	getNames() If the DataObject format supports Esri names, returns an enumerator of names.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	release() Release a DataObjectHelper.
void	setInternalObjectByRef(java.lang.Object ppObject) Provides access to the internal IDataObject pointer.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataObjectHelper

public DataObjectHelper()
                 throws java.io.IOException,
                        java.net.UnknownHostException

Constructs a DataObjectHelper using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

DataObjectHelper

public DataObjectHelper(java.lang.Object obj)
                 throws java.io.IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a DataObjectHelper.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

setInternalObjectByRef

public void setInternalObjectByRef(java.lang.Object ppObject)
                            throws java.io.IOException,
                                   AutomationException

Provides access to the internal IDataObject pointer.

Specified by:

setInternalObjectByRef in interface IDataObjectHelper

Parameters:

ppObject - A reference to another Object (IUnknown) (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInternalObject

public java.lang.Object getInternalObject()
                                   throws java.io.IOException,
                                          AutomationException

Provides access to the internal IDataObject pointer.

Specified by:

getInternalObject in interface IDataObjectHelper

Returns:

A reference to another Object (IUnknown)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getData

public java.lang.Object getData(int format)
                         throws java.io.IOException,
                                AutomationException

If specified DataObject format can be retrieved, returns the data as safe array of bytes.

Specified by:

getData in interface IDataObjectHelper

Parameters:

format - The format (in)

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFormat

public boolean getFormat(int format)
                  throws java.io.IOException,
                         AutomationException

Indicates if the DataObject supports the specified format.

Specified by:

getFormat in interface IDataObjectHelper

Parameters:

format - The format (in)

Returns:

The pbFormatSupported

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canGetFiles

public boolean canGetFiles()
                    throws java.io.IOException,
                           AutomationException

Indicates if files are available in the DataObject.

Specified by:

canGetFiles in interface IDataObjectHelper

Returns:

The canGetFiles

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFiles

public java.lang.Object getFiles()
                          throws java.io.IOException,
                                 AutomationException

If the DataObject format supports files, returns a safe array of strings representing filenames.

Specified by:

getFiles in interface IDataObjectHelper

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canGetNames

public boolean canGetNames()
                    throws java.io.IOException,
                           AutomationException

Indicates if Esri names are available in the DataObject.

Specified by:

canGetNames in interface IDataObjectHelper

Returns:

The canGetNames

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNames

public IEnumName getNames()
                   throws java.io.IOException,
                          AutomationException

If the DataObject format supports Esri names, returns an enumerator of names.

Specified by:

getNames in interface IDataObjectHelper

Returns:

A reference to a com.esri.arcgis.system.IEnumName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.