com.moximedia.aims
Class AimsAcetateLayer

java.lang.Object
  com.moximedia.aims.AimsAcetateLayer

All Implemented Interfaces:

AimsLayer, AimsObject, java.lang.Cloneable, java.io.Serializable

public class AimsAcetateLayer

extends java.lang.Object

implements AimsObject, java.io.Serializable, AimsLayer, java.lang.Cloneable

Implementation of an ArcIMS acetate layer which is used to mark up a map with text, scalebar, north arrow, and other objects.

Author:

Doug Cates - www.moximedia.com

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.moximedia.aims.AimsObject

OBJECT_TYPE_ACETATE_LAYER, OBJECT_TYPE_FEATURE_LAYER, OBJECT_TYPE_FOLDER, OBJECT_TYPE_FOLDERS, OBJECT_TYPE_GROUP, OBJECT_TYPE_GROUPS, OBJECT_TYPE_IMAGE_LAYER, OBJECT_TYPE_WMS_LAYER

Fields inherited from interface com.moximedia.aims.AimsLayer

LAYER_TYPE_ACETATE, LAYER_TYPE_FEATURE, LAYER_TYPE_IMAGE, LAYER_TYPE_WMS

Constructor Summary

AimsAcetateLayer()
Creates a new AimsAcetateLayer with no arguments.

AimsAcetateLayer(java.lang.String layerName)
Creates a new AimsAcetateLayer with a specified name.

AimsAcetateLayer(java.lang.String id, java.lang.String layerName)
Creates a new AimsAcetateLayer with a specified name and ID.

Method Summary

void	addLayerListLegend(AimsLayerListLegend legend) Adds a layer list legend.
void	addObject(AimsAcetateObject obj) Adds an acetate object (AimsNorthArrowObject, AimsPointObject, etc.) to the AimsAcetateLayer.
void	adjustScaleFactors(double multiplier) Adjusts the scale factors for this layer.
void	adjustScaleFactors(java.lang.String inUnits, java.lang.String outUnits) Adjusts the scale factors for this layer.
boolean	canEdit() Gets a boolean value indicating whether a layer can be edited.
boolean	canFindByAttribute() Gets a boolean value indicating whether a layer can be queried using the find location by attribute tool.
boolean	canHideLabels() Returns a boolean value indicating whether labels can be hidden.
boolean	canHideLayerListLegend() Gets and indicator of whether the legend could be shown, true regardless of whether or not it is turned off.
boolean	canSelectByAttribute() Gets a boolean value indicating whether a layer can be queried using the select location by attribute tool.
boolean	canShowLayerListLegend() Gets and indicator of whether the legend could be shown, true regardless of whether or not it is turned off.
void	clearObjects() Removes all objects from the acetate layer.
java.lang.Object	clone() Creates a copy of this object.
boolean	getAddToDefaultFolder() Returns whether the acetate layer should be added to the default All Layers folder when no other folders have been defined.
java.lang.String	getAlias() Get the alias of the acetate layer
boolean	getCanClear() Reports whether the user can clear the layer using the clear tool.
boolean	getCanDrillIdentify() Gets a boolean value indicating whether the layer can be identified using the drill down identify tool.
boolean	getCanIdentify() Returns a boolean value indicating whether the acetate layer can be queried using the identify tools.
boolean	getCanSelect() Returns true if the layer is selectable.
boolean	getCanSetVisibility() Gets a boolean value indicating whether the layer can be turned on and off by the user.
boolean	getCanSetVisibilityBeyondScale() Gets a boolean value indicating whether the layer can be turned on and off by the user when the layer is beyond scale.
boolean	getCanSymbolize() Gets an indicator of whether the layer can be symbolized.
boolean	getCanZoomToLayer() Returns a boolean indicator of whether the zoom to layer extent function should be enabled for this layer.
AimsEnvelope	getExtent() Returns the extent of the layer.
java.lang.String	getId() Gets the ID of the acetate layer
boolean	getImmediateRefresh() Returns whether the map should immediately refresh when the map layer visibility is changed.
AimsLayerListLegend	getLayerListLegend() Gets and indicator of whether a layer list legend exists at this scale.
AimsLayerListLegends	getLayerListLegends() Gets the array of layer list legends for this layer.
int	getLayerType() Gets the layer type, AimsLayer.LAYER_TYPE_ACETATE
boolean	getLegendVisible() Returns whether the layer should be visible in the legend.
AimsMap	getMap() Gets the parent map for this layer
double	getMaxScale() Gets the maximum scale at which the acetate layer will be visible.
java.lang.String	getMetadataHandler() Returns the URL of the metadata handler page for this layer, or null if no metatata handler is defined.
java.lang.String	getMetadataUrl() Returns the URL to the metadata page for this layer, or null if no metatata URL is defined.
double	getMinScale() Gets the minimum scale at which the acetate layer will be visible.
java.lang.String	getName() Gets the name of the acetate layer
AimsAcetateObject	getObject(int index) Returns the acetate object at the specified index.
int	getObjectCount() Returns the number of objects contained in the acetate layer.
int	getObjectId() Returns the IMF internal id for this layer.
int	getObjectType() Gets the type of object this is.
java.lang.String	getProperty(java.lang.String name) Gets the value of a property set in the configuration XML using a <property> element.
AimsRecordset	getRecordset() Gets the recordset for the layer.
AimsRenderer	getRenderer() Gets the renderer used for the layer.
boolean	getShowSymbolizeIcon() Gets an indicator of whether the symbolize icon shows up in the layer list.
java.lang.Object	getTag() Gets the user defined object tag assosciated with this object.
java.lang.String	getType() Gets the layer type.
boolean	getVisible() Returns a boolean value indicating whether the acetate layer visibility is set.
boolean	hasLayerListLegend() Gets and indicator of whether a layer list legend exists at this scale.
boolean	hasObjectsVisible() Returns an indicator of whether objects are visible in the current map extent.
boolean	insertObject(AimsAcetateObject obj, int index) Adds an acetate object (AimsNorthArrowObject, AimsPointObject, etc.) to the AimsAcetateLayer.
boolean	isBufferLayer() Returns an indicator of whether the layer is a buffer layer.
boolean	isClone() Returns a boolean flag indicating that the layer is a clone.
boolean	isDynamic() Returns a boolean flag indicating whether the layer has been dynamically added.
boolean	isHighlightLayer() Returns true if the layer is a highlight layer.
boolean	isLayerWithinThreshold() Returns whether this layer is within threshold tolerance.
boolean	isServiceLayer() Returns true if this layer exists in the map service, or false if it was added after.
boolean	isUploadedLayer() Gets an indicator of whether the layer is a layer uploaded by the upload routines.
boolean	labelsHidden() Returns a boolean value indicating whether labels are currently hidden.
boolean	removeObject(int index) Removes the object at the specified index.
void	setAddToDefaultFolder(boolean flag) Sets whether the acetate layer should be added to the default All Layers folder when no other folders have been defined.
void	setAlias(java.lang.String alias) Sets the alias of the acetate layer.
void	setCanClear(boolean canClear) Sets whether the user can clear the layer using the clear tool.
void	setCanIdentify(boolean flag) Sets the layer to identifiable.
void	setCanSetVisibility(boolean canSetVisibility) Sets whether the layer can be turned on and off by the user.
void	setCanSetVisibilityBeyondScale(boolean canSetVisibility) Sets whether the layer can be turned on and off by the user.
void	setCanSymbolize(boolean canSymbolize) Sets whether the layer can be symbolized.
void	setCanZoomToLayer(boolean canZoom) Sets whether the zoom to layer extent function should be enabled for this layer.
void	setCoordsys(AimsCoordsys coordsys) Sets the coordsys for the layer for on-the-fly projection.
void	setExtent(AimsEnvelope envelope) Sets the envelope (extent) of the layer.
void	setId(java.lang.String id) Sets the ID of the acetate layer.
void	setLegendVisible(boolean isVisible) Sets the visibility of the layer in the legend.
void	setMap(AimsMap map) Sets the map object that this layer belongs to.
void	setMaxScale(double scale) Sets the maximum scale that the acetate layer will be displayed.
void	setMinScale(double scale) Sets the minimum scale that the acetate layer will be displayed.
void	setModified(boolean isModified) Sets the modified flag to control how much AXL is written to the application server.
void	setName(java.lang.String name) Sets the name of the acetate layer.
void	setProperty(java.lang.String name, java.lang.String value) Sets the value of a property (programmer defined).
void	setShowSymbolizeIcon(boolean showSymbolizeIcon) Sets whether the symbolize icon is displayed in the layer list.
void	setTag(java.lang.Object tag) Sets the user defined object associated to this object.
void	setUploadedLayer(boolean flag) Sets whether the layer is a layer uploaded by the upload routines.
void	setVisible(boolean isVisible) Sets the layer visibility.
void	showLabels(boolean showLabels) Sets a layer to show without labels.
java.lang.String	toAxlString(java.lang.String requestType) Returns the AXL string to refresh this object.
java.lang.String	toAxlString(java.lang.String requestType, boolean forceVisible) Returns the AXL string to refresh this object.
java.lang.String	toString() Returns a text description of this object.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AimsAcetateLayer

