com.esri.aims.mtier.model.map.layer
Class AcetateLayer

java.lang.Object
  extended by com.esri.aims.mtier.model.map.layer.Layer
      extended by com.esri.aims.mtier.model.map.layer.AcetateLayer
All Implemented Interfaces:
Serializable

public class AcetateLayer
extends Layer

Implements an ArcIMS acetate layer. The AcetateLayer class extends the Layer class.

See Also:
Serialized Form

Constructor Summary
AcetateLayer(String id, String maxScale, String minScale)
          Creates an instance of an AcetateLayer object.
 
Method Summary
 void add(Object acetateObject)
          Deprecated. As of ArcIMS 4.0.1 Java Connector, replaced by addAcetate(com.esri.aims.mtier.model.acetate.Acetate).
 void addAcetate(Acetate newAcetate)
          Adds the given acetate to this acetate layer collection.
 void clear()
          Clears all Acetate objects from the acetate layer collection.
 Acetate getAcetateObject(int index)
          Returns an Acetate object at given index from the objects collection.
 Vector getAcetateObjectsCollection()
          Returns collection of all acetate layer objects.
 int getCount()
          Returns the count of the Acetate objects in the acetate layer collection.
 String getType()
          Returns a name string that describes the Layer type.
 void remove(int index)
          Removes an acetate object from the acetate layer collection at given index.
 
Methods inherited from class com.esri.aims.mtier.model.map.layer.Layer
getID, getMaxScale, getMinScale, getName, isVisible, setID, setMaxScale, setMinScale, setName, setVisible
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AcetateLayer

public AcetateLayer(String id,
                    String maxScale,
                    String minScale)
Creates an instance of an AcetateLayer object.

AcetateLayer acetateLayer = new AcetateLayer("1","1:24000", "1:25000");

Parameters:
id - the layer identifier to assign.
maxScale - the layers max- scale value to assign.
minScale - the layers min- scale value to assign.
Method Detail

getType

public String getType()
Returns a name string that describes the Layer type.

Specified by:
getType in class Layer
Returns:
a name string that reads "Acetate".

add

public void add(Object acetateObject)
Deprecated. As of ArcIMS 4.0.1 Java Connector, replaced by addAcetate(com.esri.aims.mtier.model.acetate.Acetate).

Adds the given acetate object to this acetate layer collection.

 Point point = new Point();
 point.setX(-125.0);
 point.setY(45.0);
 Acetate acetate = new Acetate();
 acetate.setObject(point);
 acetateLayer.add(acetate);
 

Parameters:
acetateObject - the object to add.
See Also:
getAcetateObject(int)

getAcetateObject

public Acetate getAcetateObject(int index)
Returns an Acetate object at given index from the objects collection.

 Acetate acetate = acetateLayer.getAcetateObject(0);
 

Parameters:
index - the index at which the Acetate object is located.
Returns:
an Acetate object

getCount

public int getCount()
Returns the count of the Acetate objects in the acetate layer collection.

int count = acetateLayer.getCount();

Returns:
the acetate object count.

remove

public void remove(int index)
Removes an acetate object from the acetate layer collection at given index.

acetateLayer.remove(0);

Parameters:
index - the index at which the acetate object is located.
See Also:
add(java.lang.Object), clear()

clear

public void clear()
Clears all Acetate objects from the acetate layer collection.

acetateLayer.clear();

See Also:
add(java.lang.Object), remove(int)

getAcetateObjectsCollection

public Vector getAcetateObjectsCollection()
Returns collection of all acetate layer objects.

Vector aObjects = acetateLayer.getAcetateObjectsCollection();

Returns:
a Vector object
See Also:
add(java.lang.Object), remove(int), getAcetateObject(int)

addAcetate

public void addAcetate(Acetate newAcetate)
Adds the given acetate to this acetate layer collection.

 Point point = new Point();
 point.setX(-125.0);
 point.setY(45.0);
 Acetate acetate = new Acetate();
 acetate.setAcetateElement(point);
 acetateLayer.addAcetate(acetate);