@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_ID
decodeVisitor, updateVisitor, validateVisitor
ATTRS_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_KEY
META_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()
Method expression referencing a method that will be called when an TreeSelectionChangeEvent has been broadcast for the listener.
|
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()
MethodExpression representing an tree node toggle listener method that will be notified when the tree node
is toggled.
|
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
|
boolean |
isUseDefaultNode()
When "true" a default treeNode will be created for nodes in the dataModel that do not match any existing treeNode.
|
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 |
setUseDefaultNode(boolean useDefaultNode) |
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, walkModel
allFixedChildren, 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, matchesBaseId, 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, wrapEvent
addClientBehavior, addFacesListener, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setParent, setRendered, setRendererType, setTransient, setValueBinding
getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInView, subscribeToEvent, unsubscribeFromEvent
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
addClientBehavior, getClientBehaviors
encodeMetaComponent
resolveClientId, substituteUnresolvedClientId
getRowKeyConverter
getRowKeyVar, getSelection, getStateVar, getVar, isKeepSaved
addTreeSelectionChangeListener, removeTreeSelectionChangeListener
addTreeToggleListener, removeTreeToggleListener
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public String getFamily()
getFamily
in class AbstractTree
public Collection<String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
getEventNames
in class javax.faces.component.UIComponentBase
public String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class javax.faces.component.UIComponentBase
public Object getData()
AjaxActivatorProps
getData
in interface AjaxActivatorProps
public void setData(Object data)
public String getDir()
I18nProps
public void setDir(String dir)
public Object getExecute()
AjaxProps
getExecute
in interface AjaxProps
public void setExecute(Object execute)
public String getHandleClass()
TreeCommonProps
getHandleClass
in interface TreeCommonProps
public void setHandleClass(String handleClass)
public String getIconClass()
TreeCommonProps
getIconClass
in interface TreeCommonProps
public void setIconClass(String iconClass)
public String getIconCollapsed()
TreeCommonProps
getIconCollapsed
in interface TreeCommonProps
public void setIconCollapsed(String iconCollapsed)
public String getIconExpanded()
TreeCommonProps
getIconExpanded
in interface TreeCommonProps
public void setIconExpanded(String iconExpanded)
public String getIconLeaf()
TreeCommonProps
getIconLeaf
in interface TreeCommonProps
public void setIconLeaf(String iconLeaf)
public boolean isImmediate()
ImmediateProps
isImmediate
in interface ImmediateProps
public void setImmediate(boolean immediate)
public String getLabelClass()
TreeCommonProps
getLabelClass
in interface TreeCommonProps
public void setLabelClass(String labelClass)
public String getLang()
I18nProps
public void setLang(String lang)
public boolean isLimitRender()
AjaxActivatorProps
isLimitRender
in interface AjaxActivatorProps
public void setLimitRender(boolean limitRender)
public String getNodeClass()
TreeProps
getNodeClass
in interface TreeProps
getNodeClass
in class AbstractTree
public void setNodeClass(String nodeClass)
public String getNodeType()
TreeProps
getNodeType
in interface TreeProps
getNodeType
in class AbstractTree
public void setNodeType(String nodeType)
public String getOnbeforedomupdate()
AjaxActivatorProps
getOnbeforedomupdate
in interface AjaxActivatorProps
public void setOnbeforedomupdate(String onbeforedomupdate)
public String getOnbeforenodetoggle()
TreeProps
getOnbeforenodetoggle
in interface TreeProps
getOnbeforenodetoggle
in class AbstractTree
public void setOnbeforenodetoggle(String onbeforenodetoggle)
public String getOnbeforeselectionchange()
TreeProps
getOnbeforeselectionchange
in interface TreeProps
getOnbeforeselectionchange
in class AbstractTree
public void setOnbeforeselectionchange(String onbeforeselectionchange)
public String getOnbegin()
AjaxProps
getOnbegin
in interface AjaxProps
public void setOnbegin(String onbegin)
public String getOnclick()
EventsMouseProps
getOnclick
in interface EventsMouseProps
public void setOnclick(String onclick)
public String getOncomplete()
AjaxActivatorProps
getOncomplete
in interface AjaxActivatorProps
public void setOncomplete(String oncomplete)
public String getOndblclick()
EventsMouseProps
getOndblclick
in interface EventsMouseProps
public void setOndblclick(String ondblclick)
public String getOnkeydown()
EventsKeyProps
getOnkeydown
in interface EventsKeyProps
public void setOnkeydown(String onkeydown)
public String getOnkeypress()
EventsKeyProps
getOnkeypress
in interface EventsKeyProps
public void setOnkeypress(String onkeypress)
public String getOnkeyup()
EventsKeyProps
getOnkeyup
in interface EventsKeyProps
public void setOnkeyup(String onkeyup)
public String getOnmousedown()
EventsMouseProps
getOnmousedown
in interface EventsMouseProps
public void setOnmousedown(String onmousedown)
public String getOnmousemove()
EventsMouseProps
getOnmousemove
in interface EventsMouseProps
public void setOnmousemove(String onmousemove)
public String getOnmouseout()
EventsMouseProps
getOnmouseout
in interface EventsMouseProps
public void setOnmouseout(String onmouseout)
public String getOnmouseover()
EventsMouseProps
getOnmouseover
in interface EventsMouseProps
public void setOnmouseover(String onmouseover)
public String getOnmouseup()
EventsMouseProps
getOnmouseup
in interface EventsMouseProps
public void setOnmouseup(String onmouseup)
public String getOnnodetoggle()
TreeProps
getOnnodetoggle
in interface TreeProps
getOnnodetoggle
in class AbstractTree
public void setOnnodetoggle(String onnodetoggle)
public String getOnselectionchange()
TreeProps
getOnselectionchange
in interface TreeProps
getOnselectionchange
in class AbstractTree
public void setOnselectionchange(String onselectionchange)
public Object getRender()
AjaxActivatorProps
getRender
in interface AjaxActivatorProps
public void setRender(Object render)
public javax.el.MethodExpression getSelectionChangeListener()
TreeProps
getSelectionChangeListener
in interface TreeProps
public void setSelectionChangeListener(javax.el.MethodExpression selectionChangeListener)
public SwitchType getSelectionType()
TreeProps
getSelectionType
in interface TreeProps
getSelectionType
in class AbstractTree
public void setSelectionType(SwitchType selectionType)
public String getStatus()
AjaxProps
public void setStatus(String status)
public String getStyle()
CoreProps
public void setStyle(String style)
public String getStyleClass()
CoreProps
getStyleClass
in interface CoreProps
public void setStyleClass(String styleClass)
public String getTitle()
CoreProps
public void setTitle(String title)
public javax.el.MethodExpression getToggleListener()
TreeCommonProps
getToggleListener
in interface TreeCommonProps
public void setToggleListener(javax.el.MethodExpression toggleListener)
public String getToggleNodeEvent()
TreeProps
getToggleNodeEvent
in interface TreeProps
getToggleNodeEvent
in class AbstractTree
public void setToggleNodeEvent(String toggleNodeEvent)
public SwitchType getToggleType()
TreeProps
getToggleType
in interface TreeProps
getToggleType
in class AbstractTree
public void setToggleType(SwitchType toggleType)
public boolean isUseDefaultNode()
TreeProps
isUseDefaultNode
in interface TreeProps
public void setUseDefaultNode(boolean useDefaultNode)
public Object getValue()
AbstractTree
getValue
in class AbstractTree
public void setValue(Object value)
Copyright © 2016 JBoss by Red Hat. All Rights Reserved.