com.esri.adf.web.aims.data
Class AIMSTocFunctionality

java.lang.Object
  com.esri.adf.web.aims.data.AIMSTocFunctionality

All Implemented Interfaces:

GISFunctionality, TocFunctionality, Serializable

public class AIMSTocFunctionality
extends Object
implements TocFunctionality, Serializable

See Also:

Serialized Form

Field Summary

protected AIMSMapResource

aimsResource

Fields inherited from interface com.esri.adf.web.data.TocFunctionality

FUNCTIONALITY_NAME

Constructor Summary

AIMSTocFunctionality()

Method Summary

void	createTocHierarchy(TocNode parentNode) Creates the content hierarchy for this TOC.
void	destroyFunctionality() The cleanup chores (such as releasing held resources) for the functionality must be performed in this method.
String	getCustomLayerContentClassName() Returns the name of the custom class (which should be a sub-class of AIMSTocLayerContent) to use for the AIMS layer nodes
String	getHideLayers()
AIMSMapResource	getResource() Returns the GISResource associated with this functionality.
String	getSwatchBackgroundColor()
int	getSwatchHeight()
int	getSwatchWidth()
void	initFunctionality(GISResource resource) The initialization chores for the functionality must be performed in this method.
boolean	isShowAllLayers()
boolean	isShowSwatches()
void	setCustomLayerContentClassName(String customLayerContentClassName) Sets the name of the custom class (which should be a sub-class of AIMSTocLayerContent) to use for the AIMS layer nodes
void	setHideLayers(String hideLayers)
void	setShowAllLayers(boolean showAllLayer)
void	setShowSwatches(boolean showSwatches)
void	setSwatchBackgroundColor(String swatchBackgroundColor)
void	setSwatchHeight(int swatchHeight)
void	setSwatchWidth(int swatchWidth)

Methods inherited from class java.lang.Object

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

Field Detail

aimsResource

protected AIMSMapResource aimsResource

Constructor Detail

AIMSTocFunctionality

public AIMSTocFunctionality()

Method Detail

initFunctionality

public void initFunctionality(GISResource resource)

Description copied from interface: GISFunctionality

The initialization chores for the functionality must be performed in this method. This method is called by the resource when the functionality needs to be initialized. This happens either when the resource itself is being initialized or if users add this functionality to the resource using the GISResource.addFunctionality(String, GISFunctionality) method after the resource has already been initialized.

Classes which implement this method should maintain the resource as a class instance variable and return the same in the GISFunctionality.getResource() method. The functionality is ready for use only after this method has been called.

Specified by:

initFunctionality in interface GISFunctionality

Parameters:

resource - the GISResource that this functionality supports

See Also:

GISResource.init(WebContext)

destroyFunctionality

public void destroyFunctionality()

Description copied from interface: GISFunctionality

The cleanup chores (such as releasing held resources) for the functionality must be performed in this method. This method is called by the GISResource when the resource itself is being destroyed.

The functionality is no longer usable after this method has been called.

Specified by:

destroyFunctionality in interface GISFunctionality

See Also:

GISResource.destroy()

createTocHierarchy

public void createTocHierarchy(TocNode parentNode)

Description copied from interface: TocFunctionality

Creates the content hierarchy for this TOC.

The content generated should be structured as a tree of TocNodes. The WebToc calls this method on each TOC functionality when it first creates the TOC hierarchy. It passes the TocNode representing the node for the resource of the functionality to this method. The TOC functionality is reponsible for generating its content as children nodes of this resource node.

Specified by:

createTocHierarchy in interface TocFunctionality

Parameters:

parentNode - the parent TocNode for the content generated by this TOC functionality

getResource

public AIMSMapResource getResource()

Description copied from interface: GISFunctionality

Returns the GISResource associated with this functionality.

The resource passed to GISFunctionality.initFunctionality(GISResource) is maintained as a class variable and is accessible through this method.

Specified by:

getResource in interface GISFunctionality

Returns:

the GISResource associated with this functionality

setShowAllLayers

public void setShowAllLayers(boolean showAllLayer)

setShowSwatches

public void setShowSwatches(boolean showSwatches)

setHideLayers

public void setHideLayers(String hideLayers)

setSwatchHeight

public void setSwatchHeight(int swatchHeight)

setSwatchWidth

public void setSwatchWidth(int swatchWidth)

setSwatchBackgroundColor

public void setSwatchBackgroundColor(String swatchBackgroundColor)

isShowAllLayers

public boolean isShowAllLayers()

isShowSwatches

public boolean isShowSwatches()

getHideLayers

public String getHideLayers()

getSwatchHeight

public int getSwatchHeight()

getSwatchWidth

public int getSwatchWidth()

getSwatchBackgroundColor

public String getSwatchBackgroundColor()

getCustomLayerContentClassName

public String getCustomLayerContentClassName()

Returns the name of the custom class (which should be a sub-class of AIMSTocLayerContent) to use for the AIMS layer nodes

Returns:

the name of the toc layer content custom class name

setCustomLayerContentClassName

public void setCustomLayerContentClassName(String customLayerContentClassName)

Sets the name of the custom class (which should be a sub-class of AIMSTocLayerContent) to use for the AIMS layer nodes

Parameters:

customLayerContentClassName - the name of the toc layer content custom class name