|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.carto.WMSLayer
public class WMSLayer
COM Class 'WMSLayer'. Generated 3/19/2015 1:20:42 PM from 'C:\ArcGIS\COM\esriCarto.olb'
Description 'A container for the display of WMS sub layers.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =
Field Summary | |
---|---|
static long |
serialVersionUID
|
Fields inherited from interface com.esri.arcgis.carto.IWMSLayer |
---|
IID, IID005f592a_327b_44a4_aeeb_409d2f866f47, 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.ILayerSymbologyExtents |
---|
IID, IID02cbda2f_d2e8_4b28_af9c_71cb096213e1, xxDummy |
Fields inherited from interface com.esri.arcgis.carto.IWMSLayer2 |
---|
IID, IID27abb9ec_7a26_4cf8_8bd4_70ec1d274e17, xxDummy |
Fields inherited from interface com.esri.arcgis.system.IPersistStream |
---|
IID, IID00000109_0000_0000_c000_000000000046, xxDummy |
Fields inherited from interface com.esri.arcgis.system.IPersist |
---|
IID0000010c_0000_0000_c000_000000000046 |
Constructor Summary | |
---|---|
WMSLayer(java.lang.Object obj)
Construct a WMSLayer using a reference to such an object returned from ArcGIS Engine or Server. |
Method Summary | |
---|---|
void |
addILayerEventsListener(ILayerEvents theListener)
addILayerEventsListener. |
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 |
void |
expandRegionForSymbols(IDisplay pDisplay,
IGeometry pRegion)
Enlarges the specified region if necessary to account for the symbology sizes. |
IEnvelope |
getAreaOfInterest()
The default area of interest for the layer. |
void |
getClassID(GUID[] pClassID)
getClassID |
java.lang.String |
getDataDetails(java.lang.String bsPadding)
Details of the layer's data. |
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. |
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. |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
IWMSLayerStyleDescription |
getStyle()
Active style that will be used for drawing. |
int |
getSupportedDrawPhases()
Supported draw phases. |
java.lang.String |
getTipText(double x,
double y,
double tolerance)
Map tip text at the specified location. |
IWMSLayerDescription |
getWMSLayerDescription()
Associated WMSLayerDescription. |
IWMSServiceDescription |
getWMSServiceDescription()
Associated WMSServiceDescription. |
int |
hashCode()
the hashcode for this object |
IArray |
identify(IGeometry pGeom)
Identifies objects at the specified location. |
java.lang.String |
ILayerGeneralProperties_getLayerDescription()
Description for the layer. |
boolean |
isCached()
Indicates if the layer needs its own display cache. |
boolean |
isDataValid()
Indicates if the data for the layer is currently valid. |
void |
isDirty()
isDirty |
boolean |
isShowTips()
Indicates if the layer shows map tips. |
boolean |
isSupportsPublishing()
Indicates if the layer supports the publishing process. |
boolean |
isValid()
Indicates if the layer is currently valid. |
boolean |
isVisible()
Indicates if the layer is currently visible. |
void |
load(IStream pstm)
load |
void |
prepareForPublishing()
Prepare the layer for the publishing process. |
void |
readExternal(java.io.ObjectInput in)
|
void |
release()
Release a WMSLayer. |
void |
removeILayerEventsListener(ILayerEvents theListener)
removeILayerEventsListener. |
void |
save(IStream pstm,
int fClearDirty)
save |
void |
setCached(boolean cached)
Indicates if the layer needs its own display cache. |
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 |
setShowTips(boolean show)
Indicates if the layer shows map tips. |
void |
setSpatialReferenceByRef(ISpatialReference rhs1)
Spatial reference for the layer. |
void |
setStyleByRef(IWMSLayerStyleDescription style)
Active style that will be used for drawing. |
void |
setVisible(boolean visible)
Indicates if the layer is currently visible. |
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 WMSLayer(java.lang.Object obj) throws java.io.IOException
obj
to WMSLayer
. *
WMSLayer o = (WMSLayer)obj; // will not work
WMSLayer o = new WMSLayer(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server
java.io.IOException
- if there are interop problems
WMSLayer theWMSLayer = (WMSLayer) 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 addILayerEventsListener(ILayerEvents theListener) throws java.io.IOException
theListener
- An object that implements the com.esri.arcgis.carto.ILayerEvents interface.
java.io.IOException
- If there are communications problems.public void removeILayerEventsListener(ILayerEvents theListener) throws java.io.IOException
theListener
- An object that implements the com.esri.arcgis.carto.ILayerEvents interface.
java.io.IOException
- If there are communications problems.public void release()
release
in interface com.esri.arcgis.interop.RemoteObjRef
public IWMSLayerDescription getWMSLayerDescription() throws java.io.IOException, AutomationException
getWMSLayerDescription
in interface IWMSLayer
getWMSLayerDescription
in interface IWMSLayer2
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IWMSServiceDescription getWMSServiceDescription() throws java.io.IOException, AutomationException
getWMSServiceDescription
in interface IWMSLayer
getWMSServiceDescription
in interface IWMSLayer2
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 boolean isSupportsPublishing() throws java.io.IOException, AutomationException
isSupportsPublishing
in interface IPublishLayer
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getPublishingDescription() throws java.io.IOException, AutomationException
getPublishingDescription
in interface IPublishLayer
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isDataValid() throws java.io.IOException, AutomationException
isDataValid
in interface IPublishLayer
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getDataDetails(java.lang.String bsPadding) throws java.io.IOException, AutomationException
getDataDetails
in interface IPublishLayer
bsPadding
- The bsPadding (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void prepareForPublishing() throws java.io.IOException, AutomationException
prepareForPublishing
in interface IPublishLayer
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 identify(IGeometry pGeom) throws java.io.IOException, AutomationException
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.
identify
in interface IIdentify
pGeom
- A reference to a com.esri.arcgis.geometry.IGeometry (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void expandRegionForSymbols(IDisplay pDisplay, IGeometry pRegion) throws java.io.IOException, AutomationException
expandRegionForSymbols
in interface ILayerSymbologyExtents
pDisplay
- A reference to a com.esri.arcgis.display.IDisplay (in)pRegion
- A reference to a com.esri.arcgis.geometry.IGeometry (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setStyleByRef(IWMSLayerStyleDescription style) throws java.io.IOException, AutomationException
setStyleByRef
in interface IWMSLayer2
style
- A reference to a com.esri.arcgis.gisclient.IWMSLayerStyleDescription (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IWMSLayerStyleDescription getStyle() throws java.io.IOException, AutomationException
getStyle
in interface IWMSLayer2
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 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 |