com.esri.arcgis.arcmapui
Class MoveLayersOperation

java.lang.Object
  com.esri.arcgis.arcmapui.MoveLayersOperation

All Implemented Interfaces:

IMoveLayersOperation, com.esri.arcgis.interop.RemoteObjRef, IOperation, Serializable

public class MoveLayersOperation
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IOperation, IMoveLayersOperation

Move Layers Operation.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

MoveLayersOperation()
Constructs a MoveLayersOperation using ArcGIS Engine.

MoveLayersOperation(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MoveLayersOperation theMoveLayersOperation = (MoveLayersOperation) obj;

Method Summary

void	addLayerInfo(ILayer layer, IMap pSourceMap, IGroupLayer pSourceGroup) Information of the layer to be moved.
boolean	equals(Object o) Compare this object with another
void	esri_do() Performs the operation.
static String	getClsid() getClsid.
String	getMenuString() The menu string.
int	hashCode() the hashcode for this object
boolean	isCanRedo() Indicates if the operation can be redone.
boolean	isCanUndo() Indicates if the operation can be undone.
void	redo() Redoes the operation.
void	setDestinationInfo(int toIndex, IMap pDestinationMap, IGroupLayer pDestinationGroup) Information regarding where the the layer needs to be moved.
void	undo() Undoes the operation.

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

MoveLayersOperation

public MoveLayersOperation()
                    throws IOException,
                           UnknownHostException

Constructs a MoveLayersOperation using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

MoveLayersOperation

public MoveLayersOperation(Object obj)
                    throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MoveLayersOperation theMoveLayersOperation = (MoveLayersOperation) obj;

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

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

getMenuString

public String getMenuString()
                     throws IOException,
                            AutomationException

The menu string.

Description

The MenuString associated with the Operation. This is used by the application framework to populate the Edit menu in ArcMap. For example, adding a layer to ArcMap adds the menu string of the Operation "Undo Add Layers(s)" to the Edit menu.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMenuString in interface IOperation

Returns:

The text

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanUndo

public boolean isCanUndo()
                  throws IOException,
                         AutomationException

Indicates if the operation can be undone.

Description

CanUndo indicates if the operation can be un-done. Use the property before using the Undo method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isCanUndo in interface IOperation

Returns:

The result

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanRedo

public boolean isCanRedo()
                  throws IOException,
                         AutomationException

Indicates if the operation can be redone.

Description

CanRedo indicates if the operation can be re-done. Use the property before using the Redo method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isCanRedo in interface IOperation

Returns:

The result

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_do

public void esri_do()
             throws IOException,
                    AutomationException

Performs the operation.

Product Availability

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

Specified by:

esri_do in interface IOperation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

undo

public void undo()
          throws IOException,
                 AutomationException

Undoes the operation.

Description

Undo the operation to reset the action from the Do method. Use the CanUndo property to determine whether the operation can be un-done.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

undo in interface IOperation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

redo

public void redo()
          throws IOException,
                 AutomationException

Redoes the operation.

Description

Redo the operation to redo the action from the Do method. Use the CanRedo property to determine whether the operation can be re-done.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

redo in interface IOperation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addLayerInfo

public void addLayerInfo(ILayer layer,
                         IMap pSourceMap,
                         IGroupLayer pSourceGroup)
                  throws IOException,
                         AutomationException

Information of the layer to be moved. Source group is NULL if the layer belongs to a map. This method can be called repeatedly until all the layers are added.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

addLayerInfo in interface IMoveLayersOperation

Parameters:

layer - A reference to a com.esri.arcgis.carto.ILayer (in)

pSourceMap - A reference to a com.esri.arcgis.carto.IMap (in)

pSourceGroup - A reference to a com.esri.arcgis.carto.IGroupLayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDestinationInfo

public void setDestinationInfo(int toIndex,
                               IMap pDestinationMap,
                               IGroupLayer pDestinationGroup)
                        throws IOException,
                               AutomationException

Information regarding where the the layer needs to be moved. Destination group is NULL if the layer is bing moved to into a map.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setDestinationInfo in interface IMoveLayersOperation

Parameters:

toIndex - The toIndex (in)

pDestinationMap - A reference to a com.esri.arcgis.carto.IMap (in)

pDestinationGroup - A reference to a com.esri.arcgis.carto.IGroupLayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.