com.esri.arcgis.carto
Class MapServerQuerySublayer

java.lang.Object
  extended by com.esri.arcgis.carto.MapServerQuerySublayer
All Implemented Interfaces:
IFind, IHTMLPopupIdentify, IHTMLPopupIdentify2, IHTMLPopupInfo, IHTMLPopupInfo2, IIdentify, IIdentify2, IIdentifyDisplay, ILayer, ILayerDrawingProperties, ILayerGeneralProperties, ILegendInfo, IMapServerGroupLayer, IMapServerSublayer, IMapServerSublayer2, IGeoDataset, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class MapServerQuerySublayer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IMapServerSublayer, IMapServerSublayer2, IMapServerGroupLayer, ILayer, ILegendInfo, IGeoDataset, IPersistStream, ILayerGeneralProperties, IIdentify, IIdentify2, IFind, IIdentifyDisplay, IHTMLPopupInfo, IHTMLPopupInfo2, IHTMLPopupIdentify, IHTMLPopupIdentify2, ILayerDrawingProperties, java.io.Externalizable

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

Description 'Provides programmatic access to a map server sublayer with Find and Identify capability.' 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.IMapServerSublayer
IID, IIDb059b902_5c7a_4287_982e_ef0bc77c6aab, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IMapServerSublayer2
IID, IIDc044e0de_b4fb_471f_b0fd_7dfdc56991f1, 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.IIdentify2
IID, IID0483dc2f_8726_4640_98cd_5888ff1a4fa4, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IFind
IID, IID9fe681e6_ba4e_4729_8301_8f15a1544140, 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
 
Constructor Summary
MapServerQuerySublayer(java.lang.Object obj)
          Construct a MapServerQuerySublayer using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 void draw(int drawPhase, IDisplay display, ITrackCancel trackCancel)
          Draws the layer to the specified display for the given draw phase.
 boolean equals(java.lang.Object o)
          Compare this object with another
 IArray find(java.lang.String search, boolean contains, java.lang.Object fields, ITrackCancel trackCancel)
          Finds the specified search string in the given attribute fields.
 IEnvelope getAreaOfInterest()
          The default area of interest for the layer.
 void getClassID(GUID[] pClassID)
          getClassID
 int getCount()
          Number of layers in the collection.
 IEnvelope getExtent()
          The extent of the GeoDataset.
 java.lang.String getFindDisplayField()
          The display field.
 java.lang.Object getFindFields()
          The attribute fields.
 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.
 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.
 ILayerDescription getLayerDescription()
          The layer description.
 ILegendGroup getLegendGroup(int index)
          Legend group at the specified index.
 int getLegendGroupCount()
          Number of legend groups contained by the object.
 ILegendItem getLegendItem()
          Optional.
 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.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 java.lang.String getSourceID()
          The source ID of the layer.
 ISpatialReference getSpatialReference()
          The spatial reference of the GeoDataset.
 int getSupportedDrawPhases()
          Supported draw phases.
 java.lang.String getTipText(double x, double y, double tolerance)
          Map tip text at the specified location.
 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.
 void isDirty()
          isDirty
 boolean isDrawingPropsDirty()
          Indicates if the layer drawing properties are dirty.
 boolean isHasLabels()
          Indicates if the layer has labels to turn on and off.
 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 isScaleSymbols()
          Indicates whether the layer should scale its symbols according to the reference scale.
 boolean isShowLabels()
          Indicates whether the layer should display its dynamic labels.
 boolean isShowTips()
          Indicates if the layer shows map tips.
 boolean isSymbolsAreGraduated()
          Indicates if symbols are graduated.
 boolean isValid()
          Indicates if the layer is currently valid.
 boolean isVisible()
          Indicates if the layer is currently visible.
 void load(IStream pstm)
          load
 void readExternal(java.io.ObjectInput in)
           
 void release()
          Release a MapServerQuerySublayer.
 void save(IStream pstm, int fClearDirty)
          save
 void setCached(boolean cached)
          Indicates if the layer needs its own display cache.
 void setDrawingPropsDirty(boolean dirty)
          Indicates if the layer drawing properties are dirty.
 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 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 setScale(double rhs1)
          The current scale of the display.
 void setScaleSymbols(boolean scaleSymbols)
          Indicates whether the layer should scale its symbols according to the reference scale.
 void setShowLabels(boolean show)
          Indicates whether the layer should display its dynamic labels.
 void setShowTips(boolean show)
          Indicates if the layer shows map tips.
 void setSourceID(java.lang.String sourceID)
          The source ID of the layer.
 void setSpatialReferenceByRef(ISpatialReference rhs1)
          Spatial reference for the layer.
 void setSymbolsAreGraduated(boolean symbolsAreGraduated)
          Indicates if symbols are graduated.
 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

MapServerQuerySublayer

public MapServerQuerySublayer(java.lang.Object obj)
                       throws java.io.IOException
Construct a MapServerQuerySublayer using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to MapServerQuerySublayer.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
MapServerQuerySublayer o = (MapServerQuerySublayer)obj; // will not work

