com.esri.arcgis.carto
Interface ILayer2

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

BasemapSubLayer, CadAnnotationLayer, CadastralFabricSubLayer, CadFeatureLayer, CompositeGraphicsLayer, CoverageAnnotationLayer, DimensionLayer, FDOGraphicsLayer, FeatureLayer, GdbRasterCatalogLayer, GroupLayer, ILayer2Proxy, IMSSubLayer, MapServerRESTSubLayer, MosaicLayer, NALayer, NetworkLayer, ProcessLayer, RasterBasemapLayer, RasterCatalogLayer, RasterLayer, SchematicLayer, TemporalFeatureLayer, WMSGroupLayer

public interface ILayer2
extends java.io.Serializable

COM Interface 'ILayer2'. Generated 3/19/2015 1:20:52 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to additional members that work with all layers.' 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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID599dee2e_2182_4e54_8a86_725145c9d989
static int	xxDummy Deprecated. Internal use only

Method Summary

void	draw(int drawPhase, IDisplay display, ITrackCancel trackCancel) Draws the layer to the specified display for the given draw phase.
IEnvelope	getAreaOfInterest() The default area of interest for the layer.
double	getMaximumScale() Maximum scale (representative fraction) at which the layer will display.
double	getMinimumScale() Minimum scale (representative fraction) at which the layer will display.
java.lang.String	getName() Layer name.
int	getSupportedDrawPhases() Supported draw phases.
java.lang.String	getTipText(double x, double y, double tolerance) Map tip text at the specified location.
boolean	isCached() Indicates if the layer needs its own display cache.
boolean	isScaleRangeReadOnly() Indicates if the minimum and maximum scale range values are read-only.
boolean	isShowTips() Indicates if the layer shows map tips.
boolean	isValid() Indicates if the layer is currently valid.
boolean	isVisible() Indicates if the layer is currently visible.
void	setAreaOfInterest(IEnvelope aoi) The default area of interest for the layer.
void	setCached(boolean cached) Indicates if the layer needs its own display cache.
void	setMaximumScale(double maxScale) Maximum scale (representative fraction) at which the layer will display.
void	setMinimumScale(double minScale) Minimum scale (representative fraction) at which the layer will display.
void	setName(java.lang.String name) Layer name.
void	setShowTips(boolean show) Indicates if the layer shows map tips.
void	setSpatialReferenceByRef(ISpatialReference rhs1) Spatial reference for the layer.
void	setVisible(boolean visible) Indicates if the layer is currently visible.

Field Detail

IID599dee2e_2182_4e54_8a86_725145c9d989

static final int IID599dee2e_2182_4e54_8a86_725145c9d989

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

Layer name.

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

Layer name.

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isValid

boolean isValid()
                throws java.io.IOException,
                       AutomationException

Indicates if the layer is currently valid.

Returns:

The valid

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAreaOfInterest

IEnvelope getAreaOfInterest()
                            throws java.io.IOException,
                                   AutomationException

The default area of interest for the layer.

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinimumScale

double getMinimumScale()
                       throws java.io.IOException,
                              AutomationException

Minimum scale (representative fraction) at which the layer will display.

Returns:

The minScale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinimumScale

void setMinimumScale(double minScale)
                     throws java.io.IOException,
                            AutomationException

Minimum scale (representative fraction) at which the layer will display.

Parameters:

minScale - The minScale (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaximumScale

double getMaximumScale()
                       throws java.io.IOException,
                              AutomationException

Maximum scale (representative fraction) at which the layer will display.

Returns:

The maxScale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaximumScale

void setMaximumScale(double maxScale)
                     throws java.io.IOException,
                            AutomationException

Maximum scale (representative fraction) at which the layer will display.

Parameters:

maxScale - The maxScale (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isVisible

boolean isVisible()
                  throws java.io.IOException,
                         AutomationException

Indicates if the layer is currently visible.

Returns:

The visible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVisible

void setVisible(boolean visible)
                throws java.io.IOException,
                       AutomationException

Indicates if the layer is currently visible.

Parameters:

visible - The visible (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowTips

boolean isShowTips()
                   throws java.io.IOException,
                          AutomationException

Indicates if the layer shows map tips.

Returns:

The show

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowTips

void setShowTips(boolean show)
                 throws java.io.IOException,
                        AutomationException

Indicates if the layer shows map tips.

Parameters:

show - The show (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTipText

java.lang.String getTipText(double x,
                            double y,
                            double tolerance)
                            throws java.io.IOException,
                                   AutomationException

Map tip text at the specified location.

Parameters:

x - The x (in)

y - The y (in)

tolerance - The tolerance (in)

Returns:

The text

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCached

boolean isCached()
                 throws java.io.IOException,
                        AutomationException

Indicates if the layer needs its own display cache.

Returns:

The cached

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCached

void setCached(boolean cached)
               throws java.io.IOException,
                      AutomationException

Indicates if the layer needs its own display cache.

Parameters:

cached - The cached (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSupportedDrawPhases

int getSupportedDrawPhases()
                           throws java.io.IOException,
                                  AutomationException

Supported draw phases.

Returns:

The drawPhases

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

void setSpatialReferenceByRef(ISpatialReference rhs1)
                              throws java.io.IOException,
                                     AutomationException

Spatial reference for the layer.

Parameters:

rhs1 - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

draw

void draw(int drawPhase,
          IDisplay display,
          ITrackCancel trackCancel)
          throws java.io.IOException,
                 AutomationException

Draws the layer to the specified display for the given draw phase.

Parameters:

drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isScaleRangeReadOnly

boolean isScaleRangeReadOnly()
                             throws java.io.IOException,
                                    AutomationException

Indicates if the minimum and maximum scale range values are read-only.

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAreaOfInterest

void setAreaOfInterest(IEnvelope aoi)
                       throws java.io.IOException,
                              AutomationException

The default area of interest for the layer.

Parameters:

aoi - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.