com.esri.arcgis.catalogUI
Class GxGeographicView

java.lang.Object
  com.esri.arcgis.catalogUI.GxGeographicView

All Implemented Interfaces:

IGxCatalogEvents, IGxSelectionEvents, IGxGeographicView, IGxGeographicView2, IGxView, ITransformEvents, com.esri.arcgis.interop.RemoteObjRef, Serializable, EventListener

public class GxGeographicView
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGxView, IGxGeographicView, IGxGeographicView2, IGxSelectionEvents, IGxCatalogEvents, ITransformEvents

GxView that represents the geographic view.

Remarks

When you want to preview your data, the GxGeographicView is what you will typically use. It is available through the "Preview" tab within ArcCatalog, and displays the geography of the selected dataset in its window. By default the GxGeographicView object shows up on the Preview Tab page, however, the object implements IGxView like the other GxView objects and could be used as its own tab.

A set of standard manipulation tools is provided for zooming, panning, and performing identifies. The developer can easily add their own views that work with this view in whatever fashion they would like. You accomplish this by accessing the map or map display objects from the IGxGeographicView interface. Internally, the view uses the services of these two objects to display the selected item, and you can manipulate them as well.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

GxGeographicView()
Constructs a GxGeographicView using ArcGIS Engine.

GxGeographicView(Object obj)
Construct a GxGeographicView using a reference to such an object returned from ArcGIS Engine or Server.

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	boundsUpdated(ITransformEventsBoundsUpdatedEvent theEvent) Notifies clients when the bounds is updated.
void	deactivate() Deactivates the view.
void	deviceFrameUpdated(ITransformEventsDeviceFrameUpdatedEvent theEvent) Notifies clients when the device frame is updated.
boolean	equals(Object o) Compare this object with another
IActiveView	getActiveView() The active view object(either map or page layout).
IUID	getClassID() The class ID of the view.
static String	getClsid() getClsid.
IUID	getDefaultToolbarCLSID() The class ID of the view's default toolbar.
ILayer	getDisplayedLayer() The layer object currently being displayed.
int	getHWnd() The view's window handle.
IMap	getMap() The map object that is used to draw the layer.
IScreenDisplay	getMapDisplay() The display object that is used to draw the layer.
String	getName() The name of the view.
int	hashCode() the hashcode for this object
boolean	isSupportsTools() Indicates if the view supports tools.
void	onObjectAdded(IGxCatalogEventsOnObjectAddedEvent theEvent) Called when an object has been added to some part of the catalog.
void	onObjectChanged(IGxCatalogEventsOnObjectChangedEvent theEvent) Called when an object in some part of the catalog has been changed.
void	onObjectDeleted(IGxCatalogEventsOnObjectDeletedEvent theEvent) Called when an object has been deleted from some part of the catalog.
void	onObjectRefreshed(IGxCatalogEventsOnObjectRefreshedEvent theEvent) Called when an object in some part of the catalog has been refreshed.
void	onRefreshAll(IGxCatalogEventsOnRefreshAllEvent theEvent) Called when the whole catalog has changed.
void	onSelectionChanged(IGxSelectionEventsOnSelectionChangedEvent theEvent) Called when the selection contents have changed.
void	refresh() Refreshes the view.
void	resolutionUpdated(ITransformEventsResolutionUpdatedEvent theEvent) Notifies clients when the resolution is updated.
void	rotationUpdated(ITransformEventsRotationUpdatedEvent theEvent) Notifies clients when the rotation angle is updated.
void	systemSettingChanged(int flag, String section) Informs the view that a system setting has changed.
void	unitsUpdated(ITransformEventsUnitsUpdatedEvent theEvent) Notifies clients when the units are updated.
void	visibleBoundsUpdated(ITransformEventsVisibleBoundsUpdatedEvent theEvent) Notifies clients when the visible bounds is updated.

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

GxGeographicView

public GxGeographicView()
                 throws IOException,
                        UnknownHostException

Constructs a GxGeographicView using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GxGeographicView

public GxGeographicView(Object obj)
                 throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems GxGeographicView theGxGeographicView = (GxGeographicView) obj;

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

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getName in interface IGxView

Returns:

The name

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 the view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getClassID in interface IGxView

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

public int getHWnd()
            throws IOException,
                   AutomationException

The view's window handle.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getHWnd in interface IGxView

Returns:

The window (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultToolbarCLSID

public 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

Specified by:

getDefaultToolbarCLSID in interface IGxView

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

public boolean isSupportsTools()
                        throws IOException,
                               AutomationException

Indicates if the view supports tools.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isSupportsTools in interface IGxView

Returns:

The supportsTools

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

applies

public 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

Specified by:

applies in interface IGxView

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

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

Activates the view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

activate in interface IGxView

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

public void deactivate()
                throws IOException,
                       AutomationException

Deactivates the view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

deactivate in interface IGxView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh()
             throws IOException,
                    AutomationException

Refreshes the view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

refresh in interface IGxView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

systemSettingChanged

public 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

Specified by:

systemSettingChanged in interface IGxView

Parameters:

flag - The flag (in)

section - The section (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayedLayer

public ILayer getDisplayedLayer()
                         throws IOException,
                                AutomationException

The layer object currently being displayed.

Remarks

The DisplayedLayer property is set to nothing when the selected object can not be previewed in the GxGeographicView.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getDisplayedLayer in interface IGxGeographicView

Specified by:

getDisplayedLayer in interface IGxGeographicView2

Returns:

A reference to a com.esri.arcgis.carto.ILayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapDisplay

public IScreenDisplay getMapDisplay()
                             throws IOException,
                                    AutomationException

The display object that is used to draw the layer.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getMapDisplay in interface IGxGeographicView

Specified by:

getMapDisplay in interface IGxGeographicView2

Returns:

A reference to a com.esri.arcgis.display.IScreenDisplay

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMap

public IMap getMap()
            throws IOException,
                   AutomationException

The map object that is used to draw the layer.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getMap in interface IGxGeographicView

Specified by:

getMap in interface IGxGeographicView2

Returns:

A reference to a com.esri.arcgis.carto.IMap

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActiveView

public IActiveView getActiveView()
                          throws IOException,
                                 AutomationException

The active view object(either map or page layout).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getActiveView in interface IGxGeographicView2

Returns:

A reference to a com.esri.arcgis.carto.IActiveView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onSelectionChanged

public void onSelectionChanged(IGxSelectionEventsOnSelectionChangedEvent theEvent)
                        throws IOException,
                               AutomationException

Called when the selection contents have changed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

onSelectionChanged in interface IGxSelectionEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onRefreshAll

public void onRefreshAll(IGxCatalogEventsOnRefreshAllEvent theEvent)
                  throws IOException,
                         AutomationException

Called when the whole catalog has changed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

onRefreshAll in interface IGxCatalogEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onObjectAdded

public void onObjectAdded(IGxCatalogEventsOnObjectAddedEvent theEvent)
                   throws IOException,
                          AutomationException

Called when an object has been added to some part of the catalog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

onObjectAdded in interface IGxCatalogEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onObjectDeleted

public void onObjectDeleted(IGxCatalogEventsOnObjectDeletedEvent theEvent)
                     throws IOException,
                            AutomationException

Called when an object has been deleted from some part of the catalog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

onObjectDeleted in interface IGxCatalogEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onObjectChanged

public void onObjectChanged(IGxCatalogEventsOnObjectChangedEvent theEvent)
                     throws IOException,
                            AutomationException

Called when an object in some part of the catalog has been changed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

onObjectChanged in interface IGxCatalogEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onObjectRefreshed

public void onObjectRefreshed(IGxCatalogEventsOnObjectRefreshedEvent theEvent)
                       throws IOException,
                              AutomationException

Called when an object in some part of the catalog has been refreshed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

onObjectRefreshed in interface IGxCatalogEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

boundsUpdated

public void boundsUpdated(ITransformEventsBoundsUpdatedEvent theEvent)
                   throws IOException,
                          AutomationException

Notifies clients when the bounds is updated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

boundsUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

visibleBoundsUpdated

public void visibleBoundsUpdated(ITransformEventsVisibleBoundsUpdatedEvent theEvent)
                          throws IOException,
                                 AutomationException

Notifies clients when the visible bounds is updated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

visibleBoundsUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deviceFrameUpdated

public void deviceFrameUpdated(ITransformEventsDeviceFrameUpdatedEvent theEvent)
                        throws IOException,
                               AutomationException

Notifies clients when the device frame is updated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deviceFrameUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resolutionUpdated

public void resolutionUpdated(ITransformEventsResolutionUpdatedEvent theEvent)
                       throws IOException,
                              AutomationException

Notifies clients when the resolution is updated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

resolutionUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

rotationUpdated

public void rotationUpdated(ITransformEventsRotationUpdatedEvent theEvent)
                     throws IOException,
                            AutomationException

Notifies clients when the rotation angle is updated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

rotationUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

unitsUpdated

public void unitsUpdated(ITransformEventsUnitsUpdatedEvent theEvent)
                  throws IOException,
                         AutomationException

Notifies clients when the units are updated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

unitsUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.