com.esri.arcgis.arcmapui
Class ElementSelection

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

All Implemented Interfaces:

IEnumElement, ISelection, IConnectionPointContainer, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ElementSelection
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISelection, IEnumElement, IConnectionPointContainer

Maintains the the graphic element selection.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

ElementSelection()
Constructs a ElementSelection using ArcGIS Engine.

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

Method Summary

void	addISelectionEventsListener(ISelectionEvents theListener) addISelectionEventsListener.
boolean	canClear() Indicates if the selection can be cleared.
boolean	canCopy() Indicates if the selection can be copied.
boolean	canCut() Indicates if the selection can be cut.
boolean	canPaste() Indicates if paste is supported.
boolean	canSelectAll() Indicates if there's something to select.
void	clear() Clears all items in the selection.
void	copy() Copy the selected items to the clipboard.
void	cut() Cut the selected items to the clipboard.
void	draw(IDisplay display, ITrackCancel cancelTracker) Draw the selected items.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(Object o) Compare this object with another
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
static String	getClsid() getClsid.
int	hashCode() the hashcode for this object
IElement	next() Returns the next element in the enumeration.
void	paste() Paste clipboard contents.
void	removeISelectionEventsListener(ISelectionEvents theListener) removeISelectionEventsListener.
void	reset() Start the enumeration at the beginning.
void	selectAll() Selects all items.

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

ElementSelection

public ElementSelection()
                 throws IOException,
                        UnknownHostException

Constructs a ElementSelection using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ElementSelection

public ElementSelection(Object obj)
                 throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems ElementSelection theElementSelection = (ElementSelection) 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

addISelectionEventsListener

public void addISelectionEventsListener(ISelectionEvents theListener)
                                 throws IOException

addISelectionEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.carto.ISelectionEvents interface.

Throws:

IOException - If there are communications problems.

removeISelectionEventsListener

public void removeISelectionEventsListener(ISelectionEvents theListener)
                                    throws IOException

removeISelectionEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.carto.ISelectionEvents interface.

Throws:

IOException - If there are communications problems.

canCut

public boolean canCut()
               throws IOException,
                      AutomationException

Indicates if the selection can be cut.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

canCut in interface ISelection

Returns:

The result

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canCopy

public boolean canCopy()
                throws IOException,
                       AutomationException

Indicates if the selection can be copied.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

canCopy in interface ISelection

Returns:

The result

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canPaste

public boolean canPaste()
                 throws IOException,
                        AutomationException

Indicates if paste is supported.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

canPaste in interface ISelection

Returns:

The result

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canClear

public boolean canClear()
                 throws IOException,
                        AutomationException

Indicates if the selection can be cleared.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

canClear in interface ISelection

Returns:

The result

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canSelectAll

public boolean canSelectAll()
                     throws IOException,
                            AutomationException

Indicates if there's something to select.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

canSelectAll in interface ISelection

Returns:

The result

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

cut

public void cut()
         throws IOException,
                AutomationException

Cut the selected items to the clipboard.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

cut in interface ISelection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

copy

public void copy()
          throws IOException,
                 AutomationException

Copy the selected items to the clipboard.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

copy in interface ISelection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

paste

public void paste()
           throws IOException,
                  AutomationException

Paste clipboard contents.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

paste in interface ISelection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clear

public void clear()
           throws IOException,
                  AutomationException

Clears all items in the selection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

clear in interface ISelection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

selectAll

public void selectAll()
               throws IOException,
                      AutomationException

Selects all items.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

selectAll in interface ISelection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

draw

public void draw(IDisplay display,
                 ITrackCancel cancelTracker)
          throws IOException,
                 AutomationException

Draw the selected items.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

draw in interface ISelection

Parameters:

display - A reference to a com.esri.arcgis.display.IDisplay (in)

cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

next

public IElement next()
              throws IOException,
                     AutomationException

Returns the next element in the enumeration.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

next in interface IEnumElement

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException

Start the enumeration at the beginning.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

reset in interface IEnumElement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws IOException,
                                 AutomationException

enumConnectionPoints

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws IOException,
                                AutomationException

findConnectionPoint

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

findConnectionPoint in interface IConnectionPointContainer

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.