com.esri.adf.web.ags.data.image
Class AGSImageTocFunctionality

java.lang.Object
  com.esri.adf.web.ags.data.image.AGSImageTocFunctionality

All Implemented Interfaces:

GISFunctionality, TocFunctionality, Serializable

public class AGSImageTocFunctionality
extends Object
implements TocFunctionality, Serializable

This class connects to the Image Service to create the TOC.

See Also:

Serialized Form

Field Summary

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

FUNCTIONALITY_NAME

Constructor Summary

AGSImageTocFunctionality()

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.
double	getPatchHeight() Returns the patch height
double	getPatchResolution() Returns the patch resolution
double	getPatchWidth() Returns the patch width
AGSImageResource	getResource() Returns the GISResource associated with this functionality.
void	initFunctionality(GISResource resource) The initialization chores for the functionality must be performed in this method.
boolean	isShowSwatches() Returns the flag state to enable/disable patch display
void	setPatchHeight(double patchHeight) Sets the height of the patch
void	setPatchResolution(double patchResolution) Sets the resolution of the patch
void	setPatchWidth(double patchWidth) Sets the width of the patch
void	setShowSwatches(boolean showSwatches) Enable/disable the display of the patches

Methods inherited from class java.lang.Object

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

Constructor Detail

AGSImageTocFunctionality

public AGSImageTocFunctionality()

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

getPatchWidth

public double getPatchWidth()

Returns the patch width

Returns:

the patch width

setPatchWidth

public void setPatchWidth(double patchWidth)

Sets the width of the patch

Parameters:

patchWidth - width of the patch

getPatchHeight

public double getPatchHeight()

Returns the patch height

Returns:

the patch height

setPatchHeight

public void setPatchHeight(double patchHeight)

Sets the height of the patch

Parameters:

patchHeight - height of the patch

getPatchResolution

public double getPatchResolution()

Returns the patch resolution

Returns:

the patch resolution

setPatchResolution

public void setPatchResolution(double patchResolution)

Sets the resolution of the patch

Parameters:

patchResolution - resolution of the patch

isShowSwatches

public boolean isShowSwatches()

Returns the flag state to enable/disable patch display

Returns:

the showSwatch flag state

setShowSwatches

public void setShowSwatches(boolean showSwatches)

Enable/disable the display of the patches

Parameters:

showSwatches - state of the flag