MapServerQuerySublayer o = new MapServerQuerySublayer(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:
java.io.IOException - if there are interop problems MapServerQuerySublayer theMapServerQuerySublayer = (MapServerQuerySublayer) obj;
Method Detail

equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a MapServerQuerySublayer.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

isHasLabels

public boolean isHasLabels()
                    throws java.io.IOException,
                           AutomationException
Indicates if the layer has labels to turn on and off.

Specified by:
isHasLabels in interface IMapServerSublayer
Specified by:
isHasLabels in interface IMapServerSublayer2
Returns:
The hasLabels
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowLabels

public boolean isShowLabels()
                     throws java.io.IOException,
                            AutomationException
Indicates whether the layer should display its dynamic labels.

Specified by:
isShowLabels in interface IMapServerSublayer
Specified by:
isShowLabels in interface IMapServerSublayer2
Returns:
The show
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowLabels

public void setShowLabels(boolean show)
                   throws java.io.IOException,
                          AutomationException
Indicates whether the layer should display its dynamic labels.

Specified by:
setShowLabels in interface IMapServerSublayer
Specified by:
setShowLabels in interface IMapServerSublayer2
Parameters:
show - The show (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isScaleSymbols

public boolean isScaleSymbols()
                       throws java.io.IOException,
                              AutomationException
Indicates whether the layer should scale its symbols according to the reference scale.

Specified by:
isScaleSymbols in interface IMapServerSublayer
Specified by:
isScaleSymbols in interface IMapServerSublayer2
Returns:
The scaleSymbols
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setScaleSymbols

public void setScaleSymbols(boolean scaleSymbols)
                     throws java.io.IOException,
                            AutomationException
Indicates whether the layer should scale its symbols according to the reference scale.

Specified by:
setScaleSymbols in interface IMapServerSublayer
Specified by:
setScaleSymbols in interface IMapServerSublayer2
Parameters:
scaleSymbols - The scaleSymbols (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayerDescription

public ILayerDescription getLayerDescription()
                                      throws java.io.IOException,
                                             AutomationException
The layer description.

Specified by:
getLayerDescription in interface IMapServerSublayer
Specified by:
getLayerDescription in interface IMapServerSublayer2
Returns:
A reference to a com.esri.arcgis.carto.ILayerDescription
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSourceID

public java.lang.String getSourceID()
                             throws java.io.IOException,
                                    AutomationException
The source ID of the layer.

Specified by:
getSourceID in interface IMapServerSublayer2
Returns:
The sourceID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSourceID

public void setSourceID(java.lang.String sourceID)
                 throws java.io.IOException,
                        AutomationException
The source ID of the layer.

Specified by:
setSourceID in interface IMapServerSublayer2
Parameters:
sourceID - The sourceID (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.

getCount

public int getCount()
             throws java.io.IOException,
                    AutomationException
Number of layers in the collection.

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

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.

getLegendGroupCount

public int getLegendGroupCount()
                        throws java.io.IOException,
                               AutomationException
Number of legend groups contained by the object.

Remarks

The number of legend groups is determined by the implementation of the renderer, consequently this property is read only. For example, SimpleRenderer has one group, while a BiUniqueValueRenderer has any number of groups.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLegendGroupCount in interface ILegendInfo
Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLegendGroup

public ILegendGroup getLegendGroup(int index)
                            throws java.io.IOException,
                                   AutomationException
Legend group at the specified index.

Product Availability

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

Specified by:
getLegendGroup in interface ILegendInfo
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.carto.ILegendGroup
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLegendItem

public ILegendItem getLegendItem()
                          throws java.io.IOException,
                                 AutomationException
Optional. Defines legend formatting for layer rendered with this object.

Remarks

Layer or renderer legend information is further formatted for display in ArcMap legends. A renderer can override this formatting by returning a LegendItem for this property. ESRI renderers typically do not return anything for this property. With this configuration, legend formatting becomes a user or developer choice on the legend object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLegendItem in interface ILegendInfo
Returns:
A reference to a com.esri.arcgis.carto.ILegendItem
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSymbolsAreGraduated

public boolean isSymbolsAreGraduated()
                              throws java.io.IOException,
                                     AutomationException
Indicates if symbols are graduated.

Description

Indicates whether the symbols used for a layer or renderer's legend vary by size.

Remarks

For example the proportional symbol renderer returns True for this property.

You can use this property to distinguish between a layer symbolized with graduated color or graduated symbol type layer symbology. Both of these symbolizations use a ClassBreaksRenderer, but only a graduated symbol symbolization will return True for this property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isSymbolsAreGraduated in interface ILegendInfo
Returns:
The symbolsAreGraduated
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSymbolsAreGraduated

public void setSymbolsAreGraduated(boolean symbolsAreGraduated)
                            throws java.io.IOException,
                                   AutomationException
Indicates if symbols are graduated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSymbolsAreGraduated in interface ILegendInfo
Parameters:
symbolsAreGraduated - The symbolsAreGraduated (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.

The red box represents the IGeoDataset extent

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.

The red box represents the IGeoDataset extent after some of the features have been deleted

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.

The red box represents the IGeoDataset extent after it has been updated

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.

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.

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.

find

public IArray find(java.lang.String search,
                   boolean contains,
                   java.lang.Object fields,
                   ITrackCancel trackCancel)
            throws java.io.IOException,
                   AutomationException
Finds the specified search string in the given attribute fields.

Specified by:
find in interface IFind
Parameters:
search - The search (in)
contains - The contains (in)
fields - A Variant (in)
trackCancel - 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.

getFindFields

public java.lang.Object getFindFields()
                               throws java.io.IOException,
                                      AutomationException
The attribute fields.

Specified by:
getFindFields in interface IFind
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFindDisplayField

public java.lang.String getFindDisplayField()
                                     throws java.io.IOException,
                                            AutomationException
The display field.

Specified by:
getFindDisplayField in interface IFind
Returns:
The field
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.

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.

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