@Generated(value={"RichFaces CDK","4.5.0-SNAPSHOT"}) public class UITree extends AbstractTree implements javax.faces.component.behavior.ClientBehaviorHolder, MetaComponentEncoder, MetaComponentResolver, AjaxProps, CoreProps, EventsKeyProps, EventsMouseProps, I18nProps, ImmediateProps, SequenceProps, TreeCommonProps, TreeProps, TreeSelectionChangeSource, TreeToggleSource
The <rich:tree> component provides a hierarchical tree control. Each <rich:tree> component typically consists of <rich:treeNode> child components. The appearance and behavior of the tree and its nodes can be fully customized.
| Modifier and Type | Class and Description |
|---|---|
protected static class |
UITree.Properties |
UIDataAdaptor.ComponentVisitor| Modifier and Type | Field and Description |
|---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
DEFAULT_TREE_NODE_FACET_NAME, DEFAULT_TREE_NODE_ID, SELECTION_META_COMPONENT_IDdecodeVisitor, updateVisitor, validateVisitorATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEYMETA_COMPONENT_SEPARATOR_CHAR| Constructor and Description |
|---|
UITree() |
| Modifier and Type | Method and Description |
|---|---|
Object |
getData()
Serialized (on default with JSON) data passed to the client by a developer on an AJAX request.
|
String |
getDefaultEventName() |
String |
getDir()
Direction indication for text that does not inherit directionality.
|
Collection<String> |
getEventNames() |
Object |
getExecute()
IDs of components that will participate in the "execute" portion of the Request Processing Lifecycle.
|
String |
getFamily() |
String |
getHandleClass()
Space-separated list of CSS style class(es) to be applied to the tree node handles.
|
String |
getIconClass()
Space-separated list of CSS style class(es) to be applied to the tree node icons.
|
String |
getIconCollapsed()
The icon for collapsed node
|
String |
getIconExpanded()
The icon for expanded node
|
String |
getIconLeaf()
The icon for component leaves
|
String |
getLabelClass()
Space-separated list of CSS style class(es) to be applied to the tree node labels.
|
String |
getLang()
Code describing the language used in the generated markup for this component.
|
String |
getNodeClass()
Space-separated list of CSS style class(es) to be applied to the tree nodes.
|
String |
getNodeType()
Determines which treeNode should be used for rendering.
|
String |
getOnbeforedomupdate()
The client-side script method to be called after the ajax response comes back, but before the DOM is updated
|
String |
getOnbeforenodetoggle()
The client-side script method to be called before the node is toggled.
|
String |
getOnbeforeselectionchange()
The client-side script method to be called before the selection is changed.
|
String |
getOnbegin()
The client-side script method to be called before an ajax request.
|
String |
getOnclick()
Javascript code executed when a pointer button is clicked over this element.
|
String |
getOncomplete()
The client-side script method to be called after the DOM is updated
|
String |
getOndblclick()
Javascript code executed when a pointer button is double clicked over this element.
|
String |
getOnkeydown()
Javascript code executed when a key is pressed down over this element.
|
String |
getOnkeypress()
Javascript code executed when a key is pressed and released over this element.
|
String |
getOnkeyup()
Javascript code executed when a key is released over this element.
|
String |
getOnmousedown()
Javascript code executed when a pointer button is pressed down over this element.
|
String |
getOnmousemove()
Javascript code executed when a pointer button is moved within this element.
|
String |
getOnmouseout()
Javascript code executed when a pointer button is moved away from this element.
|
String |
getOnmouseover()
Javascript code executed when a pointer button is moved onto this element.
|
String |
getOnmouseup()
Javascript code executed when a pointer button is released over this element.
|
String |
getOnnodetoggle()
The client-side script method to be called after the node is toggled.
|
String |
getOnselectionchange()
The client-side script method to be called after the selection is changed.
|
Object |
getRender()
IDs of components that will participate in the "render" portion of the Request Processing Lifecycle.
|
javax.el.MethodExpression |
getSelectionChangeListener()
MethodExpression representing an tree node toggle listener method that will be notified when the tree node
is toggled.
|
SwitchType |
getSelectionType()
The type of type of the selection - ajax (default), client, server.
|
String |
getStatus()
Name of the request status component that will indicate the status of the Ajax request
|
String |
getStyle()
CSS style(s) to be applied when this component is rendered.
|
String |
getStyleClass()
Space-separated list of CSS style class(es) to be applied when this element is rendered.
|
String |
getTitle()
Advisory title information about markup elements generated for this component.
|
javax.el.MethodExpression |
getToggleListener()
Method expression referencing a method that will be called when an TreeSelectionChangeEvent has been broadcast for the listener.
|
String |
getToggleNodeEvent()
Client-side event used for toggling tree nodes (click, dblclick, etc.)
|
SwitchType |
getToggleType()
The type of type of the node toggling - ajax (default), client, server.
|
Object |
getValue()
Points to the data model
|
boolean |
isImmediate()
Flag indicating that, if this component is activated by the user, notifications should be delivered to interested
listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until the
Invoke Application phase.
|
boolean |
isLimitRender()
If "true", render only those ids specified in the "render" attribute, forgoing the render of the auto-rendered panels
|
void |
setData(Object data) |
void |
setDir(String dir) |
void |
setExecute(Object execute) |
void |
setHandleClass(String handleClass) |
void |
setIconClass(String iconClass) |
void |
setIconCollapsed(String iconCollapsed) |
void |
setIconExpanded(String iconExpanded) |
void |
setIconLeaf(String iconLeaf) |
void |
setImmediate(boolean immediate) |
void |
setLabelClass(String labelClass) |
void |
setLang(String lang) |
void |
setLimitRender(boolean limitRender) |
void |
setNodeClass(String nodeClass) |
void |
setNodeType(String nodeType) |
void |
setOnbeforedomupdate(String onbeforedomupdate) |
void |
setOnbeforenodetoggle(String onbeforenodetoggle) |
void |
setOnbeforeselectionchange(String onbeforeselectionchange) |
void |
setOnbegin(String onbegin) |
void |
setOnclick(String onclick) |
void |
setOncomplete(String oncomplete) |
void |
setOndblclick(String ondblclick) |
void |
setOnkeydown(String onkeydown) |
void |
setOnkeypress(String onkeypress) |
void |
setOnkeyup(String onkeyup) |
void |
setOnmousedown(String onmousedown) |
void |
setOnmousemove(String onmousemove) |
void |
setOnmouseout(String onmouseout) |
void |
setOnmouseover(String onmouseover) |
void |
setOnmouseup(String onmouseup) |
void |
setOnnodetoggle(String onnodetoggle) |
void |
setOnselectionchange(String onselectionchange) |
void |
setRender(Object render) |
void |
setSelectionChangeListener(javax.el.MethodExpression selectionChangeListener) |
void |
setSelectionType(SwitchType selectionType) |
void |
setStatus(String status) |
void |
setStyle(String style) |
void |
setStyleClass(String styleClass) |
void |
setTitle(String title) |
void |
setToggleListener(javax.el.MethodExpression toggleListener) |
void |
setToggleNodeEvent(String toggleNodeEvent) |
void |
setToggleType(SwitchType toggleType) |
void |
setValue(Object value) |
addTreeSelectionChangeListener, addTreeToggleListener, broadcast, convertDeclarativeKeyFromString, convertDeclarativeKeyToString, createComponentState, createExtendedDataModel, createSnapshot, dataChildren, encodeMetaComponent, findDeclarativeModel, findMatchingTreeNodeComponent, findTreeNodeComponent, getRowKeyConverter, getSelection, getTreeDataModel, getTreeRange, getTreeSelectionChangeListeners, getTreeToggleListeners, isExpanded, isLeaf, removeTreeSelectionChangeListener, removeTreeToggleListener, resetDataModel, resolveClientId, restoreChildState, restoreFromSnapshot, setSelection, setupCurrentComponent, substituteUnresolvedClientId, visitFixedChildren, walk, walkModelallFixedChildren, captureOrigValue, clearExtendedDataModel, clearInitialState, createUniqueId, doUpdate, extractKeySegment, fixedChildren, getComponentState, getContainerClientId, getContainerClientId, getExtendedDataModel, getIterationState, getLocalComponentState, getRowCount, getRowData, getRowKey, getRowKeyVar, getStateVar, getVar, getVariablesMap, invokeOnComponent, invokeOnRow, isKeepSaved, isListenerForSource, isRowAvailable, iterate, keepSaved, markInitialState, preDecode, preEncodeBegin, preUpdate, preValidate, processDecodes, processDecodesChildren, processEvent, processEvent, processUpdates, processUpdatesChildren, processValidatesChildren, processValidators, queueEvent, resetChildState, restoreChildState, restoreOrigValue, restoreState, saveChildState, saveChildState, saveState, setExtendedDataModel, setId, setIterationState, setKeepSaved, setRowKey, setRowKey, setRowKeyConverter, setRowKeyVar, setStateVar, setupVariable, setValueExpression, setVar, visitDataChildren, visitDataChildrenMetaComponents, visitTree, wrapEventaddClientBehavior, addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEventencodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInViewclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddClientBehavior, getClientBehaviorsencodeMetaComponentresolveClientId, substituteUnresolvedClientIdgetRowKeyConvertergetRowKeyVar, getSelection, getStateVar, getVar, isKeepSavedaddTreeSelectionChangeListener, removeTreeSelectionChangeListeneraddTreeToggleListener, removeTreeToggleListenerpublic static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public String getFamily()
getFamily in class AbstractTreepublic Collection<String> getEventNames()
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHoldergetEventNames in class javax.faces.component.UIComponentBasepublic String getDefaultEventName()
getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHoldergetDefaultEventName in class javax.faces.component.UIComponentBasepublic Object getData()
AjaxPropspublic void setData(Object data)
public String getDir()
I18nPropspublic void setDir(String dir)
public Object getExecute()
AjaxPropsgetExecute in interface AjaxPropspublic void setExecute(Object execute)
public String getHandleClass()
TreeCommonPropsgetHandleClass in interface TreeCommonPropspublic void setHandleClass(String handleClass)
public String getIconClass()
TreeCommonPropsgetIconClass in interface TreeCommonPropspublic void setIconClass(String iconClass)
public String getIconCollapsed()
TreeCommonPropsgetIconCollapsed in interface TreeCommonPropspublic void setIconCollapsed(String iconCollapsed)
public String getIconExpanded()
TreeCommonPropsgetIconExpanded in interface TreeCommonPropspublic void setIconExpanded(String iconExpanded)
public String getIconLeaf()
TreeCommonPropsgetIconLeaf in interface TreeCommonPropspublic void setIconLeaf(String iconLeaf)
public boolean isImmediate()
ImmediatePropsisImmediate in interface ImmediatePropspublic void setImmediate(boolean immediate)
public String getLabelClass()
TreeCommonPropsgetLabelClass in interface TreeCommonPropspublic void setLabelClass(String labelClass)
public String getLang()
I18nPropspublic void setLang(String lang)
public boolean isLimitRender()
AjaxPropsisLimitRender in interface AjaxPropspublic void setLimitRender(boolean limitRender)
public String getNodeClass()
TreePropsgetNodeClass in interface TreePropsgetNodeClass in class AbstractTreepublic void setNodeClass(String nodeClass)
public String getNodeType()
TreePropsgetNodeType in interface TreePropsgetNodeType in class AbstractTreepublic void setNodeType(String nodeType)
public String getOnbeforedomupdate()
AjaxPropsgetOnbeforedomupdate in interface AjaxPropspublic void setOnbeforedomupdate(String onbeforedomupdate)
public String getOnbeforenodetoggle()
TreePropsgetOnbeforenodetoggle in interface TreePropsgetOnbeforenodetoggle in class AbstractTreepublic void setOnbeforenodetoggle(String onbeforenodetoggle)
public String getOnbeforeselectionchange()
TreePropsgetOnbeforeselectionchange in interface TreePropsgetOnbeforeselectionchange in class AbstractTreepublic void setOnbeforeselectionchange(String onbeforeselectionchange)
public String getOnbegin()
AjaxPropsgetOnbegin in interface AjaxPropspublic void setOnbegin(String onbegin)
public String getOnclick()
EventsMousePropsgetOnclick in interface EventsMousePropspublic void setOnclick(String onclick)
public String getOncomplete()
AjaxPropsgetOncomplete in interface AjaxPropspublic void setOncomplete(String oncomplete)
public String getOndblclick()
EventsMousePropsgetOndblclick in interface EventsMousePropspublic void setOndblclick(String ondblclick)
public String getOnkeydown()
EventsKeyPropsgetOnkeydown in interface EventsKeyPropspublic void setOnkeydown(String onkeydown)
public String getOnkeypress()
EventsKeyPropsgetOnkeypress in interface EventsKeyPropspublic void setOnkeypress(String onkeypress)
public String getOnkeyup()
EventsKeyPropsgetOnkeyup in interface EventsKeyPropspublic void setOnkeyup(String onkeyup)
public String getOnmousedown()
EventsMousePropsgetOnmousedown in interface EventsMousePropspublic void setOnmousedown(String onmousedown)
public String getOnmousemove()
EventsMousePropsgetOnmousemove in interface EventsMousePropspublic void setOnmousemove(String onmousemove)
public String getOnmouseout()
EventsMousePropsgetOnmouseout in interface EventsMousePropspublic void setOnmouseout(String onmouseout)
public String getOnmouseover()
EventsMousePropsgetOnmouseover in interface EventsMousePropspublic void setOnmouseover(String onmouseover)
public String getOnmouseup()
EventsMousePropsgetOnmouseup in interface EventsMousePropspublic void setOnmouseup(String onmouseup)
public String getOnnodetoggle()
TreePropsgetOnnodetoggle in interface TreePropsgetOnnodetoggle in class AbstractTreepublic void setOnnodetoggle(String onnodetoggle)
public String getOnselectionchange()
TreePropsgetOnselectionchange in interface TreePropsgetOnselectionchange in class AbstractTreepublic void setOnselectionchange(String onselectionchange)
public Object getRender()
AjaxPropspublic void setRender(Object render)
public javax.el.MethodExpression getSelectionChangeListener()
TreePropsgetSelectionChangeListener in interface TreePropspublic void setSelectionChangeListener(javax.el.MethodExpression selectionChangeListener)
public SwitchType getSelectionType()
TreePropsgetSelectionType in interface TreePropsgetSelectionType in class AbstractTreepublic void setSelectionType(SwitchType selectionType)
public String getStatus()
AjaxPropspublic void setStatus(String status)
public String getStyle()
CorePropspublic void setStyle(String style)
public String getStyleClass()
CorePropsgetStyleClass in interface CorePropspublic void setStyleClass(String styleClass)
public String getTitle()
CorePropspublic void setTitle(String title)
public javax.el.MethodExpression getToggleListener()
TreePropsgetToggleListener in interface TreePropspublic void setToggleListener(javax.el.MethodExpression toggleListener)
public String getToggleNodeEvent()
TreePropsgetToggleNodeEvent in interface TreePropsgetToggleNodeEvent in class AbstractTreepublic void setToggleNodeEvent(String toggleNodeEvent)
public SwitchType getToggleType()
TreePropsgetToggleType in interface TreePropsgetToggleType in class AbstractTreepublic void setToggleType(SwitchType toggleType)
public Object getValue()
AbstractTreegetValue in class AbstractTreepublic void setValue(Object value)
Copyright © 2014 JBoss by Red Hat. All Rights Reserved.