public AimsAcetateLayer()

Creates a new AimsAcetateLayer with no arguments. The name and ID will automatically be assigned.

AimsAcetateLayer

public AimsAcetateLayer(java.lang.String layerName)

Creates a new AimsAcetateLayer with a specified name. The ID will automatically be assigned.

Parameters:

layerName - The name of the new layer.

AimsAcetateLayer

public AimsAcetateLayer(java.lang.String id,
                        java.lang.String layerName)

Creates a new AimsAcetateLayer with a specified name and ID.

Parameters:

id - The id of the layer.

layerName - The name for the layer.

Method Detail

addLayerListLegend

public void addLayerListLegend(AimsLayerListLegend legend)

Adds a layer list legend.

Specified by:

addLayerListLegend in interface AimsLayer

Parameters:

legend - The legend to add.

hasLayerListLegend

public boolean hasLayerListLegend()

Gets and indicator of whether a layer list legend exists at this scale.

Specified by:

hasLayerListLegend in interface AimsLayer

Returns:

True if the layer has a legend which could be shown.

getLayerListLegend

public AimsLayerListLegend getLayerListLegend()

Gets and indicator of whether a layer list legend exists at this scale.

Specified by:

getLayerListLegend in interface AimsLayer

Returns:

True if the layer has a legend which could be shown.

getLayerListLegends

public AimsLayerListLegends getLayerListLegends()

Gets the array of layer list legends for this layer.

Specified by:

getLayerListLegends in interface AimsLayer

Returns:

An AimsLayerListLegends object containing the legends.

getCanClear

public boolean getCanClear()

Reports whether the user can clear the layer using the clear tool.

Returns:

True if the user can clear it, otherwize false.

setCanClear

public void setCanClear(boolean canClear)

Sets whether the user can clear the layer using the clear tool.

Parameters:

canClear - True if the user can clear it, otherwize false.

canHideLayerListLegend

public boolean canHideLayerListLegend()

Gets and indicator of whether the legend could be shown, true regardless of whether or not it is turned off.

Specified by:

canHideLayerListLegend in interface AimsLayer

Returns:

True if the layer has a legend which could be shown.

canShowLayerListLegend

public boolean canShowLayerListLegend()

Gets and indicator of whether the legend could be shown, true regardless of whether or not it is turned off.

Specified by:

canShowLayerListLegend in interface AimsLayer

Returns:

True if the layer has a legend which could be shown.

clone

public java.lang.Object clone()

Creates a copy of this object. Note: some properties not cloned.

Specified by:

clone in interface AimsLayer

Returns:

An object that is a copy of this layer. The object must be cast to an AimsAcetateLayer before use. TODO: tag referenced not cloned

setCoordsys

public void setCoordsys(AimsCoordsys coordsys)

Sets the coordsys for the layer for on-the-fly projection.

Parameters:

coordsys - The coordsys of the layer.

getLayerType

public int getLayerType()

Gets the layer type, AimsLayer.LAYER_TYPE_ACETATE

Specified by:

getLayerType in interface AimsLayer

Returns:

Always returns AimsLayer.LAYER_TYPE_ACETATE

getImmediateRefresh

public boolean getImmediateRefresh()

