com.esri.arcgis.arcmapui
Class AddLayersOperation

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

All Implemented Interfaces:

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

public class AddLayersOperation
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IOperation, IAddLayersOperation

Add Layers Operation.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

AddLayersOperation()
Constructs a AddLayersOperation using ArcGIS Engine.

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

Method Summary

void	addLayer(ILayer layer) Layer to be added.
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	setArrangeLayers(boolean rhs1) A Boolean expression that represents whether the layers need to arranged as per their shape.
void	setDestinationInfo(int atIndex, IMap pDestinationMap, Object pDestinationGroup) Information regarding where the the layer needs to be added.
void	setName(String rhs1) Name of the the operation.
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

AddLayersOperation

public AddLayersOperation()
                   throws IOException,
                          UnknownHostException

Constructs a AddLayersOperation using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

AddLayersOperation

public AddLayersOperation(Object obj)
                   throws IOException

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

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

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.

addLayer

public void addLayer(ILayer layer)
              throws IOException,
                     AutomationException

Layer to be added.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

addLayer in interface IAddLayersOperation

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDestinationInfo

public void setDestinationInfo(int atIndex,
                               IMap pDestinationMap,
                               Object pDestinationGroup)
                        throws IOException,
                               AutomationException

Information regarding where the the layer needs to be added. pDestination can be a Map or a GroupLayer.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setDestinationInfo in interface IAddLayersOperation

Parameters:

atIndex - The atIndex (in)

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

pDestinationGroup - A reference to another Object (IUnknown) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setArrangeLayers

public void setArrangeLayers(boolean rhs1)
                      throws IOException,
                             AutomationException

A Boolean expression that represents whether the layers need to arranged as per their shape.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setArrangeLayers in interface IAddLayersOperation

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String rhs1)
             throws IOException,
                    AutomationException

Name of the the operation.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setName in interface IAddLayersOperation

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.