|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.esri.adf.web.data.graphics.GraphicsTocFunctionality
public class GraphicsTocFunctionality
GraphicsTocFunctionality implements a Table of Contents (TOC) functionality for the Graphics resource.
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. |
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(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 |
---|
public GraphicsTocFunctionality()
Method Detail |
---|
public void initFunctionality(GISResource resource)
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.
initFunctionality
in interface GISFunctionality
resource
- the GISResource
that this functionality supportsGISResource.init(WebContext)
public void destroyFunctionality()
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.
destroyFunctionality
in interface GISFunctionality
GISResource.destroy()
public void createTocHierarchy(TocNode parentNode)
TocFunctionality
Creates the content hierarchy for this TOC.
The content generated should be structured as a tree of TocNode
s. 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.
createTocHierarchy
in interface TocFunctionality
parentNode
- the parent TocNode
for the content generated by this TOC functionalitypublic GraphicsResource getResource()
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.
getResource
in interface GISFunctionality
GISResource
associated with this functionalitypublic int getSwatchHeight()
public void setSwatchHeight(int swatchHeight)
swatchHeight
- the height of the swatch container.public int getSwatchWidth()
public void setSwatchWidth(int swatchWidth)
swatchWidth
- public String getCustomLayerContentClassName()
public void setCustomLayerContentClassName(String customLayerContentClassName)
customLayerContentClassName
- the name of the toc layer content custom class name
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |