com.esri.arcgis.carto
Interface IExtentStack

All Superinterfaces:
Serializable
All Known Implementing Classes:
IExtentStackProxy

public interface IExtentStack
extends Serializable

Provides access to members that control the extent stack.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 boolean canRedo()
          Indicates if there is an extent that can be redone.
 boolean canUndo()
          Indicates if there is an extent that can be undone.
 void esri_do(IEnvelope extent)
          Zooms to the given extent and places it on the stack.
 int getCount()
          The number of extents on the stack.
 IEnvelope getItem(int index)
          The extent at the specified index.
 void redo()
          Redo the next extent on the stack.
 void reset()
          Removes all extents from the stack.
 void undo()
          Undo the previous extent on the stack.
 

Method Detail

getCount

int getCount()
             throws IOException,
                    AutomationException
The number of extents on the stack.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getItem

IEnvelope getItem(int index)
                  throws IOException,
                         AutomationException
The extent at the specified index.

Product Availability

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

Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reset

void reset()
           throws IOException,
                  AutomationException
Removes all extents from the stack.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_do

void esri_do(IEnvelope extent)
             throws IOException,
                    AutomationException
Zooms to the given extent and places it on the stack.

Product Availability

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

Parameters:
extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

undo

void undo()
          throws IOException,
                 AutomationException
Undo the previous extent on the stack.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

redo

void redo()
          throws IOException,
                 AutomationException
Redo the next extent on the stack.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canUndo

boolean canUndo()
                throws IOException,
                       AutomationException
Indicates if there is an extent that can be undone.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The canUndo
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canRedo

boolean canRedo()
                throws IOException,
                       AutomationException
Indicates if there is an extent that can be redone.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The canRedo
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.