com.esri.adf.web.ags.data
Class AGSTocLayerContent

java.lang.Object
  com.esri.adf.web.data.TocNodeContent
      com.esri.adf.web.ags.data.AGSTocLayerContent

All Implemented Interfaces:

Serializable

public class AGSTocLayerContent
extends TocNodeContent

See Also:

Serialized Form

Field Summary

protected static ArrayList<javax.faces.model.SelectItem>	commonItems
protected String	copyrightText
protected static TocNodeContent	errorSymbol
protected double	fromScale
protected boolean	hasSingleFusedMapCache
protected com.esri.arcgisws.LayerDescription	layerDesc
protected String	layerName
protected boolean	scaleIndependent
static String	SHOW_COPYRIGHT_CONTEXT_MENU_ITEM
protected static javax.faces.model.SelectItem	showCopyright
protected boolean	symbolsGenerated
protected AGSTocFunctionality	tocFunc
protected double	toScale
static String	ZOOM_TO_LAYER_CONTEXT_MENU_ITEM
protected static javax.faces.model.SelectItem	zoomToLayer

Fields inherited from class com.esri.adf.web.data.TocNodeContent

disabled

Constructor Summary

AGSTocLayerContent()

Method Summary

List<javax.faces.model.SelectItem>	getContextMenuItems() The list of javax.faces.model.SelectItem objects representing each item of this node's context menu.
String	getCopyrightText() Returns the copyright text for this node.
String	getText() Returns the text displayed on the node.
void	handleCheckedEvent(boolean checked, TocEvent args) Handles the checked/unchecked event occuring at a node.
void	handleContextMenuEvent(String contextMenuItemValue, TocEvent args) Handles the context menu event occuring at a node.
void	handleExpandCollapseEvent(boolean expanded, TocEvent args) Handles the expand/collapse event occuring at a node.
void	handleNodeEvent(TocEvent args) Handles the event which occurs at a content node.
void	initLayerContent(AGSTocFunctionality tocFunc, com.esri.arcgisws.LayerDescription layerDesc)
boolean	isCheckable() Returns an indicator whether this node is checkable.
boolean	isChecked() If isCheckable() is true, it indicates whether it is checked.
boolean	isDisabled() Returns an indicator whether this node disabled.
boolean	isSymbolsGenerated()
void	setSymbolsGenerated(boolean symbolsGenerated)

Methods inherited from class com.esri.adf.web.data.TocNodeContent

getImageUrl, isSelected, isUrl, setChecked, setDisabled, setImageUrl, setText

Methods inherited from class java.lang.Object

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

Field Detail

errorSymbol

protected static final TocNodeContent errorSymbol

layerDesc

protected com.esri.arcgisws.LayerDescription layerDesc

tocFunc

protected AGSTocFunctionality tocFunc

layerName

protected String layerName

copyrightText

protected String copyrightText

symbolsGenerated

protected boolean symbolsGenerated

fromScale

protected double fromScale

toScale

protected double toScale

scaleIndependent

protected boolean scaleIndependent

hasSingleFusedMapCache

protected boolean hasSingleFusedMapCache

ZOOM_TO_LAYER_CONTEXT_MENU_ITEM

public static final String ZOOM_TO_LAYER_CONTEXT_MENU_ITEM

See Also:

Constant Field Values

SHOW_COPYRIGHT_CONTEXT_MENU_ITEM

public static final String SHOW_COPYRIGHT_CONTEXT_MENU_ITEM

See Also:

Constant Field Values

zoomToLayer

protected static final javax.faces.model.SelectItem zoomToLayer

showCopyright

protected static final javax.faces.model.SelectItem showCopyright

commonItems

protected static final ArrayList<javax.faces.model.SelectItem> commonItems

Constructor Detail

AGSTocLayerContent

public AGSTocLayerContent()

Method Detail

initLayerContent

public void initLayerContent(AGSTocFunctionality tocFunc,
                             com.esri.arcgisws.LayerDescription layerDesc)

getText

public String getText()

Returns the text displayed on the node.

Specified by:

getText in class TocNodeContent

Returns:

the text

handleCheckedEvent

public void handleCheckedEvent(boolean checked,
                               TocEvent args)
                        throws Exception

Handles the checked/unchecked event occuring at a node.

Overrides:

handleCheckedEvent in class TocNodeContent

Parameters:

checked - if true, node is checked

args - the TocEvent

Throws:

Exception

handleExpandCollapseEvent

public void handleExpandCollapseEvent(boolean expanded,
                                      TocEvent args)
                               throws Exception

Description copied from class: TocNodeContent

Handles the expand/collapse event occuring at a node.

Overrides:

handleExpandCollapseEvent in class TocNodeContent

Parameters:

expanded - if true, node is expanded

args - the TocEvent

Throws:

Exception

handleNodeEvent

public void handleNodeEvent(TocEvent args)
                     throws Exception

Handles the event which occurs at a content node.

Specified by:

handleNodeEvent in class TocNodeContent

Parameters:

args - the TocEvent

Throws:

Exception

isCheckable

public boolean isCheckable()

Returns an indicator whether this node is checkable.

Overrides:

isCheckable in class TocNodeContent

Returns:

boolean- if true, the node is checkable. The default is false.

isChecked

public boolean isChecked()

If isCheckable() is true, it indicates whether it is checked.

Overrides:

isChecked in class TocNodeContent

Returns:

boolean- returns false

isDisabled

public boolean isDisabled()

Returns an indicator whether this node disabled.

Overrides:

isDisabled in class TocNodeContent

Returns:

boolean- if true, the node is disabled. The default is false.

isSymbolsGenerated

public boolean isSymbolsGenerated()

setSymbolsGenerated

public void setSymbolsGenerated(boolean symbolsGenerated)

getContextMenuItems

public List<javax.faces.model.SelectItem> getContextMenuItems()

Description copied from class: TocNodeContent

The list of javax.faces.model.SelectItem objects representing each item of this node's context menu. This default implementation returns null.

Overrides:

getContextMenuItems in class TocNodeContent

Returns:

a List of javax.faces.model.SelectItem objects

getCopyrightText

public String getCopyrightText()

Returns the copyright text for this node.

Returns:

the copyright text for this node

handleContextMenuEvent

public void handleContextMenuEvent(String contextMenuItemValue,
                                   TocEvent args)
                            throws Exception

Description copied from class: TocNodeContent

Handles the context menu event occuring at a node. The method should handle the event according to the contextMenuItemValue parameter. This parameter is based on the context menu items generated by the getContextMenuItems() method.

Overrides:

handleContextMenuEvent in class TocNodeContent

Parameters:

contextMenuItemValue - the value of the context menu item to be processed

args - the TocEvent

Throws:

Exception