com.moximedia.aims
Class AimsGroupRenderer

java.lang.Object
  com.moximedia.aims.AimsGroupRenderer

All Implemented Interfaces:

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

public class AimsGroupRenderer

extends java.lang.Object

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

Implementation of an ArcIMS GroupRenderer. An AimsGroupRenderer is used to define multiple symbolization for a single feature layer.

Author:

Doug Cates - www.moximedia.com

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.moximedia.aims.AimsRenderer

RENDERER_TYPE_GROUP, RENDERER_TYPE_SCALEDEPENDENT, RENDERER_TYPE_SIMPLE, RENDERER_TYPE_SIMPLELABEL, RENDERER_TYPE_VALUEMAP, RENDERER_TYPE_VALUEMAPLABEL

Constructor Summary

AimsGroupRenderer()
Creates new GroupRenderer

Method Summary

void	addRenderer(AimsRenderer renderer) Adds a renderer to the AimsGroupRenderer.
void	adjustScaleFactors(double multiplier) Adjusts the scale factors for this renderer.
java.lang.Object	clone() Creates a copy of this renderer.
AimsRenderer	getRenderer(int index) Returns the specified sub renderer of the renderer.
int	getRendererType() Returns an indicator of what type of renderer this is.
void	highlight(AimsColor highlightColor, double transparency) Sets the symbols of this renderer to the specified highlight color.
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	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	showLabels(boolean showLabels) Toggles the visibility of the label renderers in this renderer.
int	size() Gets the number of renderers in this group.
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 text description of this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

AimsGroupRenderer

public AimsGroupRenderer()

Creates new GroupRenderer

Method Detail

size

public int size()

Gets the number of renderers in this group.

Returns:

The number of renderers.

clone

public java.lang.Object clone()

Creates a copy of this renderer.

Specified by:

clone in interface AimsRenderer

Returns:

An object that is a copy of this renderer. The object must be cast to an AimsGroupRenderer 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. It returns true if the group renderer or any of it's sub renderers have been modified.

Specified by:

isModified in interface AimsRenderer

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

Parameters:

isModified - True if the renderer has been modified.

addRenderer

public void addRenderer(AimsRenderer renderer)

Adds a renderer to the AimsGroupRenderer.

Parameters:

renderer - A renderer to add to the group renderer

getRenderer

public AimsRenderer getRenderer(int index)

Returns the specified sub renderer of the renderer.

Parameters:

index - The sub renderer index number.

Returns:

A renderer if successful, otherwise null. Note that the return object is an AimsRenderer, which you will likely have to cast to the specific renderer type before using.

toString

public java.lang.String toString()

Returns a text description of this object.

Specified by:

toString in interface AimsRenderer

Returns:

The description of this object.

toAxlString

public java.lang.String toAxlString()

Returns the AXL string to refresh this object.

Specified by:

toAxlString in interface AimsRenderer

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

Parameters:

env - The AimsEnvironment object used to generate the proper AXL for the ArcIMS version in use.

Returns:

The AXL string to refresh this object.

highlight

public void highlight(AimsColor highlightColor,
                      double transparency)

Sets the symbols of this renderer to the specified highlight color.

Specified by:

highlight in interface AimsRenderer

Parameters:

highlightColor - The color to use for highlighting features.

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

showLabels

public void showLabels(boolean showLabels)

Toggles the visibility of the label renderers in this renderer.

Specified by:

showLabels in interface AimsRenderer

Parameters:

showLabels - The visibility property.

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

Parameters:

multiplier - The multiplication factor for adjusting scale factors.

getRendererType

public int getRendererType()

Returns an indicator of what type of renderer this is.

Specified by:

getRendererType in interface AimsRenderer

Returns:

An enumerated value indicating the type of renderer this is. Always returns AimsRenderer.RENDERER_TYPE_GROUP.