com.esri.arcgis.carto
Class ACAcetateLayer

java.lang.Object
  com.esri.arcgis.carto.ACAcetateLayer

All Implemented Interfaces:

IACAcetateLayer, IACAcetateLayerAdmin, IACLayer, IPersist, IPersistStream, java.io.Serializable

public class ACAcetateLayer

extends java.lang.Object

implements IACLayer, IACAcetateLayer, IACAcetateLayerAdmin, IPersist, IPersistStream

ArcIMS container for drawing graphics on top of the map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

ACAcetateLayer()
Constructs a ACAcetateLayer using ArcGIS Engine.

ACAcetateLayer(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary

void	connect(java.lang.String layerInfo, IIMSAxlRequest request, ISpatialReference spatialRef, int mapUnits) Connects to the acetate layer.
boolean	equals(java.lang.Object o) Compare this object with another
IACAcetateLayer	getAsIACAcetateLayer() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IACAcetateLayerAdmin	getAsIACAcetateLayerAdmin() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IACLayer	getAsIACLayer() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersist	getAsIPersist() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersistStream	getAsIPersistStream() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
void	getClassID(GUID[] pClassID) Supported Platforms
static java.lang.String	getClsid()
IEnvelope	getExtent() The extent of the layer.
java.lang.String	getID() The layer id.
java.lang.Object	getLayerDefAxl() The layer def axl.
double	getMaxScale() Maximum scale at which the layer will display.
double	getMinScale() Minimum scale at which the layer will display.
java.lang.String	getName() The layer name.
ISpatialReference	getNativeSpatialReference() The native spatial reference of the data.
java.lang.String	getOriginalName() The name of the layer that the ArcIMS Server hands out.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) Supported Platforms
int	hashCode() the hashcode for this object
void	isDirty() Supported Platforms
boolean	isDisplayNorthArrow() Indicates if the layer displays the north arrow.
boolean	isDisplayScaleBar() Indicates if the layer displays the scale bar.
boolean	isVisible() Indicates if the layer is currently visible.
void	load(IStream pstm) Supported Platforms
void	save(IStream pstm, int fClearDirty) Supported Platforms
void	setDisplayNorthArrow(boolean flag) Indicates if the layer displays the north arrow.
void	setDisplayScaleBar(boolean flag) Indicates if the layer displays the scale bar.
void	setID(java.lang.String iD) The layer id.
void	setMaxScale(double scale) Maximum scale at which the layer will display.
void	setMinScale(double scale) Minimum scale at which the layer will display.
void	setName(java.lang.String name) The layer name.
void	setOriginalName(java.lang.String name) The name of the layer that the ArcIMS Server hands out.
void	setVisible(boolean visible) Indicates if the layer is currently visible.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ACAcetateLayer

public ACAcetateLayer()
               throws java.io.IOException,
                      java.net.UnknownHostException

Constructs a ACAcetateLayer using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ACAcetateLayer

public ACAcetateLayer(java.lang.Object obj)
               throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Construct a ACAcetateLayer using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ACAcetateLayer.
ACAcetateLayer theACAcetateLayer = (ACAcetateLayer) obj;

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getAsIACLayer

public IACLayer getAsIACLayer()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIACAcetateLayer

public IACAcetateLayer getAsIACAcetateLayer()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIACAcetateLayerAdmin

public IACAcetateLayerAdmin getAsIACAcetateLayerAdmin()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersist

public IPersist getAsIPersist()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersistStream

public IPersistStream getAsIPersistStream()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IACLayer

The layer name.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IACLayer

Returns:

The name

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IACLayer

The layer name.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface IACLayer

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOriginalName

public java.lang.String getOriginalName()
                                 throws java.io.IOException,
                                        AutomationException

Description copied from interface: IACLayer

The name of the layer that the ArcIMS Server hands out.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOriginalName in interface IACLayer

Returns:

The name

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setOriginalName

public void setOriginalName(java.lang.String name)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IACLayer

The name of the layer that the ArcIMS Server hands out.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOriginalName in interface IACLayer

Parameters:

name - The name (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getID

public java.lang.String getID()
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IACLayer

The layer id.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getID in interface IACLayer

Returns:

The iD

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setID

public void setID(java.lang.String iD)
           throws java.io.IOException,
                  AutomationException

Description copied from interface: IACLayer

The layer id.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setID in interface IACLayer

Parameters:

iD - The iD (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

isVisible

public boolean isVisible()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IACLayer

Indicates if the layer is currently visible.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isVisible in interface IACLayer

Returns:

The visible

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setVisible

public void setVisible(boolean visible)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IACLayer

Indicates if the layer is currently visible.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setVisible in interface IACLayer

Parameters:

visible - The visible (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinScale

public double getMinScale()
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IACLayer

Minimum scale at which the layer will display.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMinScale in interface IACLayer

Returns:

The scale

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setMinScale

public void setMinScale(double scale)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IACLayer

Minimum scale at which the layer will display.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMinScale in interface IACLayer

Parameters:

scale - The scale (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getMaxScale

public double getMaxScale()
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IACLayer

Maximum scale at which the layer will display.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMaxScale in interface IACLayer

Returns:

The scale

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxScale

public void setMaxScale(double scale)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IACLayer

Maximum scale at which the layer will display.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMaxScale in interface IACLayer

Parameters:

scale - The scale (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerDefAxl

public java.lang.Object getLayerDefAxl()
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: IACLayer

The layer def axl.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLayerDefAxl in interface IACLayer

Returns:

A reference to another Object (IUnknown)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getExtent

public IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IACLayer

The extent of the layer.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExtent in interface IACLayer

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getNativeSpatialReference

public ISpatialReference getNativeSpatialReference()
                                            throws java.io.IOException,
                                                   AutomationException

Description copied from interface: IACLayer

The native spatial reference of the data.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNativeSpatialReference in interface IACLayer

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDisplayNorthArrow

public boolean isDisplayNorthArrow()
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IACAcetateLayer

Indicates if the layer displays the north arrow.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDisplayNorthArrow in interface IACAcetateLayer

Returns:

The flag

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayNorthArrow

public void setDisplayNorthArrow(boolean flag)
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IACAcetateLayer

Indicates if the layer displays the north arrow.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDisplayNorthArrow in interface IACAcetateLayer

Parameters:

flag - The flag (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

isDisplayScaleBar

public boolean isDisplayScaleBar()
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IACAcetateLayer

Indicates if the layer displays the scale bar.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDisplayScaleBar in interface IACAcetateLayer

Returns:

The flag

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayScaleBar

public void setDisplayScaleBar(boolean flag)
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IACAcetateLayer

Indicates if the layer displays the scale bar.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDisplayScaleBar in interface IACAcetateLayer

Parameters:

flag - The flag (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

connect

public void connect(java.lang.String layerInfo,
                    IIMSAxlRequest request,
                    ISpatialReference spatialRef,
                    int mapUnits)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IACAcetateLayerAdmin

Connects to the acetate layer.

Supported Platforms

Windows, Solaris, Linux

Specified by:

connect in interface IACAcetateLayerAdmin

Parameters:

layerInfo - The layerInfo (in)

request - A reference to a com.esri.arcgis.gisclient.IIMSAxlRequest (in)

spatialRef - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

mapUnits - A com.esri.arcgis.gisclient.acMapUnits constant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getClassID

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

Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

save

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.