com.esri.adf.web.ve.data.imagery
Class VETocFunctionality

java.lang.Object
  com.esri.adf.web.ve.data.imagery.VETocFunctionality

All Implemented Interfaces:

GISFunctionality, TocFunctionality, Serializable

public class VETocFunctionality
extends Object
implements TocFunctionality, Serializable

This class defines the Table-Of-Contents (TOC) for the Bing™ Maps (formerly known as Virtual Earth) Imagery Web Service.

See Also:

Serialized Form

Field Summary

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

FUNCTIONALITY_NAME

Constructor Summary

VETocFunctionality()

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.
GISResource	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	isUpdateOverviewOnMapStyleChange() Returns the flag that indicates if the overview should be updated when the map style is changed on the fly.
void	setUpdateOverviewOnMapStyleChange(boolean updateOverviewOnMapStyleChange) Sets the flag that enables/disables the overview update when the map style is changed.

Methods inherited from class java.lang.Object

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

Constructor Detail

VETocFunctionality

public VETocFunctionality()

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)

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

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()

getResource

public GISResource 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

isUpdateOverviewOnMapStyleChange

public boolean isUpdateOverviewOnMapStyleChange()

Returns the flag that indicates if the overview should be updated when the map style is changed on the fly. By default, the value is false.

Returns:

the updateOverviewOnMapStyleChange

setUpdateOverviewOnMapStyleChange

public void setUpdateOverviewOnMapStyleChange(boolean updateOverviewOnMapStyleChange)

Sets the flag that enables/disables the overview update when the map style is changed.

Parameters:

updateOverviewOnMapStyleChange - the updateOverviewOnMapStyleChange to set