com.esri.adf.web.data.graphics
Class GraphicsTocFunctionality

java.lang.Object
  com.esri.adf.web.data.graphics.GraphicsTocFunctionality

All Implemented Interfaces:

GISFunctionality, TocFunctionality, java.io.Serializable

public class GraphicsTocFunctionality
extends java.lang.Object
implements TocFunctionality, java.io.Serializable

GraphicsTocFunctionality implements a Table of Contents (TOC) functionality for the Graphics resource.

See Also:

Serialized Form

Field Summary

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

FUNCTIONALITY_NAME

Constructor Summary

GraphicsTocFunctionality()

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.
java.lang.String	getCustomLayerContentClassName() Returns the name of the custom class (which should be a sub-class of GraphicsTocLayerContent) to use for the Graphics layer nodes
GraphicsResource	getResource() Returns the GISResource associated with this functionality.
int	getSwatchHeight() Returns the height of the swatch container.
int	getSwatchWidth() Returns the width of the swatch container.
void	initFunctionality(GISResource resource) The initialization chores for the functionality must be performed in this method.
void	setCustomLayerContentClassName(java.lang.String customLayerContentClassName) Sets the name of the custom class (which should be a sub-class of GraphicsTocLayerContent) to use for the Graphics layer nodes
void	setSwatchHeight(int swatchHeight) Sets the height of the swatch container, i.e.
void	setSwatchWidth(int swatchWidth) Sets the width of the swatch container, i.e.

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphicsTocFunctionality

public GraphicsTocFunctionality()

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 GraphicsResource 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

getSwatchHeight

public int getSwatchHeight()

Returns the height of the swatch container.

Returns:

the height of the swatch container

setSwatchHeight

public void setSwatchHeight(int swatchHeight)

Sets the height of the swatch container, i.e. height of the rectangular image on which layer's symbol is drawn.

Parameters:

swatchHeight - the height of the swatch container.

getSwatchWidth

public int getSwatchWidth()

Returns the width of the swatch container.

Returns:

the width of the swatch container.

setSwatchWidth

public void setSwatchWidth(int swatchWidth)

Sets the width of the swatch container, i.e. width of the rectangular image on which layer's symbol is drawn.

Parameters:

swatchWidth -

getCustomLayerContentClassName

public java.lang.String getCustomLayerContentClassName()

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

Returns:

the name of the toc layer content custom class name

setCustomLayerContentClassName

public void setCustomLayerContentClassName(java.lang.String customLayerContentClassName)

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

Parameters:

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