Returns whether the map should immediately refresh when the map layer visibility is changed.

Specified by:

getImmediateRefresh in interface AimsLayer

Returns:

True if the map should immediately refresh, otherwise false.

getLegendVisible

public boolean getLegendVisible()

Returns whether the layer should be visible in the legend.

Specified by:

getLegendVisible in interface AimsLayer

Returns:

True if the layer is visible, otherwise false.

setLegendVisible

public void setLegendVisible(boolean isVisible)

Sets the visibility of the layer in the legend.

Specified by:

setLegendVisible in interface AimsLayer

Parameters:

isVisible - A boolean value indicating whether the layer should be visible in the legend.

getObjectId

public int getObjectId()

Returns the IMF internal id for this layer. Note that this is not the same as the layer id assigned by the user or ArcIMS.

Specified by:

getObjectId in interface AimsLayer

Returns:

The internal id for the layer.

isServiceLayer

public boolean isServiceLayer()

Returns true if this layer exists in the map service, or false if it was added after.

Specified by:

isServiceLayer in interface AimsLayer

Returns:

True if the layer is from the map service, otherwise false.

clearObjects

public void clearObjects()

Removes all objects from the acetate layer.

getObjectCount

public int getObjectCount()

Returns the number of objects contained in the acetate layer.

Returns:

he number of objects contained in the acetate layer.

removeObject

public boolean removeObject(int index)

Removes the object at the specified index.

Parameters:

index - The zero based index of the object.

Returns:

True if removed, otherwise false.

getObject

public AimsAcetateObject getObject(int index)

Returns the acetate object at the specified index. The returned object type is AimsAcetateObject, which may need to be cast to the true type (AimsNorthArrowObject, AimsPointObject, etc.).

Parameters:

index - The zero based index for the desired object.

Returns:

The acetate object at the specified index, or null if an object does not exist at the specified index.

addObject

public void addObject(AimsAcetateObject obj)

Adds an acetate object (AimsNorthArrowObject, AimsPointObject, etc.) to the AimsAcetateLayer.

Parameters:

obj - An acetate object to add to the acetate layer.

insertObject

public boolean insertObject(AimsAcetateObject obj,
                            int index)

Adds an acetate object (AimsNorthArrowObject, AimsPointObject, etc.) to the AimsAcetateLayer.

Parameters:

obj - An acetate object to add to the acetate layer.

index - The position in the object list to insert the object.

Returns:

True if the object was inserted, otherwise false.

getCanIdentify

public boolean getCanIdentify()

Returns a boolean value indicating whether the acetate layer can be queried using the identify tools. As an acetate layer does not have a recordset, this method always returns false, unless this property is set and managed by a programmer.

Specified by:

getCanIdentify in interface AimsLayer

Returns:

True if the layer can be identified, otherwise false.

setCanIdentify

public void setCanIdentify(boolean flag)

Sets the layer to identifiable.

Parameters:

flag - An indicator of whether the layer is identifiable.

getVisible

public boolean getVisible()

Returns a boolean value indicating whether the acetate layer visibility is set. Note that this value can return true, even if the layer is not displayed due to the scale threshold.

Specified by:

getVisible in interface AimsLayer

Returns:

True if the visibility is on, otherwise false.

setVisible

public void setVisible(boolean isVisible)

Sets the layer visibility. Note that even if this value is set to true, the layer may not be displayed if the scale is outside of the scale threshold.

Specified by:

setVisible in interface AimsLayer

Parameters:

isVisible - True if the layer should display, otherwise false.

getType

public java.lang.String getType()

Gets the layer type. This method always returns the string "acetate".

Specified by:

getType in interface AimsLayer

Returns:

Always returns the string "acetate".

setMinScale

public void setMinScale(double scale)

Sets the minimum scale that the acetate layer will be displayed.

Specified by:

setMinScale in interface AimsLayer

Parameters:

scale - The minimum scale that the acetate layer will be displayed.

setMaxScale

public void setMaxScale(double scale)

Sets the maximum scale that the acetate layer will be displayed.

Specified by:

setMaxScale in interface AimsLayer

Parameters:

scale - The maximum scale that the acetate layer will be displayed.

getRenderer

public AimsRenderer getRenderer()

Gets the renderer used for the layer. Because acetate layers do not have renderers, this method always returns null.

Specified by:

getRenderer in interface AimsLayer

Returns:

Always returns null.

getRecordset

public AimsRecordset getRecordset()

Gets the recordset for the layer. Because acetate layers do not have recordsets, this method always returns null.

Specified by:

getRecordset in interface AimsLayer

Returns:

Always returns null.

getMinScale

public double getMinScale()

Gets the minimum scale at which the acetate layer will be visible.

Specified by:

getMinScale in interface AimsLayer

Returns:

The minimum scale at which the acetate layer will be visible.

getMaxScale

public double getMaxScale()

Gets the maximum scale at which the acetate layer will be visible.

Specified by:

getMaxScale in interface AimsLayer

Returns:

The maximum scale at which the acetate layer will be visible.

getId

public java.lang.String getId()

Gets the ID of the acetate layer

Specified by:

getId in interface AimsLayer

Returns:

ID of the acetate layer

setId

public void setId(java.lang.String id)

Sets the ID of the acetate layer.

Parameters:

id - The ID to assign to the acetate layer.

getName

public java.lang.String getName()

Gets the name of the acetate layer

Specified by:

getName in interface AimsLayer

Returns:

Name of the acetate layer

setName

public void setName(java.lang.String name)

Sets the name of the acetate layer.

Parameters:

name - The name to assign to the acetate layer.

getAlias

public java.lang.String getAlias()

Get the alias of the acetate layer

Specified by:

getAlias in interface AimsLayer

Returns:

Alias of the acetate layer, or the name if there is no alias

setAlias

public void setAlias(java.lang.String alias)

Sets the alias of the acetate layer.

Parameters:

alias - The alias to assign to the acetate layer.

toString

public java.lang.String toString()

Returns a text description of this object.

Specified by:

toString in interface AimsLayer

Returns:

A text description of this object.

toAxlString

public java.lang.String toAxlString(java.lang.String requestType)

Returns the AXL string to refresh this object.

Specified by:

toAxlString in interface AimsLayer

Parameters:

requestType - The type of request for which AXL should be written. valid values are "LAYERDEF" and "LAYER".

Returns:

The AXL string to refresh this object.

toAxlString

public java.lang.String toAxlString(java.lang.String requestType,
                                    boolean forceVisible)

Returns the AXL string to refresh this object.

Specified by:

toAxlString in interface AimsLayer

Parameters:

requestType - The type of AXL requested. Valid values are "LAYER" and "LAYERDEF".

forceVisible - A flag to indicate that the layer should be drawn even if not visible.

Returns:

Always returns null.

isHighlightLayer

public boolean isHighlightLayer()

Returns true if the layer is a highlight layer. Always returns false.

Specified by:

isHighlightLayer in interface AimsLayer

Returns:

Always returns false for AimsAcetateLayers.

getCanSelect

public boolean getCanSelect()

Returns true if the layer is selectable. Always returns false.

Specified by:

getCanSelect in interface AimsLayer

Returns:

Always returns false for AimsAcetateLayers.

getMetadataHandler

public java.lang.String getMetadataHandler()

Returns the URL of the metadata handler page for this layer, or null if no metatata handler is defined. A metadata handler is a custom script that is passed the object id of the layer which can then be used to calculate a metadata url.

Specified by:

getMetadataHandler in interface AimsLayer

Returns:

The metadata handler for this layer, or null.

getMetadataUrl

public java.lang.String getMetadataUrl()

Returns the URL to the metadata page for this layer, or null if no metatata URL is defined.

Specified by:

getMetadataUrl in interface AimsLayer

Returns:

The URL to the metadata page for this layer, or null if no metatata URL is defined.

setModified

public void setModified(boolean isModified)

Sets the modified flag to control how much AXL is written to the application server.

Specified by:

setModified in interface AimsLayer

Parameters:

isModified - True to force a full AXL string.

getCanSetVisibility

public boolean getCanSetVisibility()

Gets a boolean value indicating whether the layer can be turned on and off by the user.

Specified by:

getCanSetVisibility in interface AimsLayer

Returns:

True if the layer can be controlled, otherwise false.

setCanSetVisibility

public void setCanSetVisibility(boolean canSetVisibility)

Sets whether the layer can be turned on and off by the user.

Parameters:

canSetVisibility - True if the layer visibility can be controlled by the user, otherwise false.

getCanSetVisibilityBeyondScale

public boolean getCanSetVisibilityBeyondScale()

Gets a boolean value indicating whether the layer can be turned on and off by the user when the layer is beyond scale.

Specified by:

getCanSetVisibilityBeyondScale in interface AimsLayer

Returns:

True if the layer can be controlled, otherwise false.

setCanSetVisibilityBeyondScale

public void setCanSetVisibilityBeyondScale(boolean canSetVisibility)

Sets whether the layer can be turned on and off by the user.

Parameters:

canSetVisibility - True if the layer can be identified, otherwise false.

setMap

public void setMap(AimsMap map)

Sets the map object that this layer belongs to. This method is not intended for use by the programmer.

Specified by:

setMap in interface AimsLayer

Parameters:

map - The map object containing this layer.

isClone

public boolean isClone()

Returns a boolean flag indicating that the layer is a clone.

Specified by:

isClone in interface AimsLayer

Returns:

True if the layer is a clone, otherwise false.

isDynamic

public boolean isDynamic()

Returns a boolean flag indicating whether the layer has been dynamically added.

Specified by:

isDynamic in interface AimsLayer

Returns:

True if the layer has been added dynamically, otherwise false.

canFindByAttribute

public boolean canFindByAttribute()

Gets a boolean value indicating whether a layer can be queried using the find location by attribute tool.

Specified by:

canFindByAttribute in interface AimsLayer

Returns:

Always returns false for acetate layers.

canSelectByAttribute

public boolean canSelectByAttribute()

Gets a boolean value indicating whether a layer can be queried using the select location by attribute tool.

Specified by:

canSelectByAttribute in interface AimsLayer

Returns:

Always returns false for acetate layers.

canEdit

public boolean canEdit()

Gets a boolean value indicating whether a layer can be edited. using the editing tools extension.

Specified by:

canEdit in interface AimsLayer

Returns:

Always returns false for acetate layers.

showLabels

public void showLabels(boolean showLabels)

Sets a layer to show without labels. Has no effect on acetate layers.

Specified by:

showLabels in interface AimsLayer

Parameters:

showLabels - Has no effect on acetate layers.

canHideLabels

public boolean canHideLabels()

Returns a boolean value indicating whether labels can be hidden.

Specified by:

canHideLabels in interface AimsLayer

Returns:

Always returns false for acetate layers.

labelsHidden

public boolean labelsHidden()

Returns a boolean value indicating whether labels are currently hidden.

Specified by:

labelsHidden in interface AimsLayer

Returns:

Always returns false for acetate layers.

setExtent

public void setExtent(AimsEnvelope envelope)

Sets the envelope (extent) of the layer.

Specified by:

setExtent in interface AimsLayer

Parameters:

envelope - The envelope (extent) of the layer.

getExtent

public AimsEnvelope getExtent()

Returns the extent of the layer.

Specified by:

getExtent in interface AimsLayer

Returns:

The extent of the layer.

getMap

public AimsMap getMap()

Gets the parent map for this layer

Specified by:

getMap in interface AimsLayer

Returns:

The parent map.

isLayerWithinThreshold

public boolean isLayerWithinThreshold()

Returns whether this layer is within threshold tolerance.

Specified by:

isLayerWithinThreshold in interface AimsLayer

Returns:

True if the layer is shown at the present scale, otherwise false.

isBufferLayer

public boolean isBufferLayer()

Returns an indicator of whether the layer is a buffer layer.

Specified by:

isBufferLayer in interface AimsLayer

Returns:

Always returns false.

getCanDrillIdentify

public boolean getCanDrillIdentify()

Gets a boolean value indicating whether the layer can be identified using the drill down identify tool.

Specified by:

getCanDrillIdentify in interface AimsLayer

Returns:

Always returns false for acetate layers.

getProperty

public java.lang.String getProperty(java.lang.String name)

Gets the value of a property set in the configuration XML using a <property> element.

Specified by:

getProperty in interface AimsLayer

Parameters:

name - The property name

Returns:

The property value, or null.

setProperty

public void setProperty(java.lang.String name,
                        java.lang.String value)

Sets the value of a property (programmer defined).

Specified by:

setProperty in interface AimsLayer

Parameters:

name - The property name

value - The property value.

getCanZoomToLayer

public boolean getCanZoomToLayer()

Returns a boolean indicator of whether the zoom to layer extent function should be enabled for this layer.

Specified by:

getCanZoomToLayer in interface AimsLayer

Returns:

True if the layer can be zoomed to, otherwise false.

setCanZoomToLayer

public void setCanZoomToLayer(boolean canZoom)

Sets whether the zoom to layer extent function should be enabled for this layer.

Parameters:

canZoom - True if the user can zoom to this layer, otherwise false.

getTag

public java.lang.Object getTag()

Gets the user defined object tag assosciated with this object.

Specified by:

getTag in interface AimsLayer

Returns:

A programmer defined object that is associated with this object using the setTag() method. Note that this request returns an Object that must be cast to the appropriate object type before using.

setTag

public void setTag(java.lang.Object tag)

Sets the user defined object associated to this object. The programmer may associate any object to this one using this method, but must cast the object to an Object class before calling this method.

Specified by:

setTag in interface AimsLayer

Parameters:

tag - Any Object.

getAddToDefaultFolder

public boolean getAddToDefaultFolder()

Returns whether the acetate layer should be added to the default All Layers folder when no other folders have been defined.

Returns:

True if the layer should be added, otherwise false.

setAddToDefaultFolder

public void setAddToDefaultFolder(boolean flag)

Sets whether the acetate layer should be added to the default All Layers folder when no other folders have been defined.

Parameters:

flag - True if the layer should be added, otherwise false.

getCanSymbolize

public boolean getCanSymbolize()

Gets an indicator of whether the layer can be symbolized.

Specified by:

getCanSymbolize in interface AimsLayer

Returns:

True if the layer can be symbolized, otherwise false;

setCanSymbolize

public void setCanSymbolize(boolean canSymbolize)

Sets whether the layer can be symbolized.

Parameters:

canSymbolize - True if the layer can be symbolized, otherwise false;

getShowSymbolizeIcon

public boolean getShowSymbolizeIcon()

Gets an indicator of whether the symbolize icon shows up in the layer list.

Specified by:

getShowSymbolizeIcon in interface AimsLayer

Returns:

True if the icon is displayed, otherwise false;

setShowSymbolizeIcon

public void setShowSymbolizeIcon(boolean showSymbolizeIcon)

Sets whether the symbolize icon is displayed in the layer list.

Parameters:

showSymbolizeIcon - True if the icon is displayed, otherwise false;

isUploadedLayer

public boolean isUploadedLayer()

Gets an indicator of whether the layer is a layer uploaded by the upload routines.

Returns:

true if the layer is an upload layer, otherwise false

setUploadedLayer

public void setUploadedLayer(boolean flag)

Sets whether the layer is a layer uploaded by the upload routines.

Parameters:

flag - True if the layer is an upload layer, otherwise false

adjustScaleFactors

public void adjustScaleFactors(java.lang.String inUnits,
                               java.lang.String outUnits)

Adjusts the scale factors for this layer. Used when changing the units of a map.

Specified by:

adjustScaleFactors in interface AimsLayer

Parameters:

inUnits - The original units, "METERS", FEET" or "DECIMAL_DEGREES".

outUnits - The target units, "METERS", FEET" or "DECIMAL_DEGREES".

adjustScaleFactors

public void adjustScaleFactors(double multiplier)

Adjusts the scale factors for this layer. Used when changing the units of a map.

Specified by:

adjustScaleFactors in interface AimsLayer

Parameters:

multiplier - The multiplication factor for adjusting scale factors.

getObjectType

public int getObjectType()

Gets the type of object this is.

Specified by:

getObjectType in interface AimsObject

Returns:

The enumerated value.

hasObjectsVisible

public boolean hasObjectsVisible()

Returns an indicator of whether objects are visible in the current map extent.

Returns:

False if no objects are visible, or if the maxymum have been drawn, otherwise true.