com.esri.arcgis.carto
Class MapServerLayer

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

All Implemented Interfaces:

ICompositeLayer, ICompositeLayer2, IDataLayer, IHTMLPopupIdentify, IHTMLPopupIdentify2, IHTMLPopupInfo, IHTMLPopupInfo2, IIdentify, IIdentify2, IIdentifyDisplay, IIdentifyGroup, ILayer, ILayerDrawingProperties, ILayerEffects, ILayerExtensions, ILayerGeneralProperties, ILayerInfo, ILayerPosition, ILayerStatus, ILayerSymbologyExtents, IMapServerGroupLayer, IMapServerLayer, IPublishLayer, ISecureLayer, ISecureLayer2, IServiceLayerImageFormat, ITimeData, ITimeData2, ITimeDataDisplay, IRasterResamplingControl, IConnectionPointContainer, IDisplayAdmin, IDisplayAdmin2, IGeoDataset, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class MapServerLayer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ILayer, IMapServerLayer, ICompositeLayer, ICompositeLayer2, IMapServerGroupLayer, IGeoDataset, IPersistStream, ILayerPosition, IDisplayAdmin, IDisplayAdmin2, ILayerDrawingProperties, ILayerEffects, ILayerInfo, ILayerStatus, IPublishLayer, IIdentify, IIdentify2, IIdentifyGroup, ILayerGeneralProperties, ILayerSymbologyExtents, IDataLayer, ILayerExtensions, ISecureLayer, ISecureLayer2, IRasterResamplingControl, IConnectionPointContainer, IServiceLayerImageFormat, IIdentifyDisplay, IHTMLPopupInfo, IHTMLPopupInfo2, IHTMLPopupIdentify, IHTMLPopupIdentify2, ITimeData, ITimeData2, ITimeDataDisplay, java.io.Externalizable

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

Description 'Provides programmatic access to a map server layer.' 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.IMapServerLayer

IID, IIDe9b56157_7eb7_4db3_9958_afbf3b5e1470, xxDummy

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

IID, IIDba119bc4_939a_11d2_a2f4_080009b6f22b, xxDummy

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

IID, IID88130d17_5762_453a_96cf_8e7503fa1aa0, xxDummy

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

IID, IIDc2bb4d11_0dfd_4e0f_bedc_3091e6d6d11e, 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

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

IID, IIDc0dc8820_e10f_4285_aab1_6c6b685dbb84, xxDummy

Fields inherited from interface com.esri.arcgis.display.IDisplayAdmin

IID, IID12e361f0_1907_11d3_80c7_0080c79f0371, xxDummy

Fields inherited from interface com.esri.arcgis.display.IDisplayAdmin2

IID, IIDd915ec07_7b4f_47fd_b59b_3252f3a3b610, xxDummy

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

IID, IID09998199_1fb8_11d3_ab4e_000000000000, xxDummy

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

IID, IID274419e1_0f5c_11d3_9bfd_00c04f5b951e, xxDummy

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

IID, IIDed4721d6_3e0d_4110_9324_8cce8d2801ef, xxDummy

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

IID, IID7453c805_9d64_44a6_bf2f_73e477dce18f, xxDummy

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

IID, IID0483dc2f_8726_4640_98cd_5888ff1a4fa4, xxDummy

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

IID, IID543ecd8a_b231_4fd1_a114_3a69f983933e, xxDummy

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

IID, IID02cbda2f_d2e8_4b28_af9c_71cb096213e1, xxDummy

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

IID, IID6ca416b1_e160_11d2_9f4e_00c04f6bc78e, xxDummy

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

IID, IIDbb6a78ca_9c28_4f75_899f_dff65174082c, xxDummy

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

IID, IIDd047a6a9_d445_4921_a1e9_72d8b8a2813a, xxDummy

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

IID, IID67f66590_d48d_4c8d_b6c4_7e5f9fb009c7, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IRasterResamplingControl

IID, IIDdfef659c_012d_41ae_965d_5e1ec4841add, xxDummy

Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer

IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy

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

IID, IID6c6ce092_1ed4_4806_aabb_1ca6f0cb166e, xxDummy

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

IID, IID25188498_8a07_49f1_9fae_3aefb14c1778, xxDummy

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

IID, IID742678bc_aff5_41da_a523_36a8bd4e2c8b, xxDummy

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

IID, IID8a038cdb_0430_40d9_b8ce_8b055f11d511, xxDummy

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

IID, IID095cdd1a_fe17_4719_9072_15f303f82e69, xxDummy

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

IID, IID8cc24376_c6e0_4ae0_8561_17fa049aee03, xxDummy

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

IID, IID6308f920_d4ef_4e5f_b0fc_7a63ed132b27, xxDummy

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

IID008331d0_1225_4fe7_ad19_c3431625d337

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

IID, IIDf12874c3_3358_40a5_8e32_c824dd1d75fa, xxDummy

Constructor Summary

MapServerLayer()
Constructs a MapServerLayer using ArcGIS Engine.

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

Method Summary

void	addExtension(java.lang.Object ext) Adds a new extension.
void	addILayerEventsListener(ILayerEvents theListener) addILayerEventsListener.
void	clearDrawCache() Clears the cache of images downloaded from the server redraw.
void	clearPassword(boolean bForceReconnect) Removes the passwords from the layer used to access data, and forces a reconnection to the data.
boolean	connect(IName pOptRepairName) Connects the layer to its data source.
void	draw(int drawPhase, IDisplay display, ITrackCancel trackCancel) Draws the layer to the specified display for the given draw phase.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(java.lang.Object o) Compare this object with another
void	expandRegionForSymbols(IDisplay pDisplay, IGeometry pRegion) Enlarges the specified region if necessary to account for the symbology sizes.
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
IEnvelope	getAreaOfInterest() The default area of interest for the layer.
IColor	getBackgroundColor() The background color of a map server layer object.
short	getBrightness() Layer brightness in percent (-100 - 100).
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
void	getConnectionInfo(IAGSServerObjectName[] soName, java.lang.String[] docLocation, java.lang.String[] mapName) Returns information about a connection to a map server object or to a map document.
short	getContrast() Layer contrast in percent (-100 - 100).
int	getCount() Number of layers in the collection.
java.lang.String	getDataDetails(java.lang.String bsPadding) Details of the layer's data.
IName	getDataSourceName() Name of the data object for the layer.
java.lang.Object	getExtension(int index) The extension at the specified index.
int	getExtensionCount() Number of extensions.
IEnvelope	getExtent() The extent of the GeoDataset.
ITimeExtent	getFullTimeExtent() Returns the time extent for all the data in the layer.
java.lang.String	getHTMLOutput(IFeature pFeature) The content is the XML text for the input feature.
int	getHTMLPresentationStyle() Indicates the content formating style for the HTML Popup tool.
java.lang.String	getHTMLRedirectField() Indicates the fieldname of the layer that contains the HTML redirect URL values.
java.lang.String	getHTMLRedirectFieldPrefix() Indicates the text to precede the HTMLRedirectField value for the redirect URL.
java.lang.String	getHTMLRedirectFieldSuffix() Indicates the text to follow the HTMLRedirectField value for the redirect URL.
java.lang.String	getHTMLXSLStylesheet() Indicates the content of the XSL stylesheet to parse the feature attributes through.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	getLargeImage() Large image that represents the layer.
int	getLargeSelectedImage() Large image that represents the layer when it is selected.
double	getLastMaximumScale() Last maximum scale setting used by layer.
double	getLastMinimumScale() Last minimum scale setting used by layer.
ILayer	getLayer(int index) Layer in the collection at the specified index.
double	getLayerWeight() Default layer position.
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.
java.lang.String	getPublishingDescription() The layer description reported to the publisher.
java.lang.String	getRelativeBase() Base path used when storing relative path names.
int	getRequestedImageType() The image type requested.
int	getResamplingHint() The raster resampling hint.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getSmallImage() Small image that represents the layer.
int	getSmallSelectedImage() Small image that represents the layer when it is selected.
ISpatialReference	getSpatialReference() The spatial reference of the GeoDataset.
int	getSupportedDrawPhases() Supported draw phases.
int	getSupportedImageFormat(int index) The individual output image format supported by Server.
int	getSupportedImageFormatCount() The number of output image format supported by Server.
double	getTimeInterval() Returns recommended time interval to be used to animate this layer/ table.
int	getTimeIntervalUnits() Returns recommended time interval units to be used to animate this layer/ table.
double	getTimeOffset() Returns time offset that needs to be applied to the data for drawing.
int	getTimeOffsetUnits() Returns recommended time interval units to be used to animate this layer/ table.
ITimeReference	getTimeReference() Time reference for the contents of the layer.
java.lang.String	getTipText(double x, double y, double tolerance) Map tip text at the specified location.
short	getTransparency() Layer transparency in percent (0-100).
IColor	getTransparentColor() The color that is transparent (100 %).
int	hashCode() the hashcode for this object
void	hTMLIdentify(IDisplay pDisplay, IGeometry pGeometry, IPropertySet pOptions, IStringArray[] ppItemNames, IStringArray[] ppItemHTML) The content is the XML text at the specified point.
java.lang.String	hTMLIdentify(IPoint pPoint, double tolerance) The content is the XML text at the specified point.
java.lang.String	hTMLOutput(IFeature pFeature, IPropertySet pOptions) The content is the XML text for the input feature, pOptions is an optional parameter.
java.lang.String	hTMLTipText(IPoint pPoint, double tolerance) The tooltip at the specified point.
IArray	identify(IGeometry pGeom) Identifies objects at the specified location.
IArray	identify(IGeometry pGeom, ITrackCancel pTrackCancel) Identifies objects at the specified location.
IArray	identifyEx(IDisplay pDisplay, IGeometry pGeom, ITrackCancel pTrackCancel) Identifies objects at the specified location for the given display.
java.lang.String	ILayerGeneralProperties_getLayerDescription() Description for the layer.
boolean	isCached() Indicates if the layer needs its own display cache.
boolean	isDataSourceSupported(IName name) Indicates if the specified data object name is supported by the layer.
boolean	isDataValid() Indicates if the data for the layer is currently valid.
void	isDirty() isDirty
boolean	isDoesBlending() Indicates whether the drawing object blends its output with the background.
boolean	isDrawingPropsDirty() Indicates if the layer drawing properties are dirty.
boolean	isExpanded() Indicates if the layer is expanded in the TOC.
boolean	isHasAuthentication() Indicates if the layer is password protected.
boolean	isHasLiveData() isHasLiveData
boolean	isHTMLDownloadAttachmentData() Indicates that all data for attachments will be retrieved.
boolean	isHTMLHideFieldNameColumn() Indicates if Field name column will be output to the HTML Popup tool.
boolean	isHTMLPopupEnabled() Indicates if this layer currently responds to the HTML Popup tool.
boolean	isHTMLUseCodedDomainValues() Indicates whether to use coded values (rather than literal stored values) for feature values.
boolean	isRequiresBanding() Indicates whether the output from the drawing object requires banding.
boolean	isShowTips() Indicates if the layer shows map tips.
boolean	isSupportsBrightnessChange() Indicates if the layer supports brightness changes.
boolean	isSupportsContrastChange() Indicates if the layer supports contrast changes.
boolean	isSupportsInteractive() Indicates if the layer supports interactive effects changes.
boolean	isSupportsPublishing() Indicates if the layer supports the publishing process.
boolean	isSupportsTime() Indicates whether the layer has any time data.
boolean	isSupportsTransparency() Indicates if the layer supports transparency.
boolean	isTimeDataCumulative() Indicates that features will be animated cumilatively.
boolean	isUsesFilter() Indicates if the current object draws using a filter.
boolean	isUseTime() Indicates whether to use the time for animation purposes.
boolean	isValid() Indicates if the layer is currently valid.
boolean	isVisible() Indicates if the layer is currently visible.
void	load(IStream pstm) load
void	localConnect(java.lang.String docLocation, java.lang.String mapName) Connects to map document data frame specified by the location of a map document and the name of a data frame.
void	prepareForPublishing() Prepare the layer for the publishing process.
void	readExternal(java.io.ObjectInput in)
void	release() Release a MapServerLayer.
void	removeExtension(int index) Removes the specified extension.
void	removeILayerEventsListener(ILayerEvents theListener) removeILayerEventsListener.
void	save(IStream pstm, int fClearDirty) save
void	serverConnect(IAGSServerObjectName soName, java.lang.String mapName) Connects to map server object specified by the AGSServerObject name for a MapServer server object and the name of a data frame.
void	setBrightness(short brightnessValue) Layer brightness in percent (-100 - 100).
void	setCached(boolean cached) Indicates if the layer needs its own display cache.
void	setContrast(short contrastValue) Layer contrast in percent (-100 - 100).
void	setDataSourceName(IName name) Name of the data object for the layer.
void	setDrawingPropsDirty(boolean dirty) Indicates if the layer drawing properties are dirty.
void	setExpanded(boolean expanded) Indicates if the layer is expanded in the TOC.
void	setHasLiveData(boolean useTime) setHasLiveData
void	setHTMLDownloadAttachmentData(boolean pDownloadAttachmentData) Indicates that all data for attachments will be retrieved.
void	setHTMLHideFieldNameColumn(boolean pHide) Indicates if Field name column will be output to the HTML Popup tool.
void	setHTMLPopupEnabled(boolean pEnabled) Indicates if this layer currently responds to the HTML Popup tool.
void	setHTMLPresentationStyle(int pStyle) Indicates the content formating style for the HTML Popup tool.
void	setHTMLRedirectField(java.lang.String pField) Indicates the fieldname of the layer that contains the HTML redirect URL values.
void	setHTMLRedirectFieldPrefix(java.lang.String pPrefix) Indicates the text to precede the HTMLRedirectField value for the redirect URL.
void	setHTMLRedirectFieldSuffix(java.lang.String pSufix) Indicates the text to follow the HTMLRedirectField value for the redirect URL.
void	setHTMLUseCodedDomainValues(boolean pCodedValues) Indicates whether to use coded values (rather than literal stored values) for feature values.
void	setHTMLXSLStylesheet(java.lang.String pStyleSheet) Indicates the content of the XSL stylesheet to parse the feature attributes through.
void	setLayerDescription(java.lang.String text) Description for the layer.
void	setLayerWeight(double layerWeight) Default layer position.
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	setRelativeBase(java.lang.String basePath) Base path used when storing relative path names.
void	setRequestedImageType(int requestedImageFormat) The image type requested.
void	setResamplingHint(int pHint) The raster resampling hint.
void	setScale(double rhs1) The current scale of the display.
void	setShowTips(boolean show) Indicates if the layer shows map tips.
void	setSpatialReferenceByRef(ISpatialReference rhs1) Spatial reference for the layer.
void	setStepProgressor(IStepProgressor rhs1) The Step Progressor used by the layer to show progress on actions such as drawing.
void	setSupportsInteractive(boolean supported) Indicates if the layer supports interactive effects changes.
void	setTimeDataCumulative(boolean cumilative) Indicates that features will be animated cumilatively.
void	setTimeInterval(double interval) Returns recommended time interval to be used to animate this layer/ table.
void	setTimeIntervalUnits(int units) Returns recommended time interval units to be used to animate this layer/ table.
void	setTimeOffset(double timeOffset) Returns time offset that needs to be applied to the data for drawing.
void	setTimeOffsetUnits(int units) Returns recommended time interval units to be used to animate this layer/ table.
void	setTransparency(short alpha) Layer transparency in percent (0-100).
void	setTransparentColor(IColor color) The color that is transparent (100 %).
void	setUseTime(boolean useTime) Indicates whether to use the time for animation purposes.
void	setVisible(boolean visible) Indicates if the layer is currently visible.
void	showLayers(boolean show, ILongArray layerIds) Shows/ hides the layers given layer ids.
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

MapServerLayer

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

Constructs a MapServerLayer using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

MapServerLayer

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

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

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

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

addILayerEventsListener

public void addILayerEventsListener(ILayerEvents theListener)
                             throws java.io.IOException

addILayerEventsListener. Listen to events generated by this class.

Parameters:

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

Throws:

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

removeILayerEventsListener

public void removeILayerEventsListener(ILayerEvents theListener)
                                throws java.io.IOException

removeILayerEventsListener. Stop listening to events generated by this class.

Parameters:

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

Throws:

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

release

public void release()

Release a MapServerLayer.

Specified by:

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

getName

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

Layer name.

Description

Remarks

Use this property to associate a string with a layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface ILayer

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

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

Layer name.

Description

Use the Name property to associate a string with the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface ILayer

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isValid

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

Indicates if the layer is currently valid.

Remarks

The valid property indicates if the layer is currently valid. Layers that reference feature classes are valid when they hold a reference to a valid feature class. The property does not however validate the integrity of the feature classes reference to the database. Therefore, in rare situations if a datasource is removed after a layer is initialized, the layer will report itself as valid but query attempts to the data source will error due to the lack of underlying data.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isValid in interface ILayer

Returns:

The valid

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAreaOfInterest

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

The default area of interest for the layer.

Remarks

Returns the spatial-referenced extent of the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAreaOfInterest in interface ILayer

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

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

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

Remarks

Specifies the minimum scale at which the layer will be displayed. This means that if you zoom out beyond this scale, the layer will not display. For example, specify 1000 to have the layer not display when zoomed out beyond 1:1000.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMinimumScale in interface ILayer

Returns:

The minScale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinimumScale

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

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

Description

MinimumScale property specifies the minimum scale at which the layer will be displayed. Assign a Double value to set this property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMinimumScale in interface ILayer

Parameters:

minScale - The minScale (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaximumScale

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

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

Remarks

Specifies the maximum scale at which the layer will be displayed. This means that if you zoom in beyond this scale, the layer will not display. For example, specify 500 to have the layer not display when zoomed in beyond 1:500.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMaximumScale in interface ILayer

Returns:

The maxScale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaximumScale

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

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

Description

MaximumScale property specifies the maximum scale at which the layer will be displayed. Assign a Double value to set this property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMaximumScale in interface ILayer

Parameters:

maxScale - The maxScale (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isVisible

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

Indicates if the layer is currently visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isVisible in interface ILayer

Returns:

The visible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVisible

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

Indicates if the layer is currently visible.

Description

Use Visible property to set the visibility of the layer. When assigned False, the layer is invisible in the current view.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setVisible in interface ILayer

Parameters:

visible - The visible (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowTips

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

Indicates if the layer shows map tips.

Remarks

Indicates whether or not map tips are shown for the layer. If set to True, then map tips will be shown for the layer. You can determine the text that will be shown via TipText. For a FeatureLayer, this text comes from the data for IFeatureLayer::DisplayField.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isShowTips in interface ILayer

Returns:

The show

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowTips

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

Indicates if the layer shows map tips.

Description

ShowTips is set to True when the layer shows map tips specified in the TipText property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShowTips in interface ILayer

Parameters:

show - The show (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTipText

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

Map tip text at the specified location.

Product Availability

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

Specified by:

getTipText in interface ILayer

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

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

Indicates if the layer needs its own display cache.

Remarks

This property indicates whether or not the layer requires its own display cache. If this property is True, then the Map will use a separate display cache for the layer so that it can be refreshed indpendently of other layers.

The Map is responsible for cache management. See IScreenDisplay::AddCache for more information on caches.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isCached in interface ILayer

Returns:

The cached

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCached

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

Indicates if the layer needs its own display cache.

Description

Use Cached property to indicate if the layer needs its own cache for display.

Remarks

Informational property. Container is responsible for cache management.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCached in interface ILayer

Parameters:

cached - The cached (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSupportedDrawPhases

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

Supported draw phases.

Remarks

Indicates the draw phases supported by the layer (esriDPGeography, esriDPAnnotation, esriDPSelection, or any combination of the three). The supported draw phases are defined by esriDrawPhase. When multiple draw phases are supported, the sum of the constants is used. For example, if SupportedDrawPhases = 3 then the layer supports drawing in the geography and annotation phases.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSupportedDrawPhases in interface ILayer

Returns:

The drawPhases

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

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

Spatial reference for the layer.

Remarks

This property is only used for map display, setting this property does not change the spatial reference of the layer's underlying data. The ArcGIS framework uses this property to pass the spatial reference from the map to the layer in order to support on-the-fly projection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSpatialReferenceByRef in interface ILayer

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

public 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.

Remarks

This method draws the layer to the Display for the specified DrawPhase. Use the TrackCancel object to allow the drawing of the layer to be interrupted by the user.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

draw in interface ILayer

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.

localConnect

public void localConnect(java.lang.String docLocation,
                         java.lang.String mapName)
                  throws java.io.IOException,
                         AutomationException

Connects to map document data frame specified by the location of a map document and the name of a data frame.

Specified by:

localConnect in interface IMapServerLayer

Parameters:

docLocation - The docLocation (in)

mapName - The mapName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

serverConnect

public void serverConnect(IAGSServerObjectName soName,
                          java.lang.String mapName)
                   throws java.io.IOException,
                          AutomationException

Connects to map server object specified by the AGSServerObject name for a MapServer server object and the name of a data frame.

Specified by:

serverConnect in interface IMapServerLayer

Parameters:

soName - A reference to a com.esri.arcgis.gisclient.IAGSServerObjectName (in)

mapName - The mapName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getConnectionInfo

public void getConnectionInfo(IAGSServerObjectName[] soName,
                              java.lang.String[] docLocation,
                              java.lang.String[] mapName)
                       throws java.io.IOException,
                              AutomationException

Returns information about a connection to a map server object or to a map document.

Specified by:

getConnectionInfo in interface IMapServerLayer

Parameters:

soName - A reference to a com.esri.arcgis.gisclient.IAGSServerObjectName (out: use single element array)

docLocation - The docLocation (out: use single element array)

mapName - The mapName (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clearDrawCache

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

Clears the cache of images downloaded from the server redraw.

Specified by:

clearDrawCache in interface IMapServerLayer

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

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

The background color of a map server layer object.

Specified by:

getBackgroundColor in interface IMapServerLayer

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.

getTransparentColor

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

The color that is transparent (100 %).

Specified by:

getTransparentColor in interface IMapServerLayer

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.

setTransparentColor

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

The color that is transparent (100 %).

Specified by:

setTransparentColor in interface IMapServerLayer

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.

getCount

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

Number of layers in the collection.

Specified by:

getCount in interface ICompositeLayer

Specified by:

getCount in interface ICompositeLayer2

Specified by:

getCount in interface IMapServerGroupLayer

Returns:

The layerCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayer

public ILayer getLayer(int index)
                throws java.io.IOException,
                       AutomationException

Layer in the collection at the specified index.

Specified by:

getLayer in interface ICompositeLayer

Specified by:

getLayer in interface ICompositeLayer2

Specified by:

getLayer in interface IMapServerGroupLayer

Parameters:

index - The index (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isExpanded

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

Indicates if the layer is expanded in the TOC.

Specified by:

isExpanded in interface ICompositeLayer2

Returns:

The expanded

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExpanded

public void setExpanded(boolean expanded)
                 throws java.io.IOException,
                        AutomationException

Indicates if the layer is expanded in the TOC.

Specified by:

setExpanded in interface ICompositeLayer2

Parameters:

expanded - The expanded (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

showLayers

public void showLayers(boolean show,
                       ILongArray layerIds)
                throws java.io.IOException,
                       AutomationException

Shows/ hides the layers given layer ids.

Specified by:

showLayers in interface IMapServerGroupLayer

Parameters:

show - The show (in)

layerIds - A reference to a com.esri.arcgis.system.ILongArray (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException

The spatial reference of the GeoDataset.

Remarks

This property is read only. For layers, when the first layer is added to ArcMap, its spatial reference is read by this property, and the map is set to this spatial reference.

Instances of the esriCarto.GroupLayer class will return null for this property, as a group layer can contain multiple datasets with different spatial references.

Modifications to a spatial reference returned by this property will not be persisted. To modify the spatial reference of a dataset, the IGeoDatasetSchemaEdit and IGeoDatasetSchemaEdit2 interfaces should be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSpatialReference in interface IGeoDataset

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException

The extent of the GeoDataset.

Remarks

The IGeoDataset::Extent property returns an envelope representing the maximum extent of data which has been stored in the dataset.

Consider the following scenario. A new feature class has features added to it. The IGeoDataset::Extent is then requested and an envelope is returned. The extents of the envelope returned are represented by the red box in the image below.

If a portion of the features were then deleted and the extent is again requested an envelope with the exact same extents as during the first request would be returned (see image below). This is because the deletion of features does not shrink the extent. However all additions of features outside the red box would increase the envelope returned to encompass the newly added features.

If you would like to update the IGeoDataset::Extent property to reflect the current features in your dataset please see IFeatureClassManage::UpdateExtent (also see IFeatureClassLoad). In the image below the extent has been updated and a new envelope is being returned.

ESRI's GroupLayer implements this property differently from most other layer coclasses. When you instantiate a new GroupLayer, this property will return a valid envelope with zero height and width. With most other newly instantiated layers (for example FeatureLayer, RasterLayer, TinLayer), this property initally returns Nothing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExtent in interface IGeoDataset

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.

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.

getLayerWeight

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

Default layer position.

Specified by:

getLayerWeight in interface ILayerPosition

Returns:

The layerWeight

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLayerWeight

public void setLayerWeight(double layerWeight)
                    throws java.io.IOException,
                           AutomationException

Default layer position.

Specified by:

setLayerWeight in interface ILayerPosition

Parameters:

layerWeight - The layerWeight (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUsesFilter

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

Indicates if the current object draws using a filter.

Specified by:

isUsesFilter in interface IDisplayAdmin

Specified by:

isUsesFilter in interface IDisplayAdmin2

Returns:

The usesFilter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRequiresBanding

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

Indicates whether the output from the drawing object requires banding. Generally this is true if the output is raster.

Specified by:

isRequiresBanding in interface IDisplayAdmin2

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDoesBlending

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

Indicates whether the drawing object blends its output with the background. For example, if the object is transparent, the background becomes part of its rendering.

Specified by:

isDoesBlending in interface IDisplayAdmin2

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDrawingPropsDirty

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

Indicates if the layer drawing properties are dirty.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDrawingPropsDirty in interface ILayerDrawingProperties

Returns:

The dirty

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDrawingPropsDirty

public void setDrawingPropsDirty(boolean dirty)
                          throws java.io.IOException,
                                 AutomationException

Indicates if the layer drawing properties are dirty.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDrawingPropsDirty in interface ILayerDrawingProperties

Parameters:

dirty - The dirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportsTransparency

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

Indicates if the layer supports transparency.

Specified by:

isSupportsTransparency in interface ILayerEffects

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportsContrastChange

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

Indicates if the layer supports contrast changes.

Specified by:

isSupportsContrastChange in interface ILayerEffects

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportsBrightnessChange

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

Indicates if the layer supports brightness changes.

Specified by:

isSupportsBrightnessChange in interface ILayerEffects

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSupportsInteractive

public void setSupportsInteractive(boolean supported)
                            throws java.io.IOException,
                                   AutomationException

Indicates if the layer supports interactive effects changes.

Specified by:

setSupportsInteractive in interface ILayerEffects

Parameters:

supported - The supported (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportsInteractive

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

Indicates if the layer supports interactive effects changes.

Specified by:

isSupportsInteractive in interface ILayerEffects

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTransparency

public short getTransparency()
                      throws java.io.IOException,
                             AutomationException

Layer transparency in percent (0-100).

Specified by:

getTransparency in interface ILayerEffects

Returns:

The alpha

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTransparency

public void setTransparency(short alpha)
                     throws java.io.IOException,
                            AutomationException

Layer transparency in percent (0-100).

Specified by:

setTransparency in interface ILayerEffects

Parameters:

alpha - The alpha (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getContrast

public short getContrast()
                  throws java.io.IOException,
                         AutomationException

Layer contrast in percent (-100 - 100).

Specified by:

getContrast in interface ILayerEffects

Returns:

The contrastValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setContrast

public void setContrast(short contrastValue)
                 throws java.io.IOException,
                        AutomationException

Layer contrast in percent (-100 - 100).

Specified by:

setContrast in interface ILayerEffects

Parameters:

contrastValue - The contrastValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBrightness

public short getBrightness()
                    throws java.io.IOException,
                           AutomationException

Layer brightness in percent (-100 - 100).

Specified by:

getBrightness in interface ILayerEffects

Returns:

The brightnessValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBrightness

public void setBrightness(short brightnessValue)
                   throws java.io.IOException,
                          AutomationException

Layer brightness in percent (-100 - 100).

Specified by:

setBrightness in interface ILayerEffects

Parameters:

brightnessValue - The brightnessValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSmallImage

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

Small image that represents the layer.

Specified by:

getSmallImage in interface ILayerInfo

Returns:

The hBitmap (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSmallSelectedImage

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

Small image that represents the layer when it is selected.

Specified by:

getSmallSelectedImage in interface ILayerInfo

Returns:

The hBitmap (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLargeImage

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

Large image that represents the layer.

Specified by:

getLargeImage in interface ILayerInfo

Returns:

The hBitmap (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLargeSelectedImage

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

Large image that represents the layer when it is selected.

Specified by:

getLargeSelectedImage in interface ILayerInfo

Returns:

The hBitmap (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStepProgressor

public void setStepProgressor(IStepProgressor rhs1)
                       throws java.io.IOException,
                              AutomationException

The Step Progressor used by the layer to show progress on actions such as drawing.

Specified by:

setStepProgressor in interface ILayerStatus

Parameters:

rhs1 - A reference to a com.esri.arcgis.system.IStepProgressor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportsPublishing

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

Indicates if the layer supports the publishing process.

Specified by:

isSupportsPublishing in interface IPublishLayer

Returns:

The bValid

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPublishingDescription

public java.lang.String getPublishingDescription()
                                          throws java.io.IOException,
                                                 AutomationException

The layer description reported to the publisher.

Specified by:

getPublishingDescription in interface IPublishLayer

Returns:

The bsDescription

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDataValid

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

Indicates if the data for the layer is currently valid.

Specified by:

isDataValid in interface IPublishLayer

Returns:

The bDataValid

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDataDetails

public java.lang.String getDataDetails(java.lang.String bsPadding)
                                throws java.io.IOException,
                                       AutomationException

Details of the layer's data.

Specified by:

getDataDetails in interface IPublishLayer

Parameters:

bsPadding - The bsPadding (in)

Returns:

The bsDataDetails

Throws:

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

AutomationException - If the ArcObject component throws an exception.

prepareForPublishing

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

Prepare the layer for the publishing process.

Specified by:

prepareForPublishing in interface IPublishLayer

Throws:

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

AutomationException - If the ArcObject component throws an exception.

identify

public IArray identify(IGeometry pGeom)
                throws java.io.IOException,
                       AutomationException

Identifies objects at the specified location.

Remarks

When the IIdentify interface is on a map layer, the Identify method returns an array of FeatureIdentifyObject objects.

On a FeatureIdentifyObject, you can do a QI to the IIdentifyObj interface to get more information about the identified feature. The IIdentifyObj interface returns the window handle, layer, and name of the feature; it has methods to flash the feature in the display and to display a context menu at the Identify location.

This method performs an identify operation with the provided geometry. When identifying layers, typically a small envelope is passed in rather than a point to account for differences in the precision of the display and the feature geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

identify in interface IIdentify

Parameters:

pGeom - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

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

AutomationException - If the ArcObject component throws an exception.

identify

public IArray identify(IGeometry pGeom,
                       ITrackCancel pTrackCancel)
                throws java.io.IOException,
                       AutomationException

Identifies objects at the specified location.

Specified by:

identify in interface IIdentify2

Parameters:

pGeom - A reference to a com.esri.arcgis.geometry.IGeometry (in)

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

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setScale

public void setScale(double rhs1)
              throws java.io.IOException,
                     AutomationException

The current scale of the display.

Specified by:

setScale in interface IIdentify2

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLastMinimumScale

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

Last minimum scale setting used by layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLastMinimumScale in interface ILayerGeneralProperties

Returns:

The minScale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLastMaximumScale

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

Last maximum scale setting used by layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLastMaximumScale in interface ILayerGeneralProperties

Returns:

The maxScale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

ILayerGeneralProperties_getLayerDescription

public java.lang.String ILayerGeneralProperties_getLayerDescription()
                                                             throws java.io.IOException,
                                                                    AutomationException

Description for the layer.

Product Availability

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

Specified by:

ILayerGeneralProperties_getLayerDescription in interface ILayerGeneralProperties

Returns:

The text

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLayerDescription

public void setLayerDescription(java.lang.String text)
                         throws java.io.IOException,
                                AutomationException

Description for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLayerDescription in interface ILayerGeneralProperties

Parameters:

text - The text (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

expandRegionForSymbols

public void expandRegionForSymbols(IDisplay pDisplay,
                                   IGeometry pRegion)
                            throws java.io.IOException,
                                   AutomationException

Enlarges the specified region if necessary to account for the symbology sizes.

Specified by:

expandRegionForSymbols in interface ILayerSymbologyExtents

Parameters:

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

pRegion - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDataSourceName

public IName getDataSourceName()
                        throws java.io.IOException,
                               AutomationException

Name of the data object for the layer.

Specified by:

getDataSourceName in interface IDataLayer

Returns:

A reference to a com.esri.arcgis.system.IName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDataSourceName

public void setDataSourceName(IName name)
                       throws java.io.IOException,
                              AutomationException

Name of the data object for the layer.

Specified by:

setDataSourceName in interface IDataLayer

Parameters:

name - A reference to a com.esri.arcgis.system.IName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDataSourceSupported

public boolean isDataSourceSupported(IName name)
                              throws java.io.IOException,
                                     AutomationException

Indicates if the specified data object name is supported by the layer.

Specified by:

isDataSourceSupported in interface IDataLayer

Parameters:

name - A reference to a com.esri.arcgis.system.IName (in)

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

connect

public boolean connect(IName pOptRepairName)
                throws java.io.IOException,
                       AutomationException

Connects the layer to its data source. An optional name object can be specified to aid in repairing a lost connection.

Specified by:

connect in interface IDataLayer

Parameters:

pOptRepairName - A reference to a com.esri.arcgis.system.IName (in)

Returns:

The succeeded

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRelativeBase

public java.lang.String getRelativeBase()
                                 throws java.io.IOException,
                                        AutomationException

Base path used when storing relative path names.

Specified by:

getRelativeBase in interface IDataLayer

Returns:

The basePath

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRelativeBase

public void setRelativeBase(java.lang.String basePath)
                     throws java.io.IOException,
                            AutomationException

Base path used when storing relative path names.

Specified by:

setRelativeBase in interface IDataLayer

Parameters:

basePath - The basePath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtensionCount

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

Number of extensions.

Specified by:

getExtensionCount in interface ILayerExtensions

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtension

public java.lang.Object getExtension(int index)
                              throws java.io.IOException,
                                     AutomationException

The extension at the specified index.

Specified by:

getExtension in interface ILayerExtensions

Parameters:

index - The index (in)

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addExtension

public void addExtension(java.lang.Object ext)
                  throws java.io.IOException,
                         AutomationException

Adds a new extension.

Specified by:

addExtension in interface ILayerExtensions

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeExtension

public void removeExtension(int index)
                     throws java.io.IOException,
                            AutomationException

Removes the specified extension.

Specified by:

removeExtension in interface ILayerExtensions

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clearPassword

public void clearPassword(boolean bForceReconnect)
                   throws java.io.IOException,
                          AutomationException

Removes the passwords from the layer used to access data, and forces a reconnection to the data.

Specified by:

clearPassword in interface ISecureLayer

Specified by:

clearPassword in interface ISecureLayer2

Parameters:

bForceReconnect - The bForceReconnect (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHasAuthentication

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

Indicates if the layer is password protected.

Specified by:

isHasAuthentication in interface ISecureLayer2

Returns:

The hasAuthentication

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getResamplingHint

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

The raster resampling hint.

Specified by:

getResamplingHint in interface IRasterResamplingControl

Returns:

A com.esri.arcgis.geodatabase.esriRasterResamplingHint constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setResamplingHint

public void setResamplingHint(int pHint)
                       throws java.io.IOException,
                              AutomationException

The raster resampling hint.

Specified by:

setResamplingHint in interface IRasterResamplingControl

Parameters:

pHint - A com.esri.arcgis.geodatabase.esriRasterResamplingHint constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

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

enumConnectionPoints

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

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

findConnectionPoint

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:

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

AutomationException - If the ArcObject component throws an exception.

getSupportedImageFormatCount

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

The number of output image format supported by Server.

Specified by:

getSupportedImageFormatCount in interface IServiceLayerImageFormat

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSupportedImageFormat

public int getSupportedImageFormat(int index)
                            throws java.io.IOException,
                                   AutomationException

The individual output image format supported by Server.

Specified by:

getSupportedImageFormat in interface IServiceLayerImageFormat

Parameters:

index - The index (in)

Returns:

A com.esri.arcgis.carto.esriImageFormat constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRequestedImageType

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

The image type requested.

Specified by:

getRequestedImageType in interface IServiceLayerImageFormat

Returns:

A com.esri.arcgis.carto.esriImageFormat constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRequestedImageType

public void setRequestedImageType(int requestedImageFormat)
                           throws java.io.IOException,
                                  AutomationException

The image type requested.

Specified by:

setRequestedImageType in interface IServiceLayerImageFormat

Parameters:

requestedImageFormat - A com.esri.arcgis.carto.esriImageFormat constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

identifyEx

public IArray identifyEx(IDisplay pDisplay,
                         IGeometry pGeom,
                         ITrackCancel pTrackCancel)
                  throws java.io.IOException,
                         AutomationException

Identifies objects at the specified location for the given display.

Specified by:

identifyEx in interface IIdentifyDisplay

Parameters:

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

pGeom - A reference to a com.esri.arcgis.geometry.IGeometry (in)

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

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHTMLPopupEnabled

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

Indicates if this layer currently responds to the HTML Popup tool.

Specified by:

isHTMLPopupEnabled in interface IHTMLPopupIdentify

Specified by:

isHTMLPopupEnabled in interface IHTMLPopupInfo

Returns:

The pEnabled

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLPopupEnabled

public void setHTMLPopupEnabled(boolean pEnabled)
                         throws java.io.IOException,
                                AutomationException

Indicates if this layer currently responds to the HTML Popup tool.

Specified by:

setHTMLPopupEnabled in interface IHTMLPopupInfo

Parameters:

pEnabled - The pEnabled (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHTMLPresentationStyle

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

Indicates the content formating style for the HTML Popup tool.

Specified by:

getHTMLPresentationStyle in interface IHTMLPopupIdentify

Specified by:

getHTMLPresentationStyle in interface IHTMLPopupInfo

Returns:

A com.esri.arcgis.carto.esriHTMLPopupStyle constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLPresentationStyle

public void setHTMLPresentationStyle(int pStyle)
                              throws java.io.IOException,
                                     AutomationException

Indicates the content formating style for the HTML Popup tool.

Specified by:

setHTMLPresentationStyle in interface IHTMLPopupInfo

Parameters:

pStyle - A com.esri.arcgis.carto.esriHTMLPopupStyle constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHTMLHideFieldNameColumn

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

Indicates if Field name column will be output to the HTML Popup tool.

Specified by:

isHTMLHideFieldNameColumn in interface IHTMLPopupInfo

Returns:

The pHide

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLHideFieldNameColumn

public void setHTMLHideFieldNameColumn(boolean pHide)
                                throws java.io.IOException,
                                       AutomationException

Indicates if Field name column will be output to the HTML Popup tool.

Specified by:

setHTMLHideFieldNameColumn in interface IHTMLPopupInfo

Parameters:

pHide - The pHide (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHTMLRedirectField

public java.lang.String getHTMLRedirectField()
                                      throws java.io.IOException,
                                             AutomationException

Indicates the fieldname of the layer that contains the HTML redirect URL values.

Specified by:

getHTMLRedirectField in interface IHTMLPopupInfo

Returns:

The pField

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLRedirectField

public void setHTMLRedirectField(java.lang.String pField)
                          throws java.io.IOException,
                                 AutomationException

Indicates the fieldname of the layer that contains the HTML redirect URL values.

Specified by:

setHTMLRedirectField in interface IHTMLPopupInfo

Parameters:

pField - The pField (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHTMLRedirectFieldPrefix

public java.lang.String getHTMLRedirectFieldPrefix()
                                            throws java.io.IOException,
                                                   AutomationException

Indicates the text to precede the HTMLRedirectField value for the redirect URL.

Specified by:

getHTMLRedirectFieldPrefix in interface IHTMLPopupInfo

Returns:

The pPrefix

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLRedirectFieldPrefix

public void setHTMLRedirectFieldPrefix(java.lang.String pPrefix)
                                throws java.io.IOException,
                                       AutomationException

Indicates the text to precede the HTMLRedirectField value for the redirect URL.

Specified by:

setHTMLRedirectFieldPrefix in interface IHTMLPopupInfo

Parameters:

pPrefix - The pPrefix (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHTMLRedirectFieldSuffix

public java.lang.String getHTMLRedirectFieldSuffix()
                                            throws java.io.IOException,
                                                   AutomationException

Indicates the text to follow the HTMLRedirectField value for the redirect URL.

Specified by:

getHTMLRedirectFieldSuffix in interface IHTMLPopupInfo

Returns:

The pSufix

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLRedirectFieldSuffix

public void setHTMLRedirectFieldSuffix(java.lang.String pSufix)
                                throws java.io.IOException,
                                       AutomationException

Indicates the text to follow the HTMLRedirectField value for the redirect URL.

Specified by:

setHTMLRedirectFieldSuffix in interface IHTMLPopupInfo

Parameters:

pSufix - The pSufix (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHTMLXSLStylesheet

public java.lang.String getHTMLXSLStylesheet()
                                      throws java.io.IOException,
                                             AutomationException

Indicates the content of the XSL stylesheet to parse the feature attributes through.

Specified by:

getHTMLXSLStylesheet in interface IHTMLPopupInfo

Returns:

The pStyleSheet

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLXSLStylesheet

public void setHTMLXSLStylesheet(java.lang.String pStyleSheet)
                          throws java.io.IOException,
                                 AutomationException

Indicates the content of the XSL stylesheet to parse the feature attributes through.

Specified by:

setHTMLXSLStylesheet in interface IHTMLPopupInfo

Parameters:

pStyleSheet - The pStyleSheet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHTMLUseCodedDomainValues

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

Indicates whether to use coded values (rather than literal stored values) for feature values.

Specified by:

isHTMLUseCodedDomainValues in interface IHTMLPopupInfo

Returns:

The pCodedValues

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLUseCodedDomainValues

public void setHTMLUseCodedDomainValues(boolean pCodedValues)
                                 throws java.io.IOException,
                                        AutomationException

Indicates whether to use coded values (rather than literal stored values) for feature values.

Specified by:

setHTMLUseCodedDomainValues in interface IHTMLPopupInfo

Parameters:

pCodedValues - The pCodedValues (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHTMLOutput

public java.lang.String getHTMLOutput(IFeature pFeature)
                               throws java.io.IOException,
                                      AutomationException

The content is the XML text for the input feature.

Specified by:

getHTMLOutput in interface IHTMLPopupInfo

Parameters:

pFeature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

Returns:

The pHtml

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHTMLDownloadAttachmentData

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

Indicates that all data for attachments will be retrieved.

Specified by:

isHTMLDownloadAttachmentData in interface IHTMLPopupInfo2

Returns:

The pDownloadAttachmentData

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLDownloadAttachmentData

public void setHTMLDownloadAttachmentData(boolean pDownloadAttachmentData)
                                   throws java.io.IOException,
                                          AutomationException

Indicates that all data for attachments will be retrieved.

Specified by:

setHTMLDownloadAttachmentData in interface IHTMLPopupInfo2

Parameters:

pDownloadAttachmentData - The pDownloadAttachmentData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

hTMLOutput

public java.lang.String hTMLOutput(IFeature pFeature,
                                   IPropertySet pOptions)
                            throws java.io.IOException,
                                   AutomationException

The content is the XML text for the input feature, pOptions is an optional parameter.

Specified by:

hTMLOutput in interface IHTMLPopupInfo2

Parameters:

pFeature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

pOptions - A reference to a com.esri.arcgis.system.IPropertySet (in)

Returns:

The pHtml

Throws:

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

AutomationException - If the ArcObject component throws an exception.

hTMLIdentify

public java.lang.String hTMLIdentify(IPoint pPoint,
                                     double tolerance)
                              throws java.io.IOException,
                                     AutomationException

The content is the XML text at the specified point.

Specified by:

hTMLIdentify in interface IHTMLPopupIdentify

Parameters:

pPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

tolerance - The tolerance (in)

Returns:

The pHtml

Throws:

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

AutomationException - If the ArcObject component throws an exception.

hTMLTipText

public java.lang.String hTMLTipText(IPoint pPoint,
                                    double tolerance)
                             throws java.io.IOException,
                                    AutomationException

The tooltip at the specified point.

Specified by:

hTMLTipText in interface IHTMLPopupIdentify

Parameters:

pPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

tolerance - The tolerance (in)

Returns:

The pTipText

Throws:

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

AutomationException - If the ArcObject component throws an exception.

hTMLIdentify

public void hTMLIdentify(IDisplay pDisplay,
                         IGeometry pGeometry,
                         IPropertySet pOptions,
                         IStringArray[] ppItemNames,
                         IStringArray[] ppItemHTML)
                  throws java.io.IOException,
                         AutomationException

The content is the XML text at the specified point. tempPath and refPath are optional parameters.

Specified by:

hTMLIdentify in interface IHTMLPopupIdentify2

Parameters:

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

pGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

pOptions - A reference to a com.esri.arcgis.system.IPropertySet (in)

ppItemNames - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

ppItemHTML - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportsTime

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

Indicates whether the layer has any time data.

Specified by:

isSupportsTime in interface ITimeData

Returns:

The hasTime

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseTime

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

Indicates whether to use the time for animation purposes.

Specified by:

isUseTime in interface ITimeData

Returns:

The useTime

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseTime

public void setUseTime(boolean useTime)
                throws java.io.IOException,
                       AutomationException

Indicates whether to use the time for animation purposes.

Specified by:

setUseTime in interface ITimeData

Parameters:

useTime - The useTime (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeReference

public ITimeReference getTimeReference()
                                throws java.io.IOException,
                                       AutomationException

Time reference for the contents of the layer.

Specified by:

getTimeReference in interface ITimeData

Returns:

A reference to a com.esri.arcgis.system.ITimeReference

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFullTimeExtent

public ITimeExtent getFullTimeExtent()
                              throws java.io.IOException,
                                     AutomationException

Returns the time extent for all the data in the layer.

Specified by:

getFullTimeExtent in interface ITimeData

Returns:

A reference to a com.esri.arcgis.system.ITimeExtent

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHasLiveData

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

isHasLiveData

Specified by:

isHasLiveData in interface ITimeData2

Returns:

The useTime

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHasLiveData

public void setHasLiveData(boolean useTime)
                    throws java.io.IOException,
                           AutomationException

setHasLiveData

Specified by:

setHasLiveData in interface ITimeData2

Parameters:

useTime - The useTime (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeDataCumulative

public void setTimeDataCumulative(boolean cumilative)
                           throws java.io.IOException,
                                  AutomationException

Indicates that features will be animated cumilatively.

Specified by:

setTimeDataCumulative in interface ITimeDataDisplay

Parameters:

cumilative - The cumilative (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isTimeDataCumulative

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

Indicates that features will be animated cumilatively.

Specified by:

isTimeDataCumulative in interface ITimeDataDisplay

Returns:

The cumilative

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeInterval

public void setTimeInterval(double interval)
                     throws java.io.IOException,
                            AutomationException

Returns recommended time interval to be used to animate this layer/ table.

Specified by:

setTimeInterval in interface ITimeDataDisplay

Parameters:

interval - The interval (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeInterval

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

Returns recommended time interval to be used to animate this layer/ table.

Specified by:

getTimeInterval in interface ITimeDataDisplay

Returns:

The interval

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeIntervalUnits

public void setTimeIntervalUnits(int units)
                          throws java.io.IOException,
                                 AutomationException

Returns recommended time interval units to be used to animate this layer/ table.

Specified by:

setTimeIntervalUnits in interface ITimeDataDisplay

Parameters:

units - A com.esri.arcgis.system.esriTimeUnits constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeIntervalUnits

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

Returns recommended time interval units to be used to animate this layer/ table.

Specified by:

getTimeIntervalUnits in interface ITimeDataDisplay

Returns:

A com.esri.arcgis.system.esriTimeUnits constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeOffset

public void setTimeOffset(double timeOffset)
                   throws java.io.IOException,
                          AutomationException

Returns time offset that needs to be applied to the data for drawing.

Specified by:

setTimeOffset in interface ITimeDataDisplay

Parameters:

timeOffset - The timeOffset (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeOffset

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

Returns time offset that needs to be applied to the data for drawing.

Specified by:

getTimeOffset in interface ITimeDataDisplay

Returns:

The timeOffset

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeOffsetUnits

public void setTimeOffsetUnits(int units)
                        throws java.io.IOException,
                               AutomationException

Returns recommended time interval units to be used to animate this layer/ table.

Specified by:

setTimeOffsetUnits in interface ITimeDataDisplay

Parameters:

units - A com.esri.arcgis.system.esriTimeUnits constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeOffsetUnits

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

Returns recommended time interval units to be used to animate this layer/ table.

Specified by:

getTimeOffsetUnits in interface ITimeDataDisplay

Returns:

A com.esri.arcgis.system.esriTimeUnits constant

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