|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.carto.MapServerFindSublayer
public class MapServerFindSublayer
COM Class 'MapServerFindSublayer'. 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 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 =
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.IFind |
---|
IID, IID9fe681e6_ba4e_4729_8301_8f15a1544140, xxDummy |
Constructor Summary | |
---|---|
MapServerFindSublayer(java.lang.Object obj)
Construct a MapServerFindSublayer 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. |
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 |
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 |
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 MapServerFindSublayer. |
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 |
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 |
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 |
---|
public static final long serialVersionUID
Constructor Detail |
---|
public MapServerFindSublayer(java.lang.Object obj) throws java.io.IOException
obj
to MapServerFindSublayer
. *
MapServerFindSublayer o = (MapServerFindSublayer)obj; // will not work
MapServerFindSublayer o = new MapServerFindSublayer(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server
java.io.IOException
- if there are interop problems
MapServerFindSublayer theMapServerFindSublayer = (MapServerFindSublayer) obj;
Method Detail |
---|
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
getJintegraDispatch
in interface com.esri.arcgis.interop.RemoteObjRef
public void release()
release
in interface com.esri.arcgis.interop.RemoteObjRef
public boolean isHasLabels() throws java.io.IOException, AutomationException
isHasLabels
in interface IMapServerSublayer
isHasLabels
in interface IMapServerSublayer2
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isShowLabels() throws java.io.IOException, AutomationException
isShowLabels
in interface IMapServerSublayer
isShowLabels
in interface IMapServerSublayer2
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setShowLabels(boolean show) throws java.io.IOException, AutomationException
setShowLabels
in interface IMapServerSublayer
setShowLabels
in interface IMapServerSublayer2
show
- The show (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isScaleSymbols() throws java.io.IOException, AutomationException
isScaleSymbols
in interface IMapServerSublayer
isScaleSymbols
in interface IMapServerSublayer2
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setScaleSymbols(boolean scaleSymbols) throws java.io.IOException, AutomationException
setScaleSymbols
in interface IMapServerSublayer
setScaleSymbols
in interface IMapServerSublayer2
scaleSymbols
- The scaleSymbols (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ILayerDescription getLayerDescription() throws java.io.IOException, AutomationException
getLayerDescription
in interface IMapServerSublayer
getLayerDescription
in interface IMapServerSublayer2
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getSourceID() throws java.io.IOException, AutomationException
getSourceID
in interface IMapServerSublayer2
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSourceID(java.lang.String sourceID) throws java.io.IOException, AutomationException
setSourceID
in interface IMapServerSublayer2
sourceID
- The sourceID (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void showLayers(boolean show, ILongArray layerIds) throws java.io.IOException, AutomationException
showLayers
in interface IMapServerGroupLayer
show
- The show (in)layerIds
- A reference to a com.esri.arcgis.system.ILongArray (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getCount() throws java.io.IOException, AutomationException
getCount
in interface IMapServerGroupLayer
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ILayer getLayer(int index) throws java.io.IOException, AutomationException
getLayer
in interface IMapServerGroupLayer
index
- The index (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getName() throws java.io.IOException, AutomationException
Use this property to associate a string with a layer.
getName
in interface ILayer
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setName(java.lang.String name) throws java.io.IOException, AutomationException
setName
in interface ILayer
name
- The name (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isValid() throws java.io.IOException, AutomationException
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.
isValid
in interface ILayer
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnvelope getAreaOfInterest() throws java.io.IOException, AutomationException
Returns the spatial-referenced extent of the layer.
getAreaOfInterest
in interface ILayer
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getMinimumScale() throws java.io.IOException, AutomationException
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.
getMinimumScale
in interface ILayer
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMinimumScale(double minScale) throws java.io.IOException, AutomationException
setMinimumScale
in interface ILayer
minScale
- The minScale (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getMaximumScale() throws java.io.IOException, AutomationException
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.
getMaximumScale
in interface ILayer
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMaximumScale(double maxScale) throws java.io.IOException, AutomationException
setMaximumScale
in interface ILayer
maxScale
- The maxScale (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isVisible() throws java.io.IOException, AutomationException
isVisible
in interface ILayer
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setVisible(boolean visible) throws java.io.IOException, AutomationException
setVisible
in interface ILayer
visible
- The visible (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isShowTips() throws java.io.IOException, AutomationException
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.
isShowTips
in interface ILayer
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setShowTips(boolean show) throws java.io.IOException, AutomationException
setShowTips
in interface ILayer
show
- The show (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getTipText(double x, double y, double tolerance) throws java.io.IOException, AutomationException
getTipText
in interface ILayer
x
- The x (in)y
- The y (in)tolerance
- The tolerance (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isCached() throws java.io.IOException, AutomationException
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.
isCached
in interface ILayer
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCached(boolean cached) throws java.io.IOException, AutomationException
Informational property. Container is responsible for cache management.
setCached
in interface ILayer
cached
- The cached (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getSupportedDrawPhases() throws java.io.IOException, AutomationException
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.
getSupportedDrawPhases
in interface ILayer
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSpatialReferenceByRef(ISpatialReference rhs1) throws java.io.IOException, AutomationException
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.
setSpatialReferenceByRef
in interface ILayer
rhs1
- A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void draw(int drawPhase, IDisplay display, ITrackCancel trackCancel) throws java.io.IOException, AutomationException
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.
draw
in interface ILayer
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)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getLegendGroupCount() throws java.io.IOException, AutomationException
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.
getLegendGroupCount
in interface ILegendInfo
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ILegendGroup getLegendGroup(int index) throws java.io.IOException, AutomationException
getLegendGroup
in interface ILegendInfo
index
- The index (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ILegendItem getLegendItem() throws java.io.IOException, AutomationException
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.
getLegendItem
in interface ILegendInfo
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isSymbolsAreGraduated() throws java.io.IOException, AutomationException
Indicates whether the symbols used for a layer or renderer's legend vary by size.
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.
isSymbolsAreGraduated
in interface ILegendInfo
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSymbolsAreGraduated(boolean symbolsAreGraduated) throws java.io.IOException, AutomationException
setSymbolsAreGraduated
in interface ILegendInfo
symbolsAreGraduated
- The symbolsAreGraduated (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISpatialReference getSpatialReference() throws java.io.IOException, AutomationException
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.
getSpatialReference
in interface IGeoDataset
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnvelope getExtent() throws java.io.IOException, AutomationException
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.
getExtent
in interface IGeoDataset
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void isDirty() throws java.io.IOException, AutomationException
isDirty
in interface IPersistStream
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void load(IStream pstm) throws java.io.IOException, AutomationException
load
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void save(IStream pstm, int fClearDirty) throws java.io.IOException, AutomationException
save
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)fClearDirty
- The fClearDirty (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getSizeMax(_ULARGE_INTEGER[] pcbSize) throws java.io.IOException, AutomationException
getSizeMax
in interface IPersistStream
pcbSize
- A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getClassID(GUID[] pClassID) throws java.io.IOException, AutomationException
getClassID
in interface IPersist
pClassID
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getLastMinimumScale() throws java.io.IOException, AutomationException
getLastMinimumScale
in interface ILayerGeneralProperties
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getLastMaximumScale() throws java.io.IOException, AutomationException
getLastMaximumScale
in interface ILayerGeneralProperties
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String ILayerGeneralProperties_getLayerDescription() throws java.io.IOException, AutomationException
ILayerGeneralProperties_getLayerDescription
in interface ILayerGeneralProperties
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setLayerDescription(java.lang.String text) throws java.io.IOException, AutomationException
setLayerDescription
in interface ILayerGeneralProperties
text
- The text (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IArray find(java.lang.String search, boolean contains, java.lang.Object fields, ITrackCancel trackCancel) throws java.io.IOException, AutomationException
find
in interface IFind
search
- The search (in)contains
- The contains (in)fields
- A Variant (in)trackCancel
- A reference to a com.esri.arcgis.system.ITrackCancel (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.Object getFindFields() throws java.io.IOException, AutomationException
getFindFields
in interface IFind
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getFindDisplayField() throws java.io.IOException, AutomationException
getFindDisplayField
in interface IFind
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isDrawingPropsDirty() throws java.io.IOException, AutomationException
isDrawingPropsDirty
in interface ILayerDrawingProperties
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDrawingPropsDirty(boolean dirty) throws java.io.IOException, AutomationException
setDrawingPropsDirty
in interface ILayerDrawingProperties
dirty
- The dirty (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException
writeExternal
in interface java.io.Externalizable
java.io.IOException
public void readExternal(java.io.ObjectInput in) throws java.io.IOException, java.lang.ClassNotFoundException
readExternal
in interface java.io.Externalizable
java.io.IOException
java.lang.ClassNotFoundException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |