|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIData
org.ajax4jsf.component.UIDataAdaptor
org.richfaces.component.UITree
public abstract class UITree
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class org.ajax4jsf.component.UIDataAdaptor |
|---|
org.ajax4jsf.component.UIDataAdaptor.ComponentVisitor, org.ajax4jsf.component.UIDataAdaptor.IndexedEvent |
| Field Summary | |
|---|---|
static java.lang.String |
COMPONENT_FAMILY
|
static java.lang.String |
COMPONENT_TYPE
|
static java.lang.String |
DEFAULT_HIGHLIGHTED_CSS_CLASS
|
static java.lang.String |
DEFAULT_SELECTED_CSS_CLASS
|
static java.lang.String |
PRESERVE_MODEL_NONE
|
static java.lang.String |
PRESERVE_MODEL_REQUEST
|
static java.lang.String |
PRESERVE_MODEL_STATE
|
static java.lang.String |
SELECTED_NODE_PARAMETER_NAME
|
static java.lang.String |
SELECTION_INPUT_ATTRIBUTE
|
static java.lang.String |
SWITCH_AJAX
|
static java.lang.String |
SWITCH_CLIENT
|
static java.lang.String |
SWITCH_SERVER
|
| Fields inherited from class org.ajax4jsf.component.UIDataAdaptor |
|---|
COMPONENT_STATE_ATTRIBUTE, decodeVisitor, EMPTY_MODEL, updateVisitor, validateVisitor |
| Fields inherited from class javax.faces.component.UIComponent |
|---|
bindings |
| Fields inherited from interface org.ajax4jsf.component.AjaxComponent |
|---|
AJAX_COMPONETT_PARAMETER |
| Fields inherited from interface javax.faces.component.NamingContainer |
|---|
SEPARATOR_CHAR |
| Constructor Summary | |
|---|---|
UITree()
|
|
| Method Summary | |
|---|---|
void |
addChangeExpandListener(org.richfaces.event.NodeExpandedListener listener)
|
void |
addDragListener(org.richfaces.event.DragListener listener)
|
void |
addDropListener(org.richfaces.event.DropListener listener)
|
void |
addNodeSelectListener(org.richfaces.event.NodeSelectedListener listener)
|
void |
broadcast(javax.faces.event.FacesEvent event)
|
protected org.ajax4jsf.model.DataComponentState |
createComponentState()
|
protected org.ajax4jsf.model.ExtendedDataModel |
createDataModel()
|
protected java.util.Iterator |
dataChildren()
|
protected java.util.Iterator |
fixedChildren()
|
abstract javax.faces.el.MethodBinding |
getAdviseNodeOpened()
|
abstract javax.faces.el.MethodBinding |
getAdviseNodeSelected()
|
org.richfaces.event.NodeExpandedListener[] |
getChangeExpandListeners()
|
org.richfaces.event.DragListener[] |
getDragListeners()
|
org.richfaces.event.DropListener[] |
getDropListeners()
|
abstract java.lang.String |
getHighlightedClass()
|
abstract java.lang.String |
getIcon()
|
abstract java.lang.String |
getIconCollapsed()
|
abstract java.lang.String |
getIconExpanded()
|
abstract java.lang.String |
getIconLeaf()
|
abstract java.lang.String |
getNodeFace()
|
UITreeNode |
getNodeFacet()
Locates UITreeNode instance that has type equal to current
nodeFace. |
org.richfaces.event.NodeSelectedListener[] |
getNodeSelectListeners()
|
protected UITreeNode |
getOrCreateDefaultFacet()
Lazily creates default node representation that is used if there is no UITreeNode child for that nodeFace |
abstract java.lang.String |
getPreserveModel()
|
boolean |
getRendersChildren()
|
java.lang.String |
getResolvedDragIndicator(javax.faces.context.FacesContext facesContext)
|
java.lang.Object |
getRowData(java.lang.Object rowKey)
Return the data object representing the node data for the contextual row key |
abstract java.lang.String |
getSelectedClass()
|
java.lang.String |
getSelectionStateInputName(javax.faces.context.FacesContext context)
|
abstract java.lang.Object |
getStateAdvisor()
|
abstract java.lang.String |
getSwitchType()
|
org.richfaces.model.TreeNode |
getTreeNode()
Return the data object representing the node for the currently selected row key, if any |
org.richfaces.model.TreeNode |
getTreeNode(java.lang.Object rowKey)
Return the data object representing the node for the contextual row key |
java.lang.String |
getTreeNodeVar()
Get name of EL variable for the tree node. |
boolean |
hasAjaxSubmitSelection()
|
abstract boolean |
isAjaxSubmitSelection()
|
boolean |
isExpanded()
Returns whether current node is expanded |
abstract boolean |
isImmediate()
|
boolean |
isLeaf()
Returns whether current node is leaf ie. |
boolean |
isSelected()
Returns whether current node is selected |
abstract boolean |
isShowConnectingLines()
|
protected boolean |
isStopInCollapsed()
Returns whether switch type is set to "server" |
abstract boolean |
isToggleOnClick()
|
void |
processDecodes(javax.faces.context.FacesContext faces)
|
void |
processUpdates(javax.faces.context.FacesContext faces)
|
void |
queueCollapseAll()
Queues all node collapsion command |
void |
queueEvent(javax.faces.event.FacesEvent event)
|
void |
queueExpandAll()
Queues all node expansion command |
void |
queueNodeCollapse(org.richfaces.model.TreeRowKey rowKey)
Queues collapsion command for node whose row key is equal to rowKey parameter |
void |
queueNodeExpand(org.richfaces.model.TreeRowKey rowKey)
Queues expansion command for node whose row key is equal to rowKey parameter |
void |
removeChangeExpandListener(org.richfaces.event.NodeExpandedListener listener)
|
void |
removeDragListener(org.richfaces.event.DragListener listener)
|
void |
removeDropListener(org.richfaces.event.DropListener listener)
|
void |
removeNodeSelectListener(org.richfaces.event.NodeSelectedListener listener)
|
void |
resetDataModel()
|
void |
restoreState(javax.faces.context.FacesContext faces,
java.lang.Object object)
|
java.lang.Object |
saveState(javax.faces.context.FacesContext faces)
|
abstract void |
setAdviseNodeOpened(javax.faces.el.MethodBinding adviseNodeOpened)
|
abstract void |
setAdviseNodeSelected(javax.faces.el.MethodBinding adviseNodeSelected)
|
abstract void |
setAjaxSubmitSelection(boolean ajaxSubmitSelection)
|
abstract void |
setHighlightedClass(java.lang.String selectedClass)
|
abstract void |
setIcon(java.lang.String icon)
|
abstract void |
setIconCollapsed(java.lang.String icon)
|
abstract void |
setIconExpanded(java.lang.String icon)
|
abstract void |
setIconLeaf(java.lang.String icon)
|
abstract void |
setImmediate(boolean immediate)
|
abstract void |
setNodeFace(java.lang.String nodeFace)
|
abstract void |
setPreserveModel(java.lang.String preserveModel)
|
void |
setSelected()
Sets current node as selected |
abstract void |
setSelectedClass(java.lang.String selectedClass)
|
abstract void |
setShowConnectingLines(boolean showConnectingLines)
|
abstract void |
setStateAdvisor(java.lang.Object nodeFace)
|
abstract void |
setSwitchType(java.lang.String switchType)
|
abstract void |
setToggleOnClick(boolean toggleOnClick)
|
void |
setTreeNodeVar(java.lang.String treeNodeVar)
Set the name of EL variable |
protected void |
setupVariable(javax.faces.context.FacesContext faces,
javax.faces.model.DataModel localModel,
boolean rowSelected)
Setup EL variable for different iteration. |
void |
walk(javax.faces.context.FacesContext faces,
org.ajax4jsf.model.DataVisitor visitor)
|
void |
walk(javax.faces.context.FacesContext faces,
org.ajax4jsf.model.DataVisitor visitor,
org.ajax4jsf.model.Range range,
java.lang.Object rowKey,
java.lang.Object argument)
Walks through model or some subset of it if rowKey is not null |
void |
walkModel(javax.faces.context.FacesContext faces,
org.ajax4jsf.model.DataVisitor visitor,
org.ajax4jsf.model.Range range,
java.lang.Object key,
java.lang.Object argument)
Walks through backing data model if current data model has one. |
| Methods inherited from class org.ajax4jsf.component.UIDataAdaptor |
|---|
addRequestKey, broadcastLocal, captureOrigValue, captureOrigValue, clearRequestKeysSet, containsRequestKey, encodeAjaxChild, encodeBegin, getAjaxKeys, getAllAjaxKeys, getBaseClientId, getChildrenRenderer, getChildState, getClientId, getComponentState, getEncodedIds, getExtendedDataModel, getRowCount, getRowData, getRowIndex, getRowKey, getRowKeyVar, getStateVar, getValue, isRowAvailable, iterate, processDecodes, processUpdates, processValidators, processValidators, removeRequestKey, resetComponent, restoreChildState, restoreOrigValue, restoreOrigValue, saveChildState, setAjaxKeys, setComponentState, setExtendedDataModel, setId, setParent, setRowIndex, setRowKey, setRowKey, setRowKeyVar, setStateVar, setValue, walk |
| Methods inherited from class javax.faces.component.UIData |
|---|
getDataModel, getFamily, getFirst, getFooter, getHeader, getRows, getVar, invokeOnComponent, setDataModel, setFirst, setFooter, setHeader, setRows, setValueBinding, setValueExpression, setVar |
| Methods inherited from class javax.faces.component.UIComponentBase |
|---|
addFacesListener, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setRendered, setRendererType, setTransient |
| Methods inherited from class javax.faces.component.UIComponent |
|---|
encodeAll, getContainerClientId, getValueExpression |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface org.richfaces.event.TreeListenerEventsProducer |
|---|
getChangeExpandListener, getDragListener, getDropListener, getNodeSelectListener, setChangeExpandListener, setDragListener, setDropListener, setNodeSelectListener |
| Methods inherited from interface org.richfaces.component.Draggable |
|---|
getDragIndicator, getDragListener, getDragType, getDragValue, getGrabbingCursors, getGrabCursors, getOndragend, getOndragstart, getOndropout, getOndropover, setDragIndicator, setDragListener, setDragType, setDragValue, setGrabbingCursors, setGrabCursors, setOndragend, setOndragstart, setOndropout, setOndropover |
| Methods inherited from interface org.richfaces.component.Dropzone |
|---|
getAcceptCursors, getAcceptedTypes, getCursorTypeMapping, getDropValue, getOndragenter, getOndragexit, getOndrop, getOndropend, getRejectCursors, getTypeMapping, setAcceptCursors, setAcceptedTypes, setCursorTypeMapping, setDropValue, setOndragenter, setOndragexit, setOndrop, setOndropend, setRejectCursors, setTypeMapping |
| Methods inherited from interface org.richfaces.event.DropSource |
|---|
getDropListener, setDropListener |
| Methods inherited from interface org.ajax4jsf.component.AjaxComponent |
|---|
getData, getEventsQueue, getFocus, getOnbeforedomupdate, getOncomplete, getRequestDelay, getReRender, getStatus, getTimeout, isAjaxSingle, isBypassUpdates, isIgnoreDupResponses, isLimitToList, setAjaxSingle, setBypassUpdates, setData, setEventsQueue, setFocus, setIgnoreDupResponses, setLimitToList, setOnbeforedomupdate, setOncomplete, setRequestDelay, setReRender, setStatus, setTimeout |
| Field Detail |
|---|
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String PRESERVE_MODEL_STATE
public static final java.lang.String PRESERVE_MODEL_REQUEST
public static final java.lang.String PRESERVE_MODEL_NONE
public static final java.lang.String SWITCH_SERVER
public static final java.lang.String SWITCH_CLIENT
public static final java.lang.String SWITCH_AJAX
public static final java.lang.String SELECTED_NODE_PARAMETER_NAME
public static final java.lang.String SELECTION_INPUT_ATTRIBUTE
public static final java.lang.String DEFAULT_SELECTED_CSS_CLASS
public static final java.lang.String DEFAULT_HIGHLIGHTED_CSS_CLASS
| Constructor Detail |
|---|
public UITree()
| Method Detail |
|---|
public boolean getRendersChildren()
getRendersChildren in class javax.faces.component.UIComponentBasepublic java.lang.String getTreeNodeVar()
public void setTreeNodeVar(java.lang.String treeNodeVar)
treeNodeVar - the varStatus to setprotected UITreeNode getOrCreateDefaultFacet()
UITreeNode child for that nodeFace
public org.richfaces.model.TreeNode getTreeNode()
TreeNode instance corresponding to the current row keypublic abstract boolean isImmediate()
public abstract void setImmediate(boolean immediate)
public void queueEvent(javax.faces.event.FacesEvent event)
queueEvent in class org.ajax4jsf.component.UIDataAdaptorpublic UITreeNode getNodeFacet()
UITreeNode instance that has type equal to current
nodeFace. Default nodeFace is declared as #{var.type} by default where
var is "var" attribute value Calls getOrCreateDefaultFacet()
if none found.
UITreeNode representing current nodeFacegetOrCreateDefaultFacet()
protected void setupVariable(javax.faces.context.FacesContext faces,
javax.faces.model.DataModel localModel,
boolean rowSelected)
UIDataAdaptor class
setupVariable in class org.ajax4jsf.component.UIDataAdaptorfaces - - current faces contextlocalModel - - reference to data modelrowSelected - - boolean flag indicating whether the row is selectedpublic void resetDataModel()
resetDataModel in class org.ajax4jsf.component.UIDataAdaptor
public void walk(javax.faces.context.FacesContext faces,
org.ajax4jsf.model.DataVisitor visitor)
throws java.io.IOException
java.io.IOException
public void walk(javax.faces.context.FacesContext faces,
org.ajax4jsf.model.DataVisitor visitor,
org.ajax4jsf.model.Range range,
java.lang.Object rowKey,
java.lang.Object argument)
throws java.io.IOException
faces - FacesContext instancevisitor - UIDataAdaptor.ComponentVisitor instancerange - Range range instancerowKey - row key to start from or null to start
from rootargument - implementation-specific visitor argument
java.io.IOException
public void walkModel(javax.faces.context.FacesContext faces,
org.ajax4jsf.model.DataVisitor visitor,
org.ajax4jsf.model.Range range,
java.lang.Object key,
java.lang.Object argument)
throws java.io.IOException
faces - FacesContext instancevisitor - UIDataAdaptor.ComponentVisitor instancerange - Range range instancerowKey - row key to start from or null to start
from rootargument - implementation-specific visitor argument
java.io.IOExceptionpublic java.lang.String getSelectionStateInputName(javax.faces.context.FacesContext context)
public void processDecodes(javax.faces.context.FacesContext faces)
processDecodes in class org.ajax4jsf.component.UIDataAdaptorprotected java.util.Iterator dataChildren()
dataChildren in class org.ajax4jsf.component.UIDataAdaptorpublic boolean isLeaf()
true if current node is leaf else
falsepublic boolean isExpanded()
true if node is expanded else falsepublic boolean isSelected()
true if node is selected else falsepublic void setSelected()
protected java.util.Iterator fixedChildren()
fixedChildren in class org.ajax4jsf.component.UIDataAdaptorprotected org.ajax4jsf.model.DataComponentState createComponentState()
createComponentState in class org.ajax4jsf.component.UIDataAdaptorprotected boolean isStopInCollapsed()
true if switch type is "server" else
false
public void broadcast(javax.faces.event.FacesEvent event)
throws javax.faces.event.AbortProcessingException
broadcast in class org.ajax4jsf.component.UIDataAdaptorjavax.faces.event.AbortProcessingExceptionpublic boolean hasAjaxSubmitSelection()
hasAjaxSubmitSelection in interface org.richfaces.event.TreeListenerEventsProducerpublic void processUpdates(javax.faces.context.FacesContext faces)
processUpdates in class org.ajax4jsf.component.UIDataAdaptorprotected org.ajax4jsf.model.ExtendedDataModel createDataModel()
createDataModel in class org.ajax4jsf.component.UIDataAdaptor
public void queueNodeExpand(org.richfaces.model.TreeRowKey rowKey)
throws java.io.IOException
rowKey - of the node to expand
java.io.IOException
public void queueNodeCollapse(org.richfaces.model.TreeRowKey rowKey)
throws java.io.IOException
rowKey - of the node to expand
java.io.IOException
public void queueExpandAll()
throws java.io.IOException
java.io.IOException
public void queueCollapseAll()
throws java.io.IOException
java.io.IOExceptionpublic abstract java.lang.String getSwitchType()
public abstract void setSwitchType(java.lang.String switchType)
public abstract java.lang.String getIcon()
public abstract void setIcon(java.lang.String icon)
public abstract java.lang.String getIconExpanded()
public abstract void setIconExpanded(java.lang.String icon)
public abstract java.lang.String getIconCollapsed()
public abstract void setIconCollapsed(java.lang.String icon)
public abstract java.lang.String getIconLeaf()
public abstract void setIconLeaf(java.lang.String icon)
public abstract void setShowConnectingLines(boolean showConnectingLines)
public abstract boolean isShowConnectingLines()
public abstract void setAjaxSubmitSelection(boolean ajaxSubmitSelection)
public abstract boolean isAjaxSubmitSelection()
public abstract java.lang.String getPreserveModel()
public abstract void setPreserveModel(java.lang.String preserveModel)
public abstract void setHighlightedClass(java.lang.String selectedClass)
public abstract java.lang.String getHighlightedClass()
public abstract void setSelectedClass(java.lang.String selectedClass)
public abstract java.lang.String getSelectedClass()
public abstract void setNodeFace(java.lang.String nodeFace)
public abstract java.lang.String getNodeFace()
public abstract void setToggleOnClick(boolean toggleOnClick)
public abstract boolean isToggleOnClick()
public abstract void setStateAdvisor(java.lang.Object nodeFace)
public abstract java.lang.Object getStateAdvisor()
public abstract javax.faces.el.MethodBinding getAdviseNodeOpened()
public abstract void setAdviseNodeOpened(javax.faces.el.MethodBinding adviseNodeOpened)
public abstract javax.faces.el.MethodBinding getAdviseNodeSelected()
public abstract void setAdviseNodeSelected(javax.faces.el.MethodBinding adviseNodeSelected)
public void addChangeExpandListener(org.richfaces.event.NodeExpandedListener listener)
addChangeExpandListener in interface org.richfaces.event.TreeListenerEventsProducerpublic void addNodeSelectListener(org.richfaces.event.NodeSelectedListener listener)
addNodeSelectListener in interface org.richfaces.event.TreeListenerEventsProducerpublic void removeChangeExpandListener(org.richfaces.event.NodeExpandedListener listener)
public void removeNodeSelectListener(org.richfaces.event.NodeSelectedListener listener)
public org.richfaces.event.NodeExpandedListener[] getChangeExpandListeners()
public org.richfaces.event.NodeSelectedListener[] getNodeSelectListeners()
public void addDropListener(org.richfaces.event.DropListener listener)
addDropListener in interface org.richfaces.event.DropSourcepublic org.richfaces.event.DropListener[] getDropListeners()
getDropListeners in interface org.richfaces.event.DropSourcepublic void removeDropListener(org.richfaces.event.DropListener listener)
removeDropListener in interface org.richfaces.event.DropSourcepublic void addDragListener(org.richfaces.event.DragListener listener)
addDragListener in interface org.richfaces.component.Draggablepublic org.richfaces.event.DragListener[] getDragListeners()
getDragListeners in interface org.richfaces.component.Draggablepublic void removeDragListener(org.richfaces.event.DragListener listener)
removeDragListener in interface org.richfaces.component.Draggablepublic java.lang.Object getRowData(java.lang.Object rowKey)
rowKey - contextual row key
public org.richfaces.model.TreeNode getTreeNode(java.lang.Object rowKey)
rowKey - contextual row key
TreeNode instance corresponding to the current row keypublic java.lang.Object saveState(javax.faces.context.FacesContext faces)
saveState in interface javax.faces.component.StateHoldersaveState in class org.ajax4jsf.component.UIDataAdaptor
public void restoreState(javax.faces.context.FacesContext faces,
java.lang.Object object)
restoreState in interface javax.faces.component.StateHolderrestoreState in class org.ajax4jsf.component.UIDataAdaptorpublic java.lang.String getResolvedDragIndicator(javax.faces.context.FacesContext facesContext)
getResolvedDragIndicator in interface org.richfaces.component.Draggable
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||