com.esri.arcgis.carto
Class SelectionEnvironment

java.lang.Object
  com.esri.arcgis.carto.SelectionEnvironment

All Implemented Interfaces:

ISelectionEnvironment, ISelectionEnvironmentLayer, ISelectionEnvironmentStorage, ISelectionEnvironmentSymbols, ISelectionEnvironmentThreshold, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class SelectionEnvironment
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ISelectionEnvironment, ISelectionEnvironmentThreshold, ISelectionEnvironmentStorage, ISelectionEnvironmentLayer, ISelectionEnvironmentSymbols, IPersistStream, IPersist, java.io.Externalizable

COM Class 'SelectionEnvironment'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'Defines the feature selection environment.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.carto.ISelectionEnvironment

IID, IIDe3875b6f_d9f5_11d1_add4_080009ec732a, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ISelectionEnvironmentThreshold

IID, IIDb7b1e910_f760_11d3_adf3_00c04fa33a15, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ISelectionEnvironmentStorage

IID, IIDa231c0e1_0bdb_11d4_9fea_00c04f6bc78e, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ISelectionEnvironmentLayer

IID, IIDdabac83c_3313_11d4_9ff4_00c04f6bc78e, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ISelectionEnvironmentSymbols

IID, IID94a0324e_499d_4886_ab4d_02560cccbbf7, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Constructor Summary

SelectionEnvironment()
Constructs a SelectionEnvironment using ArcGIS Engine.

SelectionEnvironment(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SelectionEnvironment theSelectionEnvironment = (SelectionEnvironment) obj;

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
double	getAreaSearchDistance() Distance used for selecting areas by proximity.
int	getAreaSelectionMethod() Selection method used for areas.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
int	getCombinationMethod() Combination method for the selection results.
IColor	getDefaultColor() Default selection color.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
double	getLinearSearchDistance() Distance used for selecting lines by proximity.
int	getLinearSelectionMethod() Selection method used for lines.
double	getPointSearchDistance() Distance used for selecting points by proximity.
int	getPointSelectionMethod() Selection method used for points.
int	getSearchTolerance() Search tolerance in device units.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getWarningThreshold() Threshold (number of records), above which selection warnings may be shown.
int	hashCode() the hashcode for this object
boolean	isClearInvisibleLayers() Indicates if invisible layers have their selections cleared when a new selection is made.
void	isDirty() isDirty
boolean	isSaveSelections() Indicates if objects save their selections.
boolean	isScaleSelectionSymbols() Indicates if selection symbols should be scaled based on the reference scale.
boolean	isShowSelectionWarning() Indicates if warnings are displayed when the record count exceeds the selection warning threshold.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a SelectionEnvironment.
void	save(IStream pstm, int fClearDirty) save
void	setAreaSearchDistance(double distance) Distance used for selecting areas by proximity.
void	setAreaSelectionMethod(int method) Selection method used for areas.
void	setClearInvisibleLayers(boolean clearInvisible) Indicates if invisible layers have their selections cleared when a new selection is made.
void	setCombinationMethod(int method) Combination method for the selection results.
void	setDefaultColorByRef(IColor color) Default selection color.
void	setLinearSearchDistance(double distance) Distance used for selecting lines by proximity.
void	setLinearSelectionMethod(int method) Selection method used for lines.
void	setPointSearchDistance(double distance) Distance used for selecting points by proximity.
void	setPointSelectionMethod(int method) Selection method used for points.
void	setSaveSelections(boolean saveSel) Indicates if objects save their selections.
void	setScaleSelectionSymbols(boolean scale) Indicates if selection symbols should be scaled based on the reference scale.
void	setSearchTolerance(int tolerance) Search tolerance in device units.
void	setShowSelectionWarning(boolean showWarning) Indicates if warnings are displayed when the record count exceeds the selection warning threshold.
void	setWarningThreshold(int threshold) Threshold (number of records), above which selection warnings may be shown.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

SelectionEnvironment

public SelectionEnvironment()
                     throws java.io.IOException,
                            java.net.UnknownHostException

Constructs a SelectionEnvironment using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

SelectionEnvironment

public SelectionEnvironment(java.lang.Object obj)
                     throws java.io.IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a SelectionEnvironment.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getPointSelectionMethod

public int getPointSelectionMethod()
                            throws java.io.IOException,
                                   AutomationException

Selection method used for points.

Specified by:

getPointSelectionMethod in interface ISelectionEnvironment

Returns:

A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPointSelectionMethod

public void setPointSelectionMethod(int method)
                             throws java.io.IOException,
                                    AutomationException

Selection method used for points.

Specified by:

setPointSelectionMethod in interface ISelectionEnvironment

Parameters:

method - A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPointSearchDistance

public double getPointSearchDistance()
                              throws java.io.IOException,
                                     AutomationException

Distance used for selecting points by proximity.

Specified by:

getPointSearchDistance in interface ISelectionEnvironment

Returns:

The distance

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPointSearchDistance

public void setPointSearchDistance(double distance)
                            throws java.io.IOException,
                                   AutomationException

Distance used for selecting points by proximity.

Specified by:

setPointSearchDistance in interface ISelectionEnvironment

Parameters:

distance - The distance (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLinearSelectionMethod

public int getLinearSelectionMethod()
                             throws java.io.IOException,
                                    AutomationException

Selection method used for lines.

Specified by:

getLinearSelectionMethod in interface ISelectionEnvironment

Returns:

A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLinearSelectionMethod

public void setLinearSelectionMethod(int method)
                              throws java.io.IOException,
                                     AutomationException

Selection method used for lines.

Specified by:

setLinearSelectionMethod in interface ISelectionEnvironment

Parameters:

method - A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLinearSearchDistance

public double getLinearSearchDistance()
                               throws java.io.IOException,
                                      AutomationException

Distance used for selecting lines by proximity.

Specified by:

getLinearSearchDistance in interface ISelectionEnvironment

Returns:

The distance

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLinearSearchDistance

public void setLinearSearchDistance(double distance)
                             throws java.io.IOException,
                                    AutomationException

Distance used for selecting lines by proximity.

Specified by:

setLinearSearchDistance in interface ISelectionEnvironment

Parameters:

distance - The distance (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAreaSelectionMethod

public int getAreaSelectionMethod()
                           throws java.io.IOException,
                                  AutomationException

Selection method used for areas.

Specified by:

getAreaSelectionMethod in interface ISelectionEnvironment

Returns:

A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAreaSelectionMethod

public void setAreaSelectionMethod(int method)
                            throws java.io.IOException,
                                   AutomationException

Selection method used for areas.

Specified by:

setAreaSelectionMethod in interface ISelectionEnvironment

Parameters:

method - A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAreaSearchDistance

public double getAreaSearchDistance()
                             throws java.io.IOException,
                                    AutomationException

Distance used for selecting areas by proximity.

Specified by:

getAreaSearchDistance in interface ISelectionEnvironment

Returns:

The distance

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAreaSearchDistance

public void setAreaSearchDistance(double distance)
                           throws java.io.IOException,
                                  AutomationException

Distance used for selecting areas by proximity.

Specified by:

setAreaSearchDistance in interface ISelectionEnvironment

Parameters:

distance - The distance (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCombinationMethod

public int getCombinationMethod()
                         throws java.io.IOException,
                                AutomationException

Combination method for the selection results.

Specified by:

getCombinationMethod in interface ISelectionEnvironment

Returns:

A com.esri.arcgis.carto.esriSelectionResultEnum constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCombinationMethod

public void setCombinationMethod(int method)
                          throws java.io.IOException,
                                 AutomationException

Combination method for the selection results.

Specified by:

setCombinationMethod in interface ISelectionEnvironment

Parameters:

method - A com.esri.arcgis.carto.esriSelectionResultEnum constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSearchTolerance

public int getSearchTolerance()
                       throws java.io.IOException,
                              AutomationException

Search tolerance in device units.

Specified by:

getSearchTolerance in interface ISelectionEnvironment

Returns:

The tolerance

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSearchTolerance

public void setSearchTolerance(int tolerance)
                        throws java.io.IOException,
                               AutomationException

Search tolerance in device units.

Specified by:

setSearchTolerance in interface ISelectionEnvironment

Parameters:

tolerance - The tolerance (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultColor

public IColor getDefaultColor()
                       throws java.io.IOException,
                              AutomationException

Default selection color.

Specified by:

getDefaultColor in interface ISelectionEnvironment

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultColorByRef

public void setDefaultColorByRef(IColor color)
                          throws java.io.IOException,
                                 AutomationException

Default selection color.

Specified by:

setDefaultColorByRef in interface ISelectionEnvironment

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowSelectionWarning

public boolean isShowSelectionWarning()
                               throws java.io.IOException,
                                      AutomationException

Indicates if warnings are displayed when the record count exceeds the selection warning threshold.

Specified by:

isShowSelectionWarning in interface ISelectionEnvironmentThreshold

Returns:

The showWarning

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowSelectionWarning

public void setShowSelectionWarning(boolean showWarning)
                             throws java.io.IOException,
                                    AutomationException

Indicates if warnings are displayed when the record count exceeds the selection warning threshold.

Specified by:

setShowSelectionWarning in interface ISelectionEnvironmentThreshold

Parameters:

showWarning - The showWarning (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWarningThreshold

public int getWarningThreshold()
                        throws java.io.IOException,
                               AutomationException

Threshold (number of records), above which selection warnings may be shown.

Specified by:

getWarningThreshold in interface ISelectionEnvironmentThreshold

Returns:

The threshold

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWarningThreshold

public void setWarningThreshold(int threshold)
                         throws java.io.IOException,
                                AutomationException

Threshold (number of records), above which selection warnings may be shown.

Specified by:

setWarningThreshold in interface ISelectionEnvironmentThreshold

Parameters:

threshold - The threshold (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSaveSelections

public boolean isSaveSelections()
                         throws java.io.IOException,
                                AutomationException

Indicates if objects save their selections.

Specified by:

isSaveSelections in interface ISelectionEnvironmentStorage

Returns:

The saveSel

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSaveSelections

public void setSaveSelections(boolean saveSel)
                       throws java.io.IOException,
                              AutomationException

Indicates if objects save their selections.

Specified by:

setSaveSelections in interface ISelectionEnvironmentStorage

Parameters:

saveSel - The saveSel (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isClearInvisibleLayers

public boolean isClearInvisibleLayers()
                               throws java.io.IOException,
                                      AutomationException

Indicates if invisible layers have their selections cleared when a new selection is made.

Specified by:

isClearInvisibleLayers in interface ISelectionEnvironmentLayer

Returns:

The clearInvisible

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClearInvisibleLayers

public void setClearInvisibleLayers(boolean clearInvisible)
                             throws java.io.IOException,
                                    AutomationException

Indicates if invisible layers have their selections cleared when a new selection is made.

Specified by:

setClearInvisibleLayers in interface ISelectionEnvironmentLayer

Parameters:

clearInvisible - The clearInvisible (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isScaleSelectionSymbols

public boolean isScaleSelectionSymbols()
                                throws java.io.IOException,
                                       AutomationException

Indicates if selection symbols should be scaled based on the reference scale.

Specified by:

isScaleSelectionSymbols in interface ISelectionEnvironmentSymbols

Returns:

The scale

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setScaleSelectionSymbols

public void setScaleSelectionSymbols(boolean scale)
                              throws java.io.IOException,
                                     AutomationException

Indicates if selection symbols should be scaled based on the reference scale.

Specified by:

setScaleSelectionSymbols in interface ISelectionEnvironmentSymbols

Parameters:

scale - The scale (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException