com.moximedia.aims
Class AimsValueMapLabelRenderer

java.lang.Object
  com.moximedia.aims.AimsSimpleLabelRenderer
      com.moximedia.aims.AimsValueMapLabelRenderer

All Implemented Interfaces:

AimsRenderer, java.lang.Cloneable, java.io.Serializable

public class AimsValueMapLabelRenderer

extends AimsSimpleLabelRenderer

implements java.lang.Cloneable, AimsRenderer, java.io.Serializable

Author:

Doug Cates - www.moximedia.com

See Also:

Serialized Form

Constructor Summary

AimsValueMapLabelRenderer()
Creates new SimpleLabelRenderer

Method Summary

void	add(AimsExact exactObj) Adds an Exact value to the renderer.
void	add(AimsOther otherObj) Adds an Other value to the renderer.
void	add(AimsRange rangeObj) Adds a Range value to the renderer.
void	adjustScaleFactors(double multiplier) Adjusts the scale factors for this renderer.
java.lang.Object	clone() Creates a copy of this renderer.
java.lang.String	getLabelField() Gets the value of attribute labelField
java.lang.String	getLookupField() Gets the value of attribute lookupField
boolean	getVisible() gets the visiblility of the renderer
void	highlight(AimsColor highlightColor, double transparency)
boolean	isModified() Returns a boolean value indicating whether the renderer has been modified by the user since it was loaded from the map service.
void	removeLabels() Removes labels from this renderer and any subrenderers (if applicable).
void	setAxlAttribute(java.lang.String tag, java.lang.String name, java.lang.String value) Sets one of the attributes of this object using a string value.
void	setLabelField(java.lang.String labelField) Sets the value of attribute labelField.
void	setLookupField(java.lang.String lookupField) Sets the value of attribute lookupField.
void	setModified(boolean isModified) Sets the modified flag of the renderer, indicating that it needs to be sent to the map server when the map is refreshed.
void	setVisible(boolean isVisible) Sets the visiblility of the renderer
void	showLabels(boolean showLabels)
java.lang.String	toAxlString() Returns the AXL string to refresh this object.
java.lang.String	toAxlString(AimsEnvironment env) Returns the AXL string to refresh this object.
java.lang.String	toString() Returns a string containing the name of this class.

Methods inherited from class com.moximedia.aims.AimsSimpleLabelRenderer

getFeatureWeight, getField, getHowManyLabels, getLabelBufferRatio, getLabelPriorities, getLabelWeight, getLineLabelPosition, getRotationalAngles, getSymbol, setFeatureWeight, setField, setHowManyLabels, setLabelBufferRatio, setLabelPriorities, setLabelWeight, setLineLabelPosition, setRotationalAngles, setSymbol

Methods inherited from class java.lang.Object

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

Constructor Detail

AimsValueMapLabelRenderer

public AimsValueMapLabelRenderer()

Creates new SimpleLabelRenderer

Method Detail

clone

public java.lang.Object clone()

Creates a copy of this renderer.

Specified by:

clone in interface AimsRenderer

Overrides:

clone in class AimsSimpleLabelRenderer

Returns:

An object that is a copy of this renderer. The object must be cast to an AimsValueMapLabelRenderer or AimsRenderer before use.

isModified

public boolean isModified()

Returns a boolean value indicating whether the renderer has been modified by the user since it was loaded from the map service.

Specified by:

isModified in interface AimsRenderer

Overrides:

isModified in class AimsSimpleLabelRenderer

Returns:

True if modified, otherwise false.

setModified

public void setModified(boolean isModified)

Sets the modified flag of the renderer, indicating that it needs to be sent to the map server when the map is refreshed.

Specified by:

setModified in interface AimsRenderer

Overrides:

setModified in class AimsSimpleLabelRenderer

Parameters:

isModified - True if the renderer has been modified.

add

public void add(AimsExact exactObj)

Adds an Exact value to the renderer.

add

public void add(AimsRange rangeObj)

Adds a Range value to the renderer.

add

public void add(AimsOther otherObj)

Adds an Other value to the renderer.

setLabelField

public void setLabelField(java.lang.String labelField)

Sets the value of attribute labelField.

getLabelField

public java.lang.String getLabelField()

Gets the value of attribute labelField

Returns:

The value of attribute labelField

setLookupField

public void setLookupField(java.lang.String lookupField)

Sets the value of attribute lookupField.

getLookupField

public java.lang.String getLookupField()

Gets the value of attribute lookupField

Returns:

The value of attribute lookupField

getVisible

public boolean getVisible()

gets the visiblility of the renderer

Overrides:

getVisible in class AimsSimpleLabelRenderer

Returns:

The visibility property.

setVisible

public void setVisible(boolean isVisible)

Sets the visiblility of the renderer

Overrides:

setVisible in class AimsSimpleLabelRenderer

Parameters:

isVisible - The visibility property.

setAxlAttribute

public void setAxlAttribute(java.lang.String tag,
                            java.lang.String name,
                            java.lang.String value)

Sets one of the attributes of this object using a string value. This method should only be called from the SAX event handler.

Overrides:

setAxlAttribute in class AimsSimpleLabelRenderer

Parameters:

tag - The AXL element tag containing this attribute.

name - The AXL attribute name.

value - The AXL attribute value.

toString

public java.lang.String toString()

Returns a string containing the name of this class.

Specified by:

toString in interface AimsRenderer

Overrides:

toString in class AimsSimpleLabelRenderer

Returns:

The name of the class

toAxlString

public java.lang.String toAxlString()

Returns the AXL string to refresh this object.

Specified by:

toAxlString in interface AimsRenderer

Overrides:

toAxlString in class AimsSimpleLabelRenderer

Returns:

The AXL string to refresh this object.

toAxlString

public java.lang.String toAxlString(AimsEnvironment env)

Returns the AXL string to refresh this object.

Specified by:

toAxlString in interface AimsRenderer

Overrides:

toAxlString in class AimsSimpleLabelRenderer

Returns:

The AXL string to refresh this object.

highlight

public void highlight(AimsColor highlightColor,
                      double transparency)

Specified by:

highlight in interface AimsRenderer

Overrides:

highlight in class AimsSimpleLabelRenderer

removeLabels

public void removeLabels()

Removes labels from this renderer and any subrenderers (if applicable). This method is used by the createHighlightLayer method to avoid duplicate labels on the map.

Specified by:

removeLabels in interface AimsRenderer

Overrides:

removeLabels in class AimsSimpleLabelRenderer

showLabels

public void showLabels(boolean showLabels)

Specified by:

showLabels in interface AimsRenderer

Overrides:

showLabels in class AimsSimpleLabelRenderer

adjustScaleFactors

public void adjustScaleFactors(double multiplier)

Adjusts the scale factors for this renderer. Used for some renderers when changing the units of a map.

Specified by:

adjustScaleFactors in interface AimsRenderer

Overrides:

adjustScaleFactors in class AimsSimpleLabelRenderer

Parameters:

multiplier - The multiplication factor for adjusting scale factors.