com.esri.arcgis.catalogUI
Interface IGxView

All Superinterfaces:

Serializable

All Known Implementing Classes:

GxContentsView, GxDataGraphView, GxDocumentationView, GxGeographicView, GxMSDFileView, GxPreview, GxRasterCatalogContentView, GxRasterCatalogSubPropertyView, GxTableView, GxTreeView, IGxViewProxy

public interface IGxView
extends Serializable

Provides access to members that control the GxView.

Remarks

A GxView must minimally support the IGxView interface, which ArcCatalog uses to negotiate with the view. It asks the view for an HWND to display through the hWnd property. It reparents this HWND so that it is a child of an ArcCatalog HWND, and guarantees events are passed to the HWND correctly, and that it is resized when the ArcCatalog window is resized. Developers wishing to create their own custom views must implement this interface.

Use the Activate property to hold on to the GxApplication and GxCatalog objects that are passed in as parameters. The Deactivate property is used to release these references.

DefaultToolbarCLSID provides a reference to the default toolbar for the particular view. The default toolbar for a view would contain tools that were appropriate for the current type of GxView.

If the SupportsTools property returns True, ArcCatalog will intercept mouse events normally destined for the view, and instead send them to the active tool.

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	activate(IGxApplication application, IGxCatalog catalog) Activates the view.
boolean	applies(IGxObject selection) Indicates if the view can display the given object.
void	deactivate() Deactivates the view.
IUID	getClassID() The class ID of the view.
IUID	getDefaultToolbarCLSID() The class ID of the view's default toolbar.
int	getHWnd() The view's window handle.
String	getName() The name of the view.
boolean	isSupportsTools() Indicates if the view supports tools.
void	refresh() Refreshes the view.
void	systemSettingChanged(int flag, String section) Informs the view that a system setting has changed.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

The name of the view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

IUID getClassID()
                throws IOException,
                       AutomationException

The class ID of the view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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.

getHWnd

int getHWnd()
            throws IOException,
                   AutomationException

The view's window handle.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The window (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultToolbarCLSID

IUID getDefaultToolbarCLSID()
                            throws IOException,
                                   AutomationException

The class ID of the view's default toolbar. Not currently used.

Remarks

DefaultToolbarCLSID provides a reference to the default toolbar for the particular view. The default toolbar for a view would contain tools that were appropriate for the current type of GxView.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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.

isSupportsTools

boolean isSupportsTools()
                        throws IOException,
                               AutomationException

Indicates if the view supports tools.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The supportsTools

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

applies

boolean applies(IGxObject selection)
                throws IOException,
                       AutomationException

Indicates if the view can display the given object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

selection - A reference to a com.esri.arcgis.catalog.IGxObject (in)

Returns:

The applies

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

activate

void activate(IGxApplication application,
              IGxCatalog catalog)
              throws IOException,
                     AutomationException

Activates the view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

application - A reference to a com.esri.arcgis.catalogUI.IGxApplication (in)

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

deactivate

void deactivate()
                throws IOException,
                       AutomationException

Deactivates the view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

void refresh()
             throws IOException,
                    AutomationException

Refreshes the view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

systemSettingChanged

void systemSettingChanged(int flag,
                          String section)
                          throws IOException,
                                 AutomationException

Informs the view that a system setting has changed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

flag - The flag (in)

section - The section (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.