com.esri.arcgis.catalog
Class GxCatalog

java.lang.Object
  extended by com.esri.arcgis.catalog.GxCatalog
All Implemented Interfaces:
IGxCatalog, IGxCatalogDefaultDatabase, IGxCatalogWorkspace, IGxDataElement, IGxDataElementHelper, IGxFile, IGxObject, IGxObjectContainer, IGxObjectEdit, IGxObjectFactories, IGxObjectSort, IGxObjectUI, IGxPasteTarget, IGxPasteTargetHelper, IConnectionPointContainer, com.esri.arcgis.interop.RemoteObjRef, IComPropertySheetEvents, Serializable, EventListener

public class GxCatalog
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGxCatalog, IGxCatalogWorkspace, IGxCatalogDefaultDatabase, IGxObject, IGxObjectUI, IGxObjectContainer, IGxObjectEdit, IGxPasteTarget, IGxFile, IComPropertySheetEvents, IConnectionPointContainer, IGxObjectFactories, IGxPasteTargetHelper, IGxDataElement, IGxDataElementHelper, IGxObjectSort

GxObject that represents the catalog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:
Serialized Form

Constructor Summary
GxCatalog()
          Constructs a GxCatalog using ArcGIS Engine.
GxCatalog(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GxCatalog theGxCatalog = (GxCatalog) obj;
 
Method Summary
 IGxObject addChild(IGxObject child)
          Adds a new child and returns a reference to it.
 void addIGxCatalogEventsDispListener(IGxCatalogEventsDisp theListener)
          addIGxCatalogEventsDispListener.
 void addIGxCatalogEventsListener(IGxCatalogEvents theListener)
          addIGxCatalogEventsListener.
 void attach(IGxObject parent, IGxCatalog pCatalog)
          Attaches the object to its parent and the catalog.
 boolean canCopy()
          Indicates if the object can be copied.
 boolean canDelete()
          Indicates if the object can be deleted.
 boolean canPaste(IEnumName names, boolean[] moveOperation)
          Indicates if the specified names may be pasted into this object.
 boolean canPaste(IName name, IGxObject target, boolean[] moveOperation)
          Indicates if the specified name object may be pasted into the given target.
 boolean canRename()
          Indicates if the object can be renamed.
 void close()
          Closes the catalog object.
 void close(boolean saveChanges)
          Closes the file, optionally saving changes.
 IGxFolder connectFolder(String folderPath)
          Adds a folder connection to the catalog and returns the folder object.
 String constructFullName(IGxObject gxObject)
          Constructs the full name for an object.
 void delete()
          Deletes the object.
 void deleteChild(IGxObject child)
          Deletes the specified child object.
 void detach()
          Instructs the object to detach itself from its parent and the catalog.
 void disconnectFolder(String folderPath)
          Removes a folder connection from the catalog.
 void edit()
          Opens an editor to modify the file.
 void editProperties(int hParent)
          Presents a modal dialog to allow editing the object's properties.
 void enableGxObjectFactory(int index, boolean enabled)
          Enables or disables a GxObject factory.
 void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
          enumConnectionPoints
 boolean equals(Object o)
          Compare this object with another
 void esri_new()
          Creates a new file.
 void findConnectionPoint(GUID riid, IConnectionPoint[] ppCP)
          findConnectionPoint
 String getBaseName()
          The base name of the object (i.e.
 String getCategory()
          The category of the object.
 IEnumGxObject getChildren()
          An enumeration of the child objects.
 IUID getClassID()
          The class ID of this object.
static String getClsid()
          getClsid.
 IUID getContextMenu()
          The class ID of the context menu for this object.
 int getCount()
          The number of registered GxObject factories.
 IDataElement getDataElement(IDEBrowseOptions browseOptions)
          Get the GxObject's data element.
 IWorkspaceName getDefaultDatabaseName()
          The default geodatabase.
 IWorkspaceName getDefaultDatabaseNameNoValidate()
          The default geodatabase.
 IEnumGxObjectFactory getEnabledGxObjectFactories()
          The enabled GxObject factories (sorted by priority).
 IGxFileFilter getFileFilter()
          The file filter.
 String getFullName()
          The full name of the object.
 IGxObjectFactory getGxObjectFactory(int index)
          The specified GxObject factory.
 IUID getGxObjectFactoryCLSID(int index)
          The class ID of the specified GxObject factory.
 IName getInternalObjectName()
          The Name for the internal object that this GxObject represents.
 int getLargeImage()
          The large image that represents the object.
 int getLargeSelectedImage()
          The large image that represents the object when it is selected.
 String getName()
          The short name of the object.
 IUID getNewMenu()
          The class ID of the New menu for this object.
 Object getObjectFromFullName(String fullName, int[] numFound)
          Finds an object in the catalog tree given its full name.
 IGxObject getParent()
          The parent of the object.
 String getPath()
          The full path for the file.
 IGxObject getSelectedObject()
          The first selected object, or the location if no objects are selected.
 IGxSelection getSelection()
          The selection.
 int getSmallImage()
          The small image that represents the object.
 int getSmallSelectedImage()
          The small image that represents the object when it is selected.
 String getWorkspaceFolderPath()
          The workspace path.
 int hashCode()
          the hashcode for this object
 boolean isAreChildrenViewable()
          Indicates if the objects children are available for viewing in the tree-view.
 boolean isEnabled(int index)
          Indicates if a specific GxObject factory is enabled.
 boolean isHasChildren()
          Indicates if the object has any children.
 boolean isSortEnabled()
          Indicates if sorting is enabled for this GxObject.
 boolean isUseWorkspaceFolder()
          Indicates if the catalog uses a workspace folder as a home folder.
 boolean isValid()
          Indicates if the object is still valid.
 void objectAdded(IGxObject gxObject)
          Called when a new object has been added to part of the catalog.
 void objectChanged(IGxObject gxObject)
          Called when an existing object from part of the catalog has been changed.
 void objectDeleted(IGxObject gxObject)
          Called when an existing object has been deleted from part of the catalog.
 void objectRefreshed(IGxObject gxObject)
          Called when an existing object has been refreshed.
 void onApply(IComPropertySheetEventsOnApplyEvent theEvent)
          Occurs when changes are applied.
 void open()
          Opens the file.
 void openWorkspaceFolder(String workspaceFolderPath)
          Opens the document catalog.
 boolean paste(IEnumName names, boolean[] moveOperation)
          Pastes the specified names into this object.
 boolean paste(IName name, IGxObject target, boolean[] moveOperation)
          Pastes the specified name object into the given target.
 void refresh()
          Updates the object and any children of the object.
 void removeIGxCatalogEventsDispListener(IGxCatalogEventsDisp theListener)
          removeIGxCatalogEventsDispListener.
 void removeIGxCatalogEventsListener(IGxCatalogEvents theListener)
          removeIGxCatalogEventsListener.
 void rename(String newShortName)
          Renames the object.
 void retrieveDEBaseProperties(IDataElement[] dataElement)
          Retrieve the GxObject's light-weight properties.
 void retrieveDEFullProperties(IDataElement[] dataElement)
          Retrieve the GxObject's heavy-weight properties.
 void save()
          Saves changes without closing the file.
 void setDefaultDatabaseName(IWorkspaceName ppWorkspaceName)
          The default geodatabase.
 void setDefaultDatabaseNameNoValidate(IWorkspaceName ppWorkspaceName)
          The default geodatabase.
 void setLocation(String rhs1)
          The location to the specified path.
 void setPath(String path)
          The full path for the file.
 void setSortEnabled(boolean path)
          Indicates if sorting is enabled for this GxObject.
 void setUseWorkspaceFolder(boolean bUseWorkspaceFolder)
          Indicates if the catalog uses a workspace folder as a home folder.
 
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

GxCatalog

public GxCatalog()
          throws IOException,
                 UnknownHostException
Constructs a GxCatalog using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

GxCatalog

public GxCatalog(Object obj)
          throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GxCatalog theGxCatalog = (GxCatalog) obj;

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

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

addIGxCatalogEventsDispListener

public void addIGxCatalogEventsDispListener(IGxCatalogEventsDisp theListener)
                                     throws IOException
addIGxCatalogEventsDispListener. Listen to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.catalog.IGxCatalogEventsDisp interface.
Throws:
IOException - If there are communications problems.

removeIGxCatalogEventsDispListener

public void removeIGxCatalogEventsDispListener(IGxCatalogEventsDisp theListener)
                                        throws IOException
removeIGxCatalogEventsDispListener. Stop listening to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.catalog.IGxCatalogEventsDisp interface.
Throws:
IOException - If there are communications problems.

addIGxCatalogEventsListener

public void addIGxCatalogEventsListener(IGxCatalogEvents theListener)
                                 throws IOException
addIGxCatalogEventsListener. Listen to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.catalog.IGxCatalogEvents interface.
Throws:
IOException - If there are communications problems.

removeIGxCatalogEventsListener

public void removeIGxCatalogEventsListener(IGxCatalogEvents theListener)
                                    throws IOException
removeIGxCatalogEventsListener. Stop listening to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.catalog.IGxCatalogEvents interface.
Throws:
IOException - If there are communications problems.

close

public void close()
           throws IOException,
                  AutomationException
Closes the catalog object. Clients that create a catalog object must call this method when they are finished using it.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
close in interface IGxCatalog
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSelection

public IGxSelection getSelection()
                          throws IOException,
                                 AutomationException
The selection.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getSelection in interface IGxCatalog
Returns:
A reference to a com.esri.arcgis.catalog.IGxSelection
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSelectedObject

public IGxObject getSelectedObject()
                            throws IOException,
                                   AutomationException
The first selected object, or the location if no objects are selected.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getSelectedObject in interface IGxCatalog
Returns:
A reference to a com.esri.arcgis.catalog.IGxObject
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLocation

public void setLocation(String rhs1)
                 throws IOException,
                        AutomationException
The location to the specified path. If the path isn't yet part of the catalog, it is added as a folder connection.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
setLocation in interface IGxCatalog
Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFileFilter

public IGxFileFilter getFileFilter()
                            throws IOException,
                                   AutomationException
The file filter.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getFileFilter in interface IGxCatalog
Returns:
A reference to a com.esri.arcgis.catalog.IGxFileFilter
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

connectFolder

public IGxFolder connectFolder(String folderPath)
                        throws IOException,
                               AutomationException
Adds a folder connection to the catalog and returns the folder object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
connectFolder in interface IGxCatalog
Parameters:
folderPath - The folderPath (in)
Returns:
A reference to a com.esri.arcgis.catalog.IGxFolder
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

disconnectFolder

public void disconnectFolder(String folderPath)
                      throws IOException,
                             AutomationException
Removes a folder connection from the catalog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
disconnectFolder in interface IGxCatalog
Parameters:
folderPath - The folderPath (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

objectAdded

public void objectAdded(IGxObject gxObject)
                 throws IOException,
                        AutomationException
Called when a new object has been added to part of the catalog.

Product Availability

Available with ArcGIS Desktop.

Specified by:
objectAdded in interface IGxCatalog
Parameters:
gxObject - A reference to a com.esri.arcgis.catalog.IGxObject (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

objectDeleted

public void objectDeleted(IGxObject gxObject)
                   throws IOException,
                          AutomationException
Called when an existing object has been deleted from part of the catalog.

Product Availability

Available with ArcGIS Desktop.

Specified by:
objectDeleted in interface IGxCatalog
Parameters:
gxObject - A reference to a com.esri.arcgis.catalog.IGxObject (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

objectChanged

public void objectChanged(IGxObject gxObject)
                   throws IOException,
                          AutomationException
Called when an existing object from part of the catalog has been changed.

Product Availability

Available with ArcGIS Desktop.

Specified by:
objectChanged in interface IGxCatalog
Parameters:
gxObject - A reference to a com.esri.arcgis.catalog.IGxObject (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

objectRefreshed

public void objectRefreshed(IGxObject gxObject)
                     throws IOException,
                            AutomationException
Called when an existing object has been refreshed.

Product Availability

Available with ArcGIS Desktop.

Specified by:
objectRefreshed in interface IGxCatalog
Parameters:
gxObject - A reference to a com.esri.arcgis.catalog.IGxObject (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

constructFullName

public String constructFullName(IGxObject gxObject)
                         throws IOException,
                                AutomationException
Constructs the full name for an object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
constructFullName in interface IGxCatalog
Parameters:
gxObject - A reference to a com.esri.arcgis.catalog.IGxObject (in)
Returns:
The fullName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getObjectFromFullName

public Object getObjectFromFullName(String fullName,
                                    int[] numFound)
                             throws IOException,
                                    AutomationException
Finds an object in the catalog tree given its full name. Returns a Variant containing an IGxObject or IEnumGxObject (if duplicate names were encountered), along with the number of objects found.

Remarks

An example of duplicate names (numFound > 1) is a CAD drawing. ArcCatalog represents a CAD drawing as two GxObjects - as a CAD drawing and as a CAD dataset.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getObjectFromFullName in interface IGxCatalog
Parameters:
fullName - The fullName (in)
numFound - The numFound (out: use single element array)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseWorkspaceFolder

public boolean isUseWorkspaceFolder()
                             throws IOException,
                                    AutomationException
Indicates if the catalog uses a workspace folder as a home folder.

Product Availability

Available with ArcGIS Desktop.

Specified by:
isUseWorkspaceFolder in interface IGxCatalogWorkspace
Returns:
The bUseWorkspaceFolder
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseWorkspaceFolder

public void setUseWorkspaceFolder(boolean bUseWorkspaceFolder)
                           throws IOException,
                                  AutomationException
Indicates if the catalog uses a workspace folder as a home folder.

Product Availability

Available with ArcGIS Desktop.

Specified by:
setUseWorkspaceFolder in interface IGxCatalogWorkspace
Parameters:
bUseWorkspaceFolder - The bUseWorkspaceFolder (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWorkspaceFolderPath

public String getWorkspaceFolderPath()
                              throws IOException,
                                     AutomationException
The workspace path.

Product Availability

Available with ArcGIS Desktop.

Specified by:
getWorkspaceFolderPath in interface IGxCatalogWorkspace
Returns:
The workspaceFolderPath
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

openWorkspaceFolder

public void openWorkspaceFolder(String workspaceFolderPath)
                         throws IOException,
                                AutomationException
Opens the document catalog.

Product Availability

Available with ArcGIS Desktop.

Specified by:
openWorkspaceFolder in interface IGxCatalogWorkspace
Parameters:
workspaceFolderPath - The workspaceFolderPath (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultDatabaseName

public IWorkspaceName getDefaultDatabaseName()
                                      throws IOException,
                                             AutomationException
The default geodatabase.

Product Availability

Available with ArcGIS Desktop.

Specified by:
getDefaultDatabaseName in interface IGxCatalogDefaultDatabase
Returns:
A reference to a com.esri.arcgis.geodatabase.IWorkspaceName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultDatabaseName

public void setDefaultDatabaseName(IWorkspaceName ppWorkspaceName)
                            throws IOException,
                                   AutomationException
The default geodatabase.

Product Availability

Available with ArcGIS Desktop.

Specified by:
setDefaultDatabaseName in interface IGxCatalogDefaultDatabase
Parameters:
ppWorkspaceName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultDatabaseNameNoValidate

public IWorkspaceName getDefaultDatabaseNameNoValidate()
                                                throws IOException,
                                                       AutomationException
The default geodatabase. Does not perform validation on the geodatabase.

Product Availability

Available with ArcGIS Desktop.

Specified by:
getDefaultDatabaseNameNoValidate in interface IGxCatalogDefaultDatabase
Returns:
A reference to a com.esri.arcgis.geodatabase.IWorkspaceName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultDatabaseNameNoValidate

public void setDefaultDatabaseNameNoValidate(IWorkspaceName ppWorkspaceName)
                                      throws IOException,
                                             AutomationException
The default geodatabase. Does not perform validation on the geodatabase.

Product Availability

Available with ArcGIS Desktop.

Specified by:
setDefaultDatabaseNameNoValidate in interface IGxCatalogDefaultDatabase
Parameters:
ppWorkspaceName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException
The short name of the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getName in interface IGxObject
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFullName

public String getFullName()
                   throws IOException,
                          AutomationException
The full name of the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getFullName in interface IGxObject
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBaseName

public String getBaseName()
                   throws IOException,
                          AutomationException
The base name of the object (i.e. no extension).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getBaseName in interface IGxObject
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCategory

public String getCategory()
                   throws IOException,
                          AutomationException
The category of the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getCategory in interface IGxObject
Returns:
The category
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getParent

public IGxObject getParent()
                    throws IOException,
                           AutomationException
The parent of the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getParent in interface IGxObject
Returns:
A reference to a com.esri.arcgis.catalog.IGxObject
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public IUID getClassID()
                throws IOException,
                       AutomationException
The class ID of this object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getClassID in interface IGxObject
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInternalObjectName

public IName getInternalObjectName()
                            throws IOException,
                                   AutomationException
The Name for the internal object that this GxObject represents.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getInternalObjectName in interface IGxObject
Returns:
A reference to a com.esri.arcgis.system.IName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isValid

public boolean isValid()
                throws IOException,
                       AutomationException
Indicates if the object is still valid.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
isValid in interface IGxObject
Returns:
The isValid
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

attach

public void attach(IGxObject parent,
                   IGxCatalog pCatalog)
            throws IOException,
                   AutomationException
Attaches the object to its parent and the catalog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
attach in interface IGxObject
Parameters:
parent - A reference to a com.esri.arcgis.catalog.IGxObject (in)
pCatalog - A reference to a com.esri.arcgis.catalog.IGxCatalog (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

detach

public void detach()
            throws IOException,
                   AutomationException
Instructs the object to detach itself from its parent and the catalog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
detach in interface IGxObject
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh()
             throws IOException,
                    AutomationException
Updates the object and any children of the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
refresh in interface IGxObject
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSmallImage

public int getSmallImage()
                  throws IOException,
                         AutomationException
The small image that represents the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getSmallImage in interface IGxObjectUI
Returns:
The hBitmap (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSmallSelectedImage

public int getSmallSelectedImage()
                          throws IOException,
                                 AutomationException
The small image that represents the object when it is selected.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getSmallSelectedImage in interface IGxObjectUI
Returns:
The hBitmap (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLargeImage

public int getLargeImage()
                  throws IOException,
                         AutomationException
The large image that represents the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getLargeImage in interface IGxObjectUI
Returns:
The hBitmap (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLargeSelectedImage

public int getLargeSelectedImage()
                          throws IOException,
                                 AutomationException
The large image that represents the object when it is selected.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getLargeSelectedImage in interface IGxObjectUI
Returns:
The hBitmap (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getContextMenu

public IUID getContextMenu()
                    throws IOException,
                           AutomationException
The class ID of the context menu for this object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getContextMenu in interface IGxObjectUI
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNewMenu

public IUID getNewMenu()
                throws IOException,
                       AutomationException
The class ID of the New menu for this object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getNewMenu in interface IGxObjectUI
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isHasChildren

public boolean isHasChildren()
                      throws IOException,
                             AutomationException
Indicates if the object has any children.

Remarks

Note: This property always return True even when it has no children. This was done to improve the overall ArcCatalog browsing performance.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
isHasChildren in interface IGxObjectContainer
Returns:
The hasChildren
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getChildren

public IEnumGxObject getChildren()
                          throws IOException,
                                 AutomationException
An enumeration of the child objects.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getChildren in interface IGxObjectContainer
Returns:
A reference to a com.esri.arcgis.catalog.IEnumGxObject
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAreChildrenViewable

public boolean isAreChildrenViewable()
                              throws IOException,
                                     AutomationException
Indicates if the objects children are available for viewing in the tree-view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
isAreChildrenViewable in interface IGxObjectContainer
Returns:
The areViewable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addChild

public IGxObject addChild(IGxObject child)
                   throws IOException,
                          AutomationException
Adds a new child and returns a reference to it. However, if a duplicate already exists, the function returns the existing child instead.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
addChild in interface IGxObjectContainer
Parameters:
child - A reference to a com.esri.arcgis.catalog.IGxObject (in)
Returns:
A reference to a com.esri.arcgis.catalog.IGxObject
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteChild

public void deleteChild(IGxObject child)
                 throws IOException,
                        AutomationException
Deletes the specified child object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
deleteChild in interface IGxObjectContainer
Parameters:
child - A reference to a com.esri.arcgis.catalog.IGxObject (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canRename

public boolean canRename()
                  throws IOException,
                         AutomationException
Indicates if the object can be renamed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
canRename in interface IGxObjectEdit
Returns:
The canRename
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

rename

public void rename(String newShortName)
            throws IOException,
                   AutomationException
Renames the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
rename in interface IGxObjectEdit
Parameters:
newShortName - The newShortName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canDelete

public boolean canDelete()
                  throws IOException,
                         AutomationException
Indicates if the object can be deleted.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
canDelete in interface IGxObjectEdit
Returns:
The canDelete
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

delete

public void delete()
            throws IOException,
                   AutomationException
Deletes the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
delete in interface IGxObjectEdit
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

editProperties

public void editProperties(int hParent)
                    throws IOException,
                           AutomationException
Presents a modal dialog to allow editing the object's properties.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
editProperties in interface IGxObjectEdit
Parameters:
hParent - The hParent (A COM typedef) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canCopy

public boolean canCopy()
                throws IOException,
                       AutomationException
Indicates if the object can be copied.

Remarks

CanCopy must return True if your customized GxObject is intended to support copy/paste, drag/drop within ArcCatalog or drag/drop from ArcCatalog to ArcMap.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
canCopy in interface IGxObjectEdit
Returns:
The canCopy
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canPaste

public boolean canPaste(IEnumName names,
                        boolean[] moveOperation)
                 throws IOException,
                        AutomationException
Indicates if the specified names may be pasted into this object. On output, moveOperation indicates if a subsequent paste operation would represent a move, or merely a copy, operation.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
canPaste in interface IGxPasteTarget
Parameters:
names - A reference to a com.esri.arcgis.system.IEnumName (in)
moveOperation - The moveOperation (in/out: use single element array)
Returns:
The canPaste
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

paste

public boolean paste(IEnumName names,
                     boolean[] moveOperation)
              throws IOException,
                     AutomationException
Pastes the specified names into this object. On input, moveOperation indicates if this is a move operation. On output, it indicates if the objects have been moved, or merely copied.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
paste in interface IGxPasteTarget
Parameters:
names - A reference to a com.esri.arcgis.system.IEnumName (in)
moveOperation - The moveOperation (in/out: use single element array)
Returns:
The successfulPaste
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPath

public void setPath(String path)
             throws IOException,
                    AutomationException
The full path for the file.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
setPath in interface IGxFile
Parameters:
path - The path (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPath

public String getPath()
               throws IOException,
                      AutomationException
The full path for the file.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getPath in interface IGxFile
Returns:
The path
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_new

public void esri_new()
              throws IOException,
                     AutomationException
Creates a new file.

Product Availability

Available with ArcGIS Desktop.

Specified by:
esri_new in interface IGxFile
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

open

public void open()
          throws IOException,
                 AutomationException
Opens the file.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
open in interface IGxFile
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

close

public void close(boolean saveChanges)
           throws IOException,
                  AutomationException
Closes the file, optionally saving changes.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
close in interface IGxFile
Parameters:
saveChanges - The saveChanges (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

edit

public void edit()
          throws IOException,
                 AutomationException
Opens an editor to modify the file.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
edit in interface IGxFile
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save()
          throws IOException,
                 AutomationException
Saves changes without closing the file.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
save in interface IGxFile
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onApply

public void onApply(IComPropertySheetEventsOnApplyEvent theEvent)
             throws IOException,
                    AutomationException
Occurs when changes are applied.

Description

Call OnApply to notify other parts of the application that the objects passed to the property sheet have been edited.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
onApply in interface IComPropertySheetEvents
Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws IOException,
                                 AutomationException
enumConnectionPoints

Description

IConnectionPointContainer 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:
enumConnectionPoints in interface IConnectionPointContainer
Parameters:
ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws IOException,
                                AutomationException
findConnectionPoint

Description

IConnectionPointContainer 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:
findConnectionPoint in interface IConnectionPointContainer
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws IOException,
                    AutomationException
The number of registered GxObject factories.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getCount in interface IGxObjectFactories
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEnabled

public boolean isEnabled(int index)
                  throws IOException,
                         AutomationException
Indicates if a specific GxObject factory is enabled.

Product Availability

Available with ArcGIS Desktop.

Specified by:
isEnabled in interface IGxObjectFactories
Parameters:
index - The index (in)
Returns:
The isEnabled
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

enableGxObjectFactory

public void enableGxObjectFactory(int index,
                                  boolean enabled)
                           throws IOException,
                                  AutomationException
Enables or disables a GxObject factory.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
enableGxObjectFactory in interface IGxObjectFactories
Parameters:
index - The index (in)
enabled - The enabled (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGxObjectFactoryCLSID

public IUID getGxObjectFactoryCLSID(int index)
                             throws IOException,
                                    AutomationException
The class ID of the specified GxObject factory.

Product Availability

Available with ArcGIS Desktop.

Specified by:
getGxObjectFactoryCLSID in interface IGxObjectFactories
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGxObjectFactory

public IGxObjectFactory getGxObjectFactory(int index)
                                    throws IOException,
                                           AutomationException
The specified GxObject factory.

Product Availability

Available with ArcGIS Desktop.

Specified by:
getGxObjectFactory in interface IGxObjectFactories
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.catalog.IGxObjectFactory
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEnabledGxObjectFactories

public IEnumGxObjectFactory getEnabledGxObjectFactories()
                                                 throws IOException,
                                                        AutomationException
The enabled GxObject factories (sorted by priority).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getEnabledGxObjectFactories in interface IGxObjectFactories
Returns:
A reference to a com.esri.arcgis.catalog.IEnumGxObjectFactory
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canPaste

public boolean canPaste(IName name,
                        IGxObject target,
                        boolean[] moveOperation)
                 throws IOException,
                        AutomationException
Indicates if the specified name object may be pasted into the given target. On output, moveOperation indicates if a subsequent paste operation would represent a move, or merely a copy, operation.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
canPaste in interface IGxPasteTargetHelper
Parameters:
name - A reference to a com.esri.arcgis.system.IName (in)
target - A reference to a com.esri.arcgis.catalog.IGxObject (in)
moveOperation - The moveOperation (out: use single element array)
Returns:
The canPaste
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

paste

public boolean paste(IName name,
                     IGxObject target,
                     boolean[] moveOperation)
              throws IOException,
                     AutomationException
Pastes the specified name object into the given target. On input, moveOperation indicates if this is a move operation. On output, it indicates if the objects have been moved, or merely copied.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
paste in interface IGxPasteTargetHelper
Parameters:
name - A reference to a com.esri.arcgis.system.IName (in)
target - A reference to a com.esri.arcgis.catalog.IGxObject (in)
moveOperation - The moveOperation (in/out: use single element array)
Returns:
The successfulPaste
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDataElement

public IDataElement getDataElement(IDEBrowseOptions browseOptions)
                            throws IOException,
                                   AutomationException
Get the GxObject's data element.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getDataElement in interface IGxDataElement
Parameters:
browseOptions - A reference to a com.esri.arcgis.geodatabase.IDEBrowseOptions (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IDataElement
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

retrieveDEFullProperties

public void retrieveDEFullProperties(IDataElement[] dataElement)
                              throws IOException,
                                     AutomationException
Retrieve the GxObject's heavy-weight properties.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
retrieveDEFullProperties in interface IGxDataElementHelper
Parameters:
dataElement - A reference to a com.esri.arcgis.geodatabase.IDataElement (in/out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

retrieveDEBaseProperties

public void retrieveDEBaseProperties(IDataElement[] dataElement)
                              throws IOException,
                                     AutomationException
Retrieve the GxObject's light-weight properties.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
retrieveDEBaseProperties in interface IGxDataElementHelper
Parameters:
dataElement - A reference to a com.esri.arcgis.geodatabase.IDataElement (in/out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSortEnabled

public void setSortEnabled(boolean path)
                    throws IOException,
                           AutomationException
Indicates if sorting is enabled for this GxObject.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
setSortEnabled in interface IGxObjectSort
Parameters:
path - The path (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSortEnabled

public boolean isSortEnabled()
                      throws IOException,
                             AutomationException
Indicates if sorting is enabled for this GxObject.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
isSortEnabled in interface IGxObjectSort
Returns:
The path
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.