com.esri.arcgis.carto
Class IMapServerSublayerProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.carto.IMapServerSublayerProxy
All Implemented Interfaces:
IMapServerSublayer, Externalizable, Serializable

public class IMapServerSublayerProxy
extends com.esri.arcgis.interop.Dispatch
implements IMapServerSublayer, Serializable

Provides access to the available properties of a map server sublayer object.

Superseded By

IMapServerSublayer2

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  IMapServerSublayerProxy()
           
  IMapServerSublayerProxy(Object obj)
           
protected IMapServerSublayerProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 ILayerDescription getLayerDescription()
          The layer description.
 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.
 void readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 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 writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IMapServerSublayerProxy

public IMapServerSublayerProxy()

IMapServerSublayerProxy

public IMapServerSublayerProxy(Object obj)
                        throws IOException
Throws:
IOException

IMapServerSublayerProxy

protected IMapServerSublayerProxy(Object obj,
                                  String iid)
                           throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

isHasLabels

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isShowLabels

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

Remarks

This only applies to layers where the property HasLabels on IMapServerSubLayer is TRUE. This means that the layer's labels must be "on" in the original map document.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setShowLabels

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isScaleSymbols

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

Remarks

A reference scale set for a map containing a Map Server object will have no effect on Map Server layer symbology. In order for symbols to scale, the originial map document on which the Map Server object is based must have a reference scale set. The Map layer must also support symbol scaling. If both these conditions are true, use ScaleSymbols to activate or deactivate a Map Server Sublayer's symbol scaling.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setScaleSymbols

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getLayerDescription

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

Remarks

Use LayerDescription to access properties of ILayerDescription. The ID value may not match the Layer index value on ICompositeLayer or ICompositeLayer2. This is because the count on ICompositeLayer or ICompositeLayer2 does not include members of composite layers embedded within the MapServerSublayer. Only the parent layer is counted.

MapServerSubLayer does not support the ILayerDescription properties ScaleSymbols, ShowLabels and Visible. ScaleSymbols and ShowLabels can be accessed via IMapServerSubLayer. The property controlling a MapServerSubLayers visibility, Visible, can be accessed via ILayer.

The ILayerDescription properties SelectionFeatures, SelectionColor, SelectionSymbol, SetSelectionSymbol, SelectionBufferDistance and ShowSelectionBuffer can be used to select and buffer (euclidean buffer) features of a Map Server SubLayer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException