com.esri.adf.web.data
Class TocResourceContent

java.lang.Object
  com.esri.adf.web.data.TocNodeContent
      com.esri.adf.web.data.TocResourceContent

All Implemented Interfaces:

java.io.Serializable

public class TocResourceContent
extends TocNodeContent

See Also:

Serialized Form

Field Summary

static java.lang.String	CHANGE_TRANSPARENCY_CONTEXT_MENU_ITEM
protected static javax.faces.model.SelectItem	changeTransparency
protected static java.util.ArrayList<javax.faces.model.SelectItem>	commonItems
static java.lang.String	DISABLE_OVERVIEW_CONTEXT_MENU_ITEM
protected static javax.faces.model.SelectItem	disableOverview
static java.lang.String	ENABLE_OVERVIEW_CONTEXT_MENU_ITEM
protected static javax.faces.model.SelectItem	enableOverview
protected MapFunctionality	mFunc
static java.lang.String	MOVE_DOWN_CONTEXT_MENU_ITEM
static java.lang.String	MOVE_UP_CONTEXT_MENU_ITEM
protected static javax.faces.model.SelectItem	moveDown
protected static javax.faces.model.SelectItem	moveUp
protected WebToc	mToc
static java.lang.String	REMOVE_RESOURCE_CONTEXT_MENU_ITEM
protected static javax.faces.model.SelectItem	removeResource
protected GISResource	resource
protected TocNode	resourceNode
protected TocFunctionality	tFunc
static java.lang.String	ZOOM_TO_RESOURCE_CONTEXT_MENU_ITEM
protected static javax.faces.model.SelectItem	zoomToResource

Constructor Summary

TocResourceContent()

TocResourceContent(GISResource resource)

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.
GISResource	getResource()
TocNode	getResourceNode()
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.
boolean	isSelected() Returns an indicator if the node is selected.
void	setResource(GISResource resource)
void	setResourceNode(TocNode resourceNode)

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

getImageUrl, handleExpandCollapseEvent, isUrl

Methods inherited from class java.lang.Object

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

Field Detail

resourceNode

protected TocNode resourceNode

mToc

protected WebToc mToc

resource

protected GISResource resource

mFunc

protected MapFunctionality mFunc

tFunc

protected TocFunctionality tFunc

MOVE_UP_CONTEXT_MENU_ITEM

public static final java.lang.String MOVE_UP_CONTEXT_MENU_ITEM

See Also:

Constant Field Values

MOVE_DOWN_CONTEXT_MENU_ITEM

public static final java.lang.String MOVE_DOWN_CONTEXT_MENU_ITEM

See Also:

Constant Field Values

REMOVE_RESOURCE_CONTEXT_MENU_ITEM

public static final java.lang.String REMOVE_RESOURCE_CONTEXT_MENU_ITEM

See Also:

Constant Field Values

ZOOM_TO_RESOURCE_CONTEXT_MENU_ITEM

public static final java.lang.String ZOOM_TO_RESOURCE_CONTEXT_MENU_ITEM

See Also:

Constant Field Values

ENABLE_OVERVIEW_CONTEXT_MENU_ITEM

public static final java.lang.String ENABLE_OVERVIEW_CONTEXT_MENU_ITEM

See Also:

Constant Field Values

DISABLE_OVERVIEW_CONTEXT_MENU_ITEM

public static final java.lang.String DISABLE_OVERVIEW_CONTEXT_MENU_ITEM

See Also:

Constant Field Values

CHANGE_TRANSPARENCY_CONTEXT_MENU_ITEM

public static final java.lang.String CHANGE_TRANSPARENCY_CONTEXT_MENU_ITEM

See Also:

Constant Field Values

moveUp

protected static final javax.faces.model.SelectItem moveUp

moveDown

protected static final javax.faces.model.SelectItem moveDown

removeResource

protected static final javax.faces.model.SelectItem removeResource

zoomToResource

protected static final javax.faces.model.SelectItem zoomToResource

disableOverview

protected static final javax.faces.model.SelectItem disableOverview

enableOverview

protected static final javax.faces.model.SelectItem enableOverview

changeTransparency

protected static final javax.faces.model.SelectItem changeTransparency

commonItems

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

Constructor Detail

TocResourceContent

public TocResourceContent(GISResource resource)

TocResourceContent

public TocResourceContent()

Method Detail

handleNodeEvent

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

Description copied from class: TocNodeContent

Handles the event which occurs at a content node. The TocNode delegates event handling for node content operations to this method, typically when the node is clicked.

Specified by:

handleNodeEvent in class TocNodeContent

Parameters:

args - the TocEvent

Throws:

java.lang.Exception

getText

public java.lang.String getText()

Description copied from class: TocNodeContent

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

Description copied from class: TocNodeContent

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

isCheckable

public boolean isCheckable()

Description copied from class: TocNodeContent

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

Description copied from class: TocNodeContent

If isCheckable() is true, it indicates whether it is checked. If isCheckable() is false, this method has no significance.

Overrides:

isChecked in class TocNodeContent

Returns:

boolean- returns false

isSelected

public boolean isSelected()

Description copied from class: TocNodeContent

Returns an indicator if the node is selected.

Overrides:

isSelected in class TocNodeContent

Returns:

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

isDisabled

public boolean isDisabled()

Description copied from class: TocNodeContent

Returns an indicator whether this node disabled.

Overrides:

isDisabled in class TocNodeContent

Returns:

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

setResource

public void setResource(GISResource resource)

getResource

public GISResource getResource()

getResourceNode

public TocNode getResourceNode()

setResourceNode

public void setResourceNode(TocNode resourceNode)

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