|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.util.EventObject javax.faces.event.FacesEvent javax.faces.event.ActionEvent com.esri.adf.web.faces.event.ADFEvent com.esri.adf.web.faces.event.TocEvent
public class TocEvent
The EventArgs object for the TocControl
for storing TOC nodes and the
current state of those nodes.
Nested Class Summary | |
---|---|
static class |
TocEvent.CheckedTocNode
Represents a node for the checked/unchecked operation. |
Field Summary | |
---|---|
protected Collection<TocEvent.CheckedTocNode> |
checkedNodes
The collection of TocEvent.CheckedTocNode objects. |
protected String |
contextMenuItemValue
the value of the context menu item to be processed |
protected TocNode |
node
The TOC node to perform the event. |
protected int |
nodeOperation
The operation to perform on the node. |
Fields inherited from class com.esri.adf.web.faces.event.ADFEvent |
---|
context, parameters |
Fields inherited from class java.util.EventObject |
---|
source |
Constructor Summary | |
---|---|
TocEvent(javax.faces.component.UIComponent source,
javax.faces.context.FacesContext facesContext,
WebContext context,
TocNode node,
int nodeOperation,
String contextMenuItemValue,
Collection<? extends TocEvent.CheckedTocNode> checkedNodes)
Constructs the TOC event arguments object. |
Method Summary | |
---|---|
Collection<TocEvent.CheckedTocNode> |
getCheckedNodes()
Returns a collection of TocEvent.CheckedTocNode s. |
String |
getContextMenuItemValue()
The value of the context menu item to be processed |
TocNode |
getNode()
Returns the node associated with this operation. |
int |
getNodeOperation()
Returns the operation to perform on the node. |
Methods inherited from class com.esri.adf.web.faces.event.ADFEvent |
---|
getParameter, getWebContext |
Methods inherited from class javax.faces.event.ActionEvent |
---|
isAppropriateListener, processListener |
Methods inherited from class javax.faces.event.FacesEvent |
---|
getComponent, getPhaseId, queue, setPhaseId |
Methods inherited from class java.util.EventObject |
---|
getSource, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected TocNode node
protected int nodeOperation
protected Collection<TocEvent.CheckedTocNode> checkedNodes
TocEvent.CheckedTocNode
objects.
protected String contextMenuItemValue
Constructor Detail |
---|
public TocEvent(javax.faces.component.UIComponent source, javax.faces.context.FacesContext facesContext, WebContext context, TocNode node, int nodeOperation, String contextMenuItemValue, Collection<? extends TocEvent.CheckedTocNode> checkedNodes)
TocControl
calls the TocNode.handleNodeEvent(com.esri.adf.web.faces.event.TocEvent)
method on that node. If checkedNodes is not null, then the TocControl
calls the TocNode.handleCheckedEvent(boolean, com.esri.adf.web.faces.event.TocEvent)
method on all the nodes in this collection of
TocEvent.CheckedTocNode
objects.
source
- the JSF componentfacesContext
- the FacesContext
context
- the WebContext
node
- the node to perform the operation onnodeOperation
- the operation to perform on the node (0 indicates expand/collapse, 1 indicates check/uncheck,
and an integer other than -1, 0, or 1 indicates a custom operation)contextMenuItemValue
- - the value of the context menu item to be processedcheckedNodes
- a collection of TocEvent.CheckedTocNode
objectsMethod Detail |
---|
public TocNode getNode()
public int getNodeOperation()
public String getContextMenuItemValue()
public Collection<TocEvent.CheckedTocNode> getCheckedNodes()
TocEvent.CheckedTocNode
s.
Collection
- the TocEvent.CheckedTocNode
s
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |