com.esri.adf.web.wms.data
Class WMSTocLayerContent

java.lang.Object
  com.esri.adf.web.data.TocNodeContent
      com.esri.adf.web.wms.data.WMSTocLayerContent

All Implemented Interfaces:

java.io.Serializable

public class WMSTocLayerContent
extends TocNodeContent

Defines layer nodes of TOC for WMS resources. Each node represents a WMS layer, which can be either a group layer or a leaf layer.

See Also:

Serialized Form

Field Summary

protected static java.util.ArrayList<javax.faces.model.SelectItem>	commonItems
protected boolean	scaleIndependent
static java.lang.String	ZOOM_TO_LAYER_CONTEXT_MENU_ITEM A Context Menu Item name: "zoomToLayer".
protected static javax.faces.model.SelectItem	zoomToLayer

Constructor Summary

WMSTocLayerContent()
Constructs an empty WMSTocLayerContent object.

WMSTocLayerContent(com.esri.wms.client.Layer layer)
Constructs the WMSTocLayerContent object and stores the information needed for the layer.

WMSTocLayerContent(WMSTocFunctionality func, com.esri.wms.client.Layer wmsLayer)
Constructs the WMSTocLayerContent object and stores the information needed for the layer.

Method Summary

java.util.List<javax.faces.model.SelectItem>	getContextMenuItems() The list of javax.faces.model.SelectItem objects representing each item of this node's context menu.
java.lang.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(java.lang.String contextMenuItemValue, TocEvent args) Handles the context menu event occuring at a node.
void	handleNodeEvent(TocEvent args) Handles the event which occurs at a content node.
void	initLayerContent(WMSTocFunctionality func, com.esri.wms.client.Layer wmsLayer) Initializes the WMSTocLayerContent object and stores the information needed for the layer.
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.

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

getImageUrl, handleExpandCollapseEvent, isSelected, isUrl

Methods inherited from class java.lang.Object

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

Field Detail

scaleIndependent

protected boolean scaleIndependent

ZOOM_TO_LAYER_CONTEXT_MENU_ITEM

public static final java.lang.String ZOOM_TO_LAYER_CONTEXT_MENU_ITEM

A Context Menu Item name: "zoomToLayer".

See Also:

Constant Field Values

zoomToLayer

protected static final javax.faces.model.SelectItem zoomToLayer

commonItems

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

Constructor Detail

WMSTocLayerContent

public WMSTocLayerContent()

Constructs an empty WMSTocLayerContent object.

WMSTocLayerContent

public WMSTocLayerContent(com.esri.wms.client.Layer layer)

Constructs the WMSTocLayerContent object and stores the information needed for the layer.

Parameters:

layer - the Layer object

WMSTocLayerContent

public WMSTocLayerContent(WMSTocFunctionality func,
                          com.esri.wms.client.Layer wmsLayer)

Constructs the WMSTocLayerContent object and stores the information needed for the layer.

Parameters:

func - the associated TOC function

wmsLayer - the associated WMS layer

Method Detail

initLayerContent

public void initLayerContent(WMSTocFunctionality func,
                             com.esri.wms.client.Layer wmsLayer)

Initializes the WMSTocLayerContent object and stores the information needed for the layer.

Parameters:

wmsLayer - the Layer object

getText

public java.lang.String getText()

Returns the text displayed on the node.

Specified by:

getText in class TocNodeContent

Returns:

String- the text

handleCheckedEvent

public void handleCheckedEvent(boolean checked,
                               TocEvent args)
                        throws java.lang.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:

java.lang.Exception

handleNodeEvent

public void handleNodeEvent(TocEvent args)
                     throws java.lang.Exception

Handles the event which occurs at a content node.

Specified by:

handleNodeEvent in class TocNodeContent

Parameters:

args - the TocEvent

Throws:

java.lang.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.

getContextMenuItems

public java.util.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

handleContextMenuEvent

public void handleContextMenuEvent(java.lang.String contextMenuItemValue,
                                   TocEvent args)
                            throws java.lang.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:

java.lang.Exception