com.esri.adf.web.aws.data
Class AWSTocFunctionality

java.lang.Object
  com.esri.adf.web.aws.data.AWSTocFunctionality

All Implemented Interfaces:

GISFunctionality, TocFunctionality, WebContextObserver, java.io.Serializable

Deprecated. This class is deprecated as of ArcGIS Java Server 9.3.1, no replacement

@Deprecated
public class AWSTocFunctionality
extends java.lang.Object
implements WebContextObserver, TocFunctionality, java.io.Serializable

See Also:

Serialized Form

Field Summary

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

FUNCTIONALITY_NAME

Constructor Summary

AWSTocFunctionality()
Deprecated.

Method Summary

void	createTocHierarchy(TocNode parentNode) Deprecated. Creates the content hierarchy for this TOC.
void	destroyFunctionality() Deprecated. The cleanup chores (such as releasing held resources) for the functionality must be performed in this method.
java.lang.String	getHideLayers() Deprecated.
AWSMapResource	getResource() Deprecated. Returns the GISResource associated with this functionality.
void	initFunctionality(GISResource resource) Deprecated. The initialization chores for the functionality must be performed in this method.
boolean	isScaleRange(java.lang.String layerName) Deprecated.
boolean	isShowAllLayer() Deprecated.
void	setHideLayers(java.lang.String hideLayers) Deprecated.
void	setShowAllLayer(boolean showAllLayer) Deprecated.
void	setVisibility(java.lang.String layerName, boolean visible) Deprecated.
void	update(WebContext context, java.lang.Object arg) Deprecated. This method is called by the WebContext on its registered WebContextObservers when users call the refresh() methods on the context.

Methods inherited from class java.lang.Object

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

Constructor Detail

AWSTocFunctionality

public AWSTocFunctionality()

Deprecated.

Method Detail

initFunctionality

public void initFunctionality(GISResource resource)

Deprecated.

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

Deprecated.

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

update

public void update(WebContext context,
                   java.lang.Object arg)

Deprecated.

Description copied from interface: WebContextObserver

This method is called by the WebContext on its registered WebContextObservers when users call the refresh() methods on the context.

To setup an object to be updated by the context, one needs to use the WebContext.addObserver(WebContextObserver) to register itself with the context. All context attributes are wired up to the WebContext. When users change state on any of the attributes and need to intimate other attributes of the context to react to the change they call either the WebContext.refresh() or WebContext.refresh(Object) methods. The context in turns calls the WebContextObserver.update(WebContext, Object) methods on all its registered observers.

Specified by:

update in interface WebContextObserver

Parameters:

context - the WebContext that has been refreshed

arg - the argument passed to the WebContext's refresh(arg) method

See Also:

WebContext.refresh(Object), WebContext.addObserver(WebContextObserver), WebContext.removeObserver(WebContextObserver)

createTocHierarchy

public void createTocHierarchy(TocNode parentNode)

Deprecated.

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

Deprecated.

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

isScaleRange

public boolean isScaleRange(java.lang.String layerName)

Deprecated.

setVisibility

public void setVisibility(java.lang.String layerName,
                          boolean visible)

Deprecated.

setShowAllLayer

public void setShowAllLayer(boolean showAllLayer)

Deprecated.

setHideLayers

public void setHideLayers(java.lang.String hideLayers)

Deprecated.

isShowAllLayer

public boolean isShowAllLayer()

Deprecated.

getHideLayers

public java.lang.String getHideLayers()

Deprecated.