com.esri.adf.web.aims.data
Class AIMSTocLayerContent

java.lang.Object
  extended bycom.esri.adf.web.data.TocNodeContent
      extended bycom.esri.adf.web.aims.data.AIMSTocLayerContent
All Implemented Interfaces:
java.io.Serializable

public class AIMSTocLayerContent
extends TocNodeContent

See Also:
Serialized Form

Field Summary
protected static java.util.ArrayList commonItems
           
static java.lang.String ZOOM_TO_LAYER_CONTEXT_MENU_ITEM
           
protected static javax.faces.model.SelectItem zoomToLayer
           
 
Constructor Summary
AIMSTocLayerContent(AIMSTocFunctionality aimsTocFunc, com.esri.aims.mtier.model.map.layer.Layer layer)
          Constructs the AIMSTocLayerContent object and stores the information needed for the layer.
 
Method Summary
 java.util.List 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.
 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

ZOOM_TO_LAYER_CONTEXT_MENU_ITEM

public static final java.lang.String ZOOM_TO_LAYER_CONTEXT_MENU_ITEM
See Also:
Constant Field Values

zoomToLayer

protected static final javax.faces.model.SelectItem zoomToLayer

commonItems

protected static final java.util.ArrayList commonItems
Constructor Detail

AIMSTocLayerContent

public AIMSTocLayerContent(AIMSTocFunctionality aimsTocFunc,
                           com.esri.aims.mtier.model.map.layer.Layer layer)
Constructs the AIMSTocLayerContent object and stores the information needed for the layer.

Parameters:
aimsTocFunc - AIMSTocFunctionality object
layer - the Layer object
Method Detail

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 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:
args - the TocEvent
Throws:
java.lang.Exception