com.esri.arcgis.catalog
Class GxToolboxesRoot

java.lang.Object
  extended by com.esri.arcgis.catalog.GxToolboxesRoot
All Implemented Interfaces:
IGxCachedObjects, IGxObject, IGxObjectContainer, IGxObjectEdit, IGxObjectProperties, IGxObjectUI, IGxPasteTarget, IGxRootObjectSortPriority, IGxRootObjectStartupProperties, IGxToolboxesRoot, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class GxToolboxesRoot
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGxObject, IGxObjectUI, IGxObjectEdit, IGxObjectProperties, IGxObjectContainer, IGxPasteTarget, IGxCachedObjects, IGxRootObjectStartupProperties, IGxRootObjectSortPriority, IGxToolboxesRoot

COM Class 'GxToolboxesRoot'. Generated 3/19/2015 1:20:49 PM from 'C:\ArcGIS\COM\esriCatalog.olb'

Description 'Catalog object corresponding to root-level Toolboxes node.' 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.catalog.IGxObject
IID, IIDbdbbb3eb_d0b2_11d1_aed9_080009ec734b, xxDummy
 
Fields inherited from interface com.esri.arcgis.catalog.IGxObjectUI
IID, IID7273aa57_e6f9_11d2_9f30_00c04f6bc69e, xxDummy
 
Fields inherited from interface com.esri.arcgis.catalog.IGxObjectEdit
IID, IIDbdbbb3fc_d0b2_11d1_aed9_080009ec734b, xxDummy
 
Fields inherited from interface com.esri.arcgis.catalog.IGxObjectProperties
IID, IIDd342626e_f9da_11d3_a68d_0008c7d3ae8d, xxDummy
 
Fields inherited from interface com.esri.arcgis.catalog.IGxObjectContainer
IID, IID7273aa58_e6f9_11d2_9f30_00c04f6bc69e, xxDummy
 
Fields inherited from interface com.esri.arcgis.catalog.IGxPasteTarget
IID, IIDbdbbb403_d0b2_11d1_aed9_080009ec734b, xxDummy
 
Fields inherited from interface com.esri.arcgis.catalog.IGxCachedObjects
IID, IIDbdbbb404_d0b2_11d1_aed9_080009ec734b, xxDummy
 
Fields inherited from interface com.esri.arcgis.catalog.IGxRootObjectStartupProperties
IID, IIDb1c5dd7c_db4e_485a_8beb_6c656b15a294, xxDummy
 
Fields inherited from interface com.esri.arcgis.catalog.IGxRootObjectSortPriority
IID, IIDe393f857_2ed2_468e_9539_e6355e53027e, xxDummy
 
Fields inherited from interface com.esri.arcgis.catalog.IGxToolboxesRoot
IID, IID5bc85e0e_5c73_4b4b_b987_43ede7779517, xxDummy
 
Constructor Summary
GxToolboxesRoot()
          Constructs a GxToolboxesRoot using ArcGIS Engine.
GxToolboxesRoot(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GxToolboxesRoot theGxToolboxesRoot = (GxToolboxesRoot) obj;
 
Method Summary
 IGxObject addChild(IGxObject child)
          Adds a new child and returns a reference to it.
 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 canRename()
          Indicates if the object can be renamed.
 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 editProperties(int hParent)
          Presents a modal dialog to allow editing the object's properties.
 boolean equals(java.lang.Object o)
          Compare this object with another
 java.lang.String getBaseName()
          The base name of the object (i.e.
 java.lang.String getCategory()
          The category of the object.
 IEnumGxObject getChildren()
          An enumeration of the child objects.
 IUID getClassID()
          The class ID of this object.
static java.lang.String getClsid()
          getClsid.
 IUID getContextMenu()
          The class ID of the context menu for this object.
 java.lang.String getFullName()
          The full name of the object.
 IName getInternalObjectName()
          The Name for the internal object that this GxObject represents.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 int getLargeImage()
          The large image that represents the object.
 int getLargeSelectedImage()
          The large image that represents the object when it is selected.
 java.lang.String getName()
          The short name of the object.
 IUID getNewMenu()
          The class ID of the New menu for this object.
 IGxObject getParent()
          The parent of the object.
 void getPropByIndex(int index, java.lang.String[] name, java.lang.Object[] value)
          The name and value of the indexed property in the GxObject.
 java.lang.Object getProperty(java.lang.String name)
          The value of the named property in the GxObject.
 int getPropertyCount()
          The number of properties in the GxObject.
 int getSmallImage()
          The small image that represents the object.
 int getSmallSelectedImage()
          The small image that represents the object when it is selected.
 int getSortPriority()
          Returns the sort priority for the Root level Object.
 int hashCode()
          the hashcode for this object
 boolean isAreChildrenViewable()
          Indicates if the objects children are available for viewing in the tree-view.
 boolean isEnabled()
          Indicates whether the Root level Object will be visible during startup.
 boolean isHasChildren()
          Indicates if the object has any children.
 boolean isValid()
          Indicates if the object is still valid.
 void loadCachedObjects()
          Loads any objects that should be cached for efficiency.
 boolean paste(IEnumName names, boolean[] moveOperation)
          Pastes the specified names into this object.
 void refresh()
          Updates the object and any children of the object.
 void release()
          Release a GxToolboxesRoot.
 void releaseCachedObjects()
          Releases any objects that have been cached for efficiency.
 void rename(java.lang.String newShortName)
          Renames the object.
 void setProperty(java.lang.String name, java.lang.Object value)
          Set the value of the named property in the GxObject.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GxToolboxesRoot

public GxToolboxesRoot()
                throws java.io.IOException,
                       java.net.UnknownHostException
Constructs a GxToolboxesRoot using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

GxToolboxesRoot

public GxToolboxesRoot(java.lang.Object obj)
                throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GxToolboxesRoot theGxToolboxesRoot = (GxToolboxesRoot) obj;

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

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

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getName

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

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

getFullName

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

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

getBaseName

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

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

getCategory

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

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

getParent

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

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

getClassID

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

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

getInternalObjectName

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

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

isValid

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

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

attach

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

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

detach

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

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

refresh

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

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

getSmallImage

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

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

getSmallSelectedImage

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

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

getLargeImage

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

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

getLargeSelectedImage

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

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

getContextMenu

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

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

getNewMenu

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

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

canRename

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

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

rename

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

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

canDelete

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

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

delete

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

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

editProperties

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

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

canCopy

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

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

getPropertyCount

public int getPropertyCount()
                     throws java.io.IOException,
                            AutomationException
The number of properties in the GxObject.

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

getPropByIndex

public void getPropByIndex(int index,
                           java.lang.String[] name,
                           java.lang.Object[] value)
                    throws java.io.IOException,
                           AutomationException
The name and value of the indexed property in the GxObject.

Specified by:
getPropByIndex in interface IGxObjectProperties
Parameters:
index - The index (in)
name - The name (in/out: use single element array)
value - A Variant (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getProperty

public java.lang.Object getProperty(java.lang.String name)
                             throws java.io.IOException,
                                    AutomationException
The value of the named property in the GxObject.

Specified by:
getProperty in interface IGxObjectProperties
Parameters:
name - The name (in)
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)
                 throws java.io.IOException,
                        AutomationException
Set the value of the named property in the GxObject.

Specified by:
setProperty in interface IGxObjectProperties
Parameters:
name - The name (in)
value - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isHasChildren

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

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

getChildren

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

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

isAreChildrenViewable

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

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

addChild

public IGxObject addChild(IGxObject child)
                   throws java.io.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.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteChild

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

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

canPaste

public boolean canPaste(IEnumName names,
                        boolean[] moveOperation)
                 throws java.io.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.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

paste

public boolean paste(IEnumName names,
                     boolean[] moveOperation)
              throws java.io.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.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

loadCachedObjects

public void loadCachedObjects()
                       throws java.io.IOException,
                              AutomationException
Loads any objects that should be cached for efficiency.

Specified by:
loadCachedObjects in interface IGxCachedObjects
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

releaseCachedObjects

public void releaseCachedObjects()
                          throws java.io.IOException,
                                 AutomationException
Releases any objects that have been cached for efficiency.

Specified by:
releaseCachedObjects in interface IGxCachedObjects
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEnabled

public boolean isEnabled()
                  throws java.io.IOException,
                         AutomationException
Indicates whether the Root level Object will be visible during startup.

Specified by:
isEnabled in interface IGxRootObjectStartupProperties
Returns:
The isEnabled
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSortPriority

public int getSortPriority()
                    throws java.io.IOException,
                           AutomationException
Returns the sort priority for the Root level Object.

Specified by:
getSortPriority in interface IGxRootObjectSortPriority
Returns:
The priority
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.