|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.carto.IMSSubLayer
public class IMSSubLayer
An IMS Layer as a sublayer of an IMSMapLayer.
Constructor Summary | |
---|---|
IMSSubLayer(Object obj)
Construct a IMSSubLayer using a reference to such an object returned from ArcGIS Engine or Server. |
Method Summary | |
---|---|
Object |
convertToSupportedObject(int docVersion)
Convert the object to another object that is supported. |
void |
draw(int drawPhase,
IDisplay display,
ITrackCancel trackCancel)
Draws the layer to the specified display for the given draw phase. |
boolean |
equals(Object o)
Compare this object with another |
IEnvelope |
getAreaOfInterest()
The default area of interest for the layer. |
void |
getClassID(GUID[] pClassID)
getClassID |
String |
getDataDetails(String bsPadding)
Details of the layer's data. |
IEnvelope |
getExtent()
The extent of the GeoDataset. |
IACLayer |
getIMSLayer()
The IMS layer. |
double |
getLastMaximumScale()
Last maximum scale setting used by layer. |
double |
getLastMinimumScale()
Last minimum scale setting used by layer. |
double |
getLayerWeight()
Default layer position. |
double |
getMaximumScale()
Maximum scale (representative fraction) at which the layer will display. |
double |
getMinimumScale()
Minimum scale (representative fraction) at which the layer will display. |
String |
getName()
Layer name. |
String |
getPublishingDescription()
The layer description reported to the publisher. |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
ISpatialReference |
getSpatialReference()
The spatial reference of the GeoDataset. |
int |
getSupportedDrawPhases()
Supported draw phases. |
String |
getTipText(double x,
double y,
double tolerance)
Map tip text at the specified location. |
int |
hashCode()
the hashcode for this object |
String |
ILayerGeneralProperties_getLayerDescription()
Description for the layer. |
boolean |
isCached()
Indicates if the layer needs its own display cache. |
boolean |
isCanIdentify()
Indicates if this layer is included in identify. |
boolean |
isDataValid()
Indicates if the data for the layer is currently valid. |
void |
isDirty()
isDirty |
boolean |
isScaleRangeReadOnly()
Indicates if the minimum and maximum scale range values are read-only. |
boolean |
isShowTips()
Indicates if the layer shows map tips. |
boolean |
isSupportedAtVersion(int docVersion)
Is this object valid at the given document version. |
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(ObjectInput in)
|
void |
save(IStream pstm,
int fClearDirty)
save |
void |
setAreaOfInterest(IEnvelope aoi)
The default area of interest for the layer. |
void |
setCached(boolean cached)
Indicates if the layer needs its own display cache. |
void |
setCanIdentify(boolean flag)
Indicates if this layer is included in identify. |
void |
setLayerDescription(String text)
Description for the layer. |
void |
setLayerWeight(double layerWeight)
Default layer position. |
void |
setMaximumScale(double maxScale)
Maximum scale (representative fraction) at which the layer will display. |
void |
setMinimumScale(double minScale)
Minimum scale (representative fraction) at which the layer will display. |
void |
setName(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 |
setSymbologyUpdated(boolean rhs1)
Indicates if this layers symbology has been updated. |
void |
setVisible(boolean visible)
Indicates if the layer is currently visible. |
void |
writeExternal(ObjectOutput out)
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
---|
getJintegraDispatch, release |
Constructor Detail |
---|
public IMSSubLayer(Object obj) throws IOException
obj
to IMSSubLayer
. *
IMSSubLayer o = (IMSSubLayer)obj; // will not work
IMSSubLayer o = new IMSSubLayer(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server
IOException
- if there are interop problems
IMSSubLayer theIMSSubLayer = (IMSSubLayer) obj;
Method Detail |
---|
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public boolean isCanIdentify() throws IOException, AutomationException
isCanIdentify
in interface IIMSSubLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCanIdentify(boolean flag) throws IOException, AutomationException
setCanIdentify
in interface IIMSSubLayer
flag
- The flag (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IACLayer getIMSLayer() throws IOException, AutomationException
getIMSLayer
in interface IIMSSubLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSymbologyUpdated(boolean rhs1) throws IOException, AutomationException
setSymbologyUpdated
in interface IIMSSubLayer
rhs1
- The rhs1 (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getName() throws IOException, AutomationException
Use this property to associate a string with a layer.
getName
in interface ILayer
getName
in interface ILayer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setName(String name) throws IOException, AutomationException
setName
in interface ILayer
setName
in interface ILayer2
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isValid() throws 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
isValid
in interface ILayer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnvelope getAreaOfInterest() throws IOException, AutomationException
Returns the spatial-referenced extent of the layer.
getAreaOfInterest
in interface ILayer
getAreaOfInterest
in interface ILayer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getMinimumScale() throws 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
getMinimumScale
in interface ILayer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMinimumScale(double minScale) throws IOException, AutomationException
setMinimumScale
in interface ILayer
setMinimumScale
in interface ILayer2
minScale
- The minScale (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getMaximumScale() throws 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
getMaximumScale
in interface ILayer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMaximumScale(double maxScale) throws IOException, AutomationException
setMaximumScale
in interface ILayer
setMaximumScale
in interface ILayer2
maxScale
- The maxScale (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isVisible() throws IOException, AutomationException
isVisible
in interface ILayer
isVisible
in interface ILayer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setVisible(boolean visible) throws IOException, AutomationException
setVisible
in interface ILayer
setVisible
in interface ILayer2
visible
- The visible (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isShowTips() throws 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
isShowTips
in interface ILayer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setShowTips(boolean show) throws IOException, AutomationException
setShowTips
in interface ILayer
setShowTips
in interface ILayer2
show
- The show (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getTipText(double x, double y, double tolerance) throws IOException, AutomationException
getTipText
in interface ILayer
getTipText
in interface ILayer2
x
- The x (in)y
- The y (in)tolerance
- The tolerance (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isCached() throws 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
isCached
in interface ILayer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCached(boolean cached) throws IOException, AutomationException
Informational property. Container is responsible for cache management.
setCached
in interface ILayer
setCached
in interface ILayer2
cached
- The cached (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getSupportedDrawPhases() throws 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
getSupportedDrawPhases
in interface ILayer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSpatialReferenceByRef(ISpatialReference rhs1) throws 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
setSpatialReferenceByRef
in interface ILayer2
rhs1
- A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void draw(int drawPhase, IDisplay display, ITrackCancel trackCancel) throws 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
draw
in interface ILayer2
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)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isSupportsPublishing() throws IOException, AutomationException
isSupportsPublishing
in interface IPublishLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getPublishingDescription() throws IOException, AutomationException
getPublishingDescription
in interface IPublishLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isDataValid() throws IOException, AutomationException
isDataValid
in interface IPublishLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getDataDetails(String bsPadding) throws IOException, AutomationException
getDataDetails
in interface IPublishLayer
bsPadding
- The bsPadding (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void prepareForPublishing() throws IOException, AutomationException
prepareForPublishing
in interface IPublishLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getLastMinimumScale() throws IOException, AutomationException
getLastMinimumScale
in interface ILayerGeneralProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getLastMaximumScale() throws IOException, AutomationException
getLastMaximumScale
in interface ILayerGeneralProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String ILayerGeneralProperties_getLayerDescription() throws IOException, AutomationException
ILayerGeneralProperties_getLayerDescription
in interface ILayerGeneralProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setLayerDescription(String text) throws IOException, AutomationException
setLayerDescription
in interface ILayerGeneralProperties
text
- The text (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void isDirty() throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
isDirty
in interface IPersistStream
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void load(IStream pstm) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
load
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void save(IStream pstm, int fClearDirty) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
save
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)fClearDirty
- The fClearDirty (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getSizeMax(_ULARGE_INTEGER[] pcbSize) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
getSizeMax
in interface IPersistStream
pcbSize
- A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getClassID(GUID[] pClassID) throws IOException, AutomationException
IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID
in interface IPersist
pClassID
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isScaleRangeReadOnly() throws IOException, AutomationException
Some layer types do not support a writeable MinimumScale or MaximumScale. Use this property to determine whether or not a layer supports this.
isScaleRangeReadOnly
in interface ILayer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setAreaOfInterest(IEnvelope aoi) throws IOException, AutomationException
setAreaOfInterest
in interface ILayer2
aoi
- A reference to a com.esri.arcgis.geometry.IEnvelope (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getLayerWeight() throws IOException, AutomationException
The LayerWeight property defines the weight of the layer in the auto arrange order. During auto arrange, the higher weight layers are added to the map first, which means they draw lower in the draw order.
Default weights for layers are these values:
Annotation layers = 97
Points layers = 98
Polyline layers = 99
Polygon Layers = 100
getLayerWeight
in interface ILayerPosition
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setLayerWeight(double layerWeight) throws IOException, AutomationException
setLayerWeight
in interface ILayerPosition
layerWeight
- The layerWeight (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISpatialReference getSpatialReference() throws 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
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnvelope getExtent() throws 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
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isSupportedAtVersion(int docVersion) throws IOException, AutomationException
Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.
isSupportedAtVersion
in interface IDocumentVersionSupportGEN
docVersion
- A com.esri.arcgis.system.esriArcGISVersion constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object convertToSupportedObject(int docVersion) throws IOException, AutomationException
This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.
convertToSupportedObject
in interface IDocumentVersionSupportGEN
docVersion
- A com.esri.arcgis.system.esriArcGISVersion constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void writeExternal(ObjectOutput out) throws IOException
writeExternal
in interface Externalizable
IOException
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
readExternal
in interface Externalizable
IOException
ClassNotFoundException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |