com.esri.arcgis.carto
Class FeatureLayerDrawingDescription

java.lang.Object
  extended by com.esri.arcgis.carto.FeatureLayerDrawingDescription
All Implemented Interfaces:
IFeatureLayerDrawingDescription, IFeatureLayerDrawingDescription2, ILayerDrawingDescription, ILayerEffects, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class FeatureLayerDrawingDescription
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IFeatureLayerDrawingDescription, IFeatureLayerDrawingDescription2, ILayerDrawingDescription, IXMLSerialize, IPersistStream, IPersist, ILayerEffects, Externalizable

Feature layer drawing description.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
FeatureLayerDrawingDescription()
          Constructs a FeatureLayerDrawingDescription using ArcGIS Engine.
FeatureLayerDrawingDescription(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
FeatureLayerDrawingDescription theFeatureLayerDrawingDescription = (FeatureLayerDrawingDescription) obj;
 
Method Summary
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 boolean equals(Object o)
          Compare this object with another
 short getBrightness()
          Layer brightness in percent (-100 - 100).
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 short getContrast()
          Layer contrast in percent (-100 - 100).
 IFeatureRenderer getFeatureRenderer()
          FeatureRenderer used to represent symbology of a feature layer.
 ILabelingDescription getLabelingDescription()
          LabelingDescription.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int getSourceLayerID()
          Source LayerID.
 short getTransparency()
          Layer transparency in percent (0-100).
 int hashCode()
          the hashcode for this object
 void isDirty()
          isDirty
 boolean isScaleSymbols()
          Indicates if symbols are scaled for the layer.
 boolean isSupportsBrightnessChange()
          Indicates if the layer supports brightness changes.
 boolean isSupportsContrastChange()
          Indicates if the layer supports contrast changes.
 boolean isSupportsInteractive()
          Indicates if the layer supports interactive effects changes.
 boolean isSupportsTransparency()
          Indicates if the layer supports transparency.
 void load(IStream pstm)
          load
 void readExternal(ObjectInput in)
           
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 void setBrightness(short brightnessValue)
          Layer brightness in percent (-100 - 100).
 void setContrast(short contrastValue)
          Layer contrast in percent (-100 - 100).
 void setFeatureRendererByRef(IFeatureRenderer ppRenderer)
          FeatureRenderer used to represent symbology of a feature layer.
 void setLabelingDescription(ILabelingDescription ppLabelingDescription)
          LabelingDescription.
 void setScaleSymbols(boolean scale)
          Indicates if symbols are scaled for the layer.
 void setSourceLayerID(int pSourceLayerID)
          Source LayerID.
 void setSupportsInteractive(boolean supported)
          Indicates if the layer supports interactive effects changes.
 void setTransparency(short alpha)
          Layer transparency in percent (0-100).
 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

FeatureLayerDrawingDescription

public FeatureLayerDrawingDescription()
                               throws IOException,
                                      UnknownHostException
Constructs a FeatureLayerDrawingDescription using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

FeatureLayerDrawingDescription

public FeatureLayerDrawingDescription(Object obj)
                               throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
FeatureLayerDrawingDescription theFeatureLayerDrawingDescription = (FeatureLayerDrawingDescription) obj;

Construct a FeatureLayerDrawingDescription using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to FeatureLayerDrawingDescription.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

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

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getFeatureRenderer

public IFeatureRenderer getFeatureRenderer()
                                    throws IOException,
                                           AutomationException
FeatureRenderer used to represent symbology of a feature layer.

Product Availability

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

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

setFeatureRendererByRef

public void setFeatureRendererByRef(IFeatureRenderer ppRenderer)
                             throws IOException,
                                    AutomationException
FeatureRenderer used to represent symbology of a feature layer.

Product Availability

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

Specified by:
setFeatureRendererByRef in interface IFeatureLayerDrawingDescription
Specified by:
setFeatureRendererByRef in interface IFeatureLayerDrawingDescription2
Parameters:
ppRenderer - A reference to a com.esri.arcgis.carto.IFeatureRenderer (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isScaleSymbols

public boolean isScaleSymbols()
                       throws IOException,
                              AutomationException
Indicates if symbols are scaled for the layer.

Product Availability

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

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

setScaleSymbols

public void setScaleSymbols(boolean scale)
                     throws IOException,
                            AutomationException
Indicates if symbols are scaled for the layer.

Product Availability

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

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

getSourceLayerID

public int getSourceLayerID()
                     throws IOException,
                            AutomationException
Source LayerID.

Remarks

Use SourceLayerID to match this with the original LayerDescription.

Product Availability

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

Specified by:
getSourceLayerID in interface IFeatureLayerDrawingDescription2
Returns:
The pSourceLayerID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSourceLayerID

public void setSourceLayerID(int pSourceLayerID)
                      throws IOException,
                             AutomationException
Source LayerID.

Product Availability

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

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

getLabelingDescription

public ILabelingDescription getLabelingDescription()
                                            throws IOException,
                                                   AutomationException
LabelingDescription.

Product Availability

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

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

setLabelingDescription

public void setLabelingDescription(ILabelingDescription ppLabelingDescription)
                            throws IOException,
                                   AutomationException
LabelingDescription.

Product Availability

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

Specified by:
setLabelingDescription in interface IFeatureLayerDrawingDescription2
Parameters:
ppLabelingDescription - A reference to a com.esri.arcgis.carto.ILabelingDescription (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException
Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
serialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException
Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
deserialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException
isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDirty in interface IPersistStream
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException
load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException
save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException
getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException
getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSupportsTransparency

public boolean isSupportsTransparency()
                               throws IOException,
                                      AutomationException
Indicates if the layer supports transparency.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isSupportsTransparency in interface ILayerEffects
Returns:
The supported
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSupportsContrastChange

public boolean isSupportsContrastChange()
                                 throws IOException,
                                        AutomationException
Indicates if the layer supports contrast changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isSupportsContrastChange in interface ILayerEffects
Returns:
The supported
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSupportsBrightnessChange

public boolean isSupportsBrightnessChange()
                                   throws IOException,
                                          AutomationException
Indicates if the layer supports brightness changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isSupportsBrightnessChange in interface ILayerEffects
Returns:
The supported
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSupportsInteractive

public void setSupportsInteractive(boolean supported)
                            throws IOException,
                                   AutomationException
Indicates if the layer supports interactive effects changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isSupportsInteractive

public boolean isSupportsInteractive()
                              throws IOException,
                                     AutomationException
Indicates if the layer supports interactive effects changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isSupportsInteractive in interface ILayerEffects
Returns:
The supported
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTransparency

public short getTransparency()
                      throws IOException,
                             AutomationException
Layer transparency in percent (0-100).

Remarks

When you set Transparency for a FeatureLayer, a TransparencyDisplayFilter is created and applied to the layer. You can accomplish the same effect by manually creating a new TransparencyDisplayFilter using IDisplayFilter, and then assigning it to a layer using IDisplayFilterManager.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getTransparency in interface ILayerEffects
Returns:
The alpha
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTransparency

public void setTransparency(short alpha)
                     throws IOException,
                            AutomationException
Layer transparency in percent (0-100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getContrast

public short getContrast()
                  throws IOException,
                         AutomationException
Layer contrast in percent (-100 - 100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getContrast in interface ILayerEffects
Returns:
The contrastValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setContrast

public void setContrast(short contrastValue)
                 throws IOException,
                        AutomationException
Layer contrast in percent (-100 - 100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getBrightness

public short getBrightness()
                    throws IOException,
                           AutomationException
Layer brightness in percent (-100 - 100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBrightness in interface ILayerEffects
Returns:
The brightnessValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBrightness

public void setBrightness(short brightnessValue)
                   throws IOException,
                          AutomationException
Layer brightness in percent (-100 - 100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBrightness in interface ILayerEffects
Parameters:
brightnessValue - The brightnessValue (in)
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
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Throws:
IOException
ClassNotFoundException