UITreeNode (RichFaces rich components 4.5.2.Final-redhat-1 API)

java.lang.Object
- javax.faces.component.UIComponent
- - javax.faces.component.UIComponentBase
  - - org.richfaces.component.AbstractTreeNode
    - - org.richfaces.component.UITreeNode

All Implemented Interfaces:

EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, org.ajax4jsf.component.IterationStateHolder, org.richfaces.component.attribute.CoreProps, org.richfaces.component.attribute.EventsKeyProps, org.richfaces.component.attribute.EventsMouseProps, org.richfaces.component.attribute.I18nProps, org.richfaces.component.attribute.ImmediateProps, org.richfaces.component.attribute.TreeCommonProps, org.richfaces.component.MetaComponentEncoder, org.richfaces.component.MetaComponentResolver, TreeToggleSource
```
@Generated(value={"RichFaces CDK","4.3.1.Final-redhat-1"})
public class UITreeNode
extends AbstractTreeNode
implements javax.faces.component.behavior.ClientBehaviorHolder, org.ajax4jsf.component.IterationStateHolder, org.richfaces.component.MetaComponentEncoder, org.richfaces.component.MetaComponentResolver, org.richfaces.component.attribute.CoreProps, org.richfaces.component.attribute.EventsKeyProps, org.richfaces.component.attribute.EventsMouseProps, org.richfaces.component.attribute.I18nProps, org.richfaces.component.attribute.ImmediateProps, org.richfaces.component.attribute.TreeCommonProps, TreeToggleSource
```
The component is a child component of the component. It represents nodes in the parent tree. The appearance and functionality of each tree node can be customized.

Author:

Nick Belaevski

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class UITreeNode.Properties

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`UITreeNode.Properties`

Field Summary

Fields
Modifier and Type Field and Description

static String COMPONENT_FAMILY

static String COMPONENT_TYPE
- Fields inherited from class org.richfaces.component.AbstractTreeNode
  SUBTREE_META_COMPONENT_ID
- Fields inherited from class javax.faces.component.UIComponent
  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
- Fields inherited from interface org.richfaces.component.MetaComponentResolver
  META_COMPONENT_SEPARATOR_CHAR

Fields
Modifier and Type	Field and Description
`static String`	`COMPONENT_FAMILY`
`static String`	`COMPONENT_TYPE`

Constructor Summary

Constructors
Constructor and Description

UITreeNode()

Constructors
Constructor and Description
`UITreeNode()`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getDefaultEventName()`
`String`	`getDir()`
`Collection<String>`	`getEventNames()`
`String`	`getFamily()`
`String`	`getHandleClass()`
`String`	`getIconClass()`
`String`	`getIconCollapsed()`
`String`	`getIconExpanded()`
`String`	`getIconLeaf()`
`String`	`getLabelClass()`
`String`	`getLang()`
`String`	`getOnbeforetoggle()` The client-side script method to be called before the node is toggle.
`String`	`getOnclick()`
`String`	`getOndblclick()`
`String`	`getOnkeydown()`
`String`	`getOnkeypress()`
`String`	`getOnkeyup()`
`String`	`getOnmousedown()`
`String`	`getOnmousemove()`
`String`	`getOnmouseout()`
`String`	`getOnmouseover()`
`String`	`getOnmouseup()`
`String`	`getOntoggle()` The client-side script method to be called after the node is toggle.
`String`	`getStyle()`
`String`	`getStyleClass()`
`String`	`getTitle()`
`String`	`getType()` The type of the this component.
`boolean`	`isImmediate()`
`void`	`setDir(String dir)`
`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`	`setOnbeforetoggle(String onbeforetoggle)`
`void`	`setOnclick(String onclick)`
`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`	`setOntoggle(String ontoggle)`
`void`	`setStyle(String style)`
`void`	`setStyleClass(String styleClass)`
`void`	`setTitle(String title)`
`void`	`setType(String type)`

Methods inherited from class org.richfaces.component.AbstractTreeNode
addTreeToggleListener, broadcast, encodeMetaComponent, findTreeComponent, getIterationState, getLocalExpandedValue, getTreeToggleListeners, isExpanded, queueEvent, removeTreeToggleListener, resolveClientId, setExpanded, setIterationState, substituteUnresolvedClientId, visitTree

Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors

Methods inherited from interface org.ajax4jsf.component.IterationStateHolder
getIterationState, setIterationState

Methods inherited from interface org.richfaces.component.MetaComponentEncoder
encodeMetaComponent

Methods inherited from interface org.richfaces.component.MetaComponentResolver
resolveClientId, substituteUnresolvedClientId

Methods inherited from interface org.richfaces.event.TreeToggleSource
addTreeToggleListener, removeTreeToggleListener

- Field Detail
  - COMPONENT_TYPE
```
public static final String COMPONENT_TYPE
```
    See Also:
    Constant Field Values
  - COMPONENT_FAMILY
```
public static final String COMPONENT_FAMILY
```
    See Also:
    Constant Field Values
- Constructor Detail
  - UITreeNode
```
public UITreeNode()
```
- Method Detail
  - getFamily
```
public String getFamily()
```
    Overrides:
    
    getFamily in class AbstractTreeNode
  - getEventNames
```
public Collection<String> getEventNames()
```
    Specified by:
    
    getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder
    
    Overrides:
    
    getEventNames in class javax.faces.component.UIComponentBase
  - getDefaultEventName
```
public String getDefaultEventName()
```
    Specified by:
    
    getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder
    
    Overrides:
    
    getDefaultEventName in class javax.faces.component.UIComponentBase
  - getDir
```
public String getDir()
```
    Specified by:
    
    getDir in interface org.richfaces.component.attribute.I18nProps
  - setDir
```
public void setDir(String dir)
```
  - getHandleClass
```
public String getHandleClass()
```
    Specified by:
    
    getHandleClass in interface org.richfaces.component.attribute.TreeCommonProps
  - setHandleClass
```
public void setHandleClass(String handleClass)
```
  - getIconClass
```
public String getIconClass()
```
    Specified by:
    
    getIconClass in interface org.richfaces.component.attribute.TreeCommonProps
  - setIconClass
```
public void setIconClass(String iconClass)
```
  - getIconCollapsed
```
public String getIconCollapsed()
```
    Specified by:
    
    getIconCollapsed in interface org.richfaces.component.attribute.TreeCommonProps
  - setIconCollapsed
```
public void setIconCollapsed(String iconCollapsed)
```
  - getIconExpanded
```
public String getIconExpanded()
```
    Specified by:
    
    getIconExpanded in interface org.richfaces.component.attribute.TreeCommonProps
  - setIconExpanded
```
public void setIconExpanded(String iconExpanded)
```
  - getIconLeaf
```
public String getIconLeaf()
```
    Specified by:
    
    getIconLeaf in interface org.richfaces.component.attribute.TreeCommonProps
  - setIconLeaf
```
public void setIconLeaf(String iconLeaf)
```
  - isImmediate
```
public boolean isImmediate()
```
    Specified by:
    
    isImmediate in interface org.richfaces.component.attribute.ImmediateProps
  - setImmediate
```
public void setImmediate(boolean immediate)
```
  - getLabelClass
```
public String getLabelClass()
```
    Specified by:
    
    getLabelClass in interface org.richfaces.component.attribute.TreeCommonProps
  - setLabelClass
```
public void setLabelClass(String labelClass)
```
  - getLang
```
public String getLang()
```
    Specified by:
    
    getLang in interface org.richfaces.component.attribute.I18nProps
  - setLang
```
public void setLang(String lang)
```
  - getOnbeforetoggle
```
public String getOnbeforetoggle()
```
    Description copied from class: AbstractTreeNode
    
    The client-side script method to be called before the node is toggle.
    
    Specified by:
    
    getOnbeforetoggle in class AbstractTreeNode
  - setOnbeforetoggle
```
public void setOnbeforetoggle(String onbeforetoggle)
```
  - getOnclick
```
public String getOnclick()
```
    Specified by:
    
    getOnclick in interface org.richfaces.component.attribute.EventsMouseProps
  - setOnclick
```
public void setOnclick(String onclick)
```
  - getOndblclick
```
public String getOndblclick()
```
    Specified by:
    
    getOndblclick in interface org.richfaces.component.attribute.EventsMouseProps
  - setOndblclick
```
public void setOndblclick(String ondblclick)
```
  - getOnkeydown
```
public String getOnkeydown()
```
    Specified by:
    
    getOnkeydown in interface org.richfaces.component.attribute.EventsKeyProps
  - setOnkeydown
```
public void setOnkeydown(String onkeydown)
```
  - getOnkeypress
```
public String getOnkeypress()
```
    Specified by:
    
    getOnkeypress in interface org.richfaces.component.attribute.EventsKeyProps
  - setOnkeypress
```
public void setOnkeypress(String onkeypress)
```
  - getOnkeyup
```
public String getOnkeyup()
```
    Specified by:
    
    getOnkeyup in interface org.richfaces.component.attribute.EventsKeyProps
  - setOnkeyup
```
public void setOnkeyup(String onkeyup)
```
  - getOnmousedown
```
public String getOnmousedown()
```
    Specified by:
    
    getOnmousedown in interface org.richfaces.component.attribute.EventsMouseProps
  - setOnmousedown
```
public void setOnmousedown(String onmousedown)
```
  - getOnmousemove
```
public String getOnmousemove()
```
    Specified by:
    
    getOnmousemove in interface org.richfaces.component.attribute.EventsMouseProps
  - setOnmousemove
```
public void setOnmousemove(String onmousemove)
```
  - getOnmouseout
```
public String getOnmouseout()
```
    Specified by:
    
    getOnmouseout in interface org.richfaces.component.attribute.EventsMouseProps
  - setOnmouseout
```
public void setOnmouseout(String onmouseout)
```
  - getOnmouseover
```
public String getOnmouseover()
```
    Specified by:
    
    getOnmouseover in interface org.richfaces.component.attribute.EventsMouseProps
  - setOnmouseover
```
public void setOnmouseover(String onmouseover)
```
  - getOnmouseup
```
public String getOnmouseup()
```
    Specified by:
    
    getOnmouseup in interface org.richfaces.component.attribute.EventsMouseProps
  - setOnmouseup
```
public void setOnmouseup(String onmouseup)
```
  - getOntoggle
```
public String getOntoggle()
```
    Description copied from class: AbstractTreeNode
    
    The client-side script method to be called after the node is toggle.
    
    Specified by:
    
    getOntoggle in class AbstractTreeNode
  - setOntoggle
```
public void setOntoggle(String ontoggle)
```
  - getStyle
```
public String getStyle()
```
    Specified by:
    
    getStyle in interface org.richfaces.component.attribute.CoreProps
  - setStyle
```
public void setStyle(String style)
```
  - getStyleClass
```
public String getStyleClass()
```
    Specified by:
    
    getStyleClass in interface org.richfaces.component.attribute.CoreProps
  - setStyleClass
```
public void setStyleClass(String styleClass)
```
  - getTitle
```
public String getTitle()
```
    Specified by:
    
    getTitle in interface org.richfaces.component.attribute.CoreProps
  - setTitle
```
public void setTitle(String title)
```
  - getType
```
public String getType()
```
    Description copied from class: AbstractTreeNode
    
    The type of the this component. More treeNodes could be defined in tree with different types and it is decided about which is used for rendering by nodeType expression of tree component.
    
    Specified by:
    
    getType in class AbstractTreeNode
  - setType
```
public void setType(String type)
```

Class UITreeNode

Nested Class Summary

Field Summary

Fields inherited from class org.richfaces.component.AbstractTreeNode

Fields inherited from class javax.faces.component.UIComponent

Fields inherited from interface org.richfaces.component.MetaComponentResolver

Constructor Summary

Method Summary

Methods inherited from class org.richfaces.component.AbstractTreeNode

Methods inherited from class javax.faces.component.UIComponentBase

Methods inherited from class javax.faces.component.UIComponent

Methods inherited from class java.lang.Object

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

Methods inherited from interface org.ajax4jsf.component.IterationStateHolder

Methods inherited from interface org.richfaces.component.MetaComponentEncoder

Methods inherited from interface org.richfaces.component.MetaComponentResolver

Methods inherited from interface org.richfaces.event.TreeToggleSource

Field Detail

COMPONENT_TYPE

COMPONENT_FAMILY

Constructor Detail

UITreeNode

Method Detail

getFamily

getEventNames

getDefaultEventName

getDir

setDir

getHandleClass

setHandleClass

getIconClass

setIconClass

getIconCollapsed

setIconCollapsed

getIconExpanded

setIconExpanded

getIconLeaf

setIconLeaf

isImmediate

setImmediate

getLabelClass

setLabelClass

getLang

setLang

getOnbeforetoggle

setOnbeforetoggle

getOnclick

setOnclick

getOndblclick

setOndblclick

getOnkeydown

setOnkeydown

getOnkeypress

setOnkeypress

getOnkeyup

setOnkeyup

getOnmousedown

setOnmousedown

getOnmousemove

setOnmousemove

getOnmouseout

setOnmouseout

getOnmouseover

setOnmouseover

getOnmouseup

setOnmouseup

getOntoggle

setOntoggle

getStyle

setStyle

getStyleClass

setStyleClass

getTitle

setTitle

getType

setType