org.richfaces.component

Class UITreeNode

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, IterationStateHolder, CoreProps, EventsKeyProps, EventsMouseProps, I18nProps, ImmediateProps, TreeCommonProps, MetaComponentEncoder, MetaComponentResolver, TreeToggleSource

@Generated(value={"RichFaces CDK","4.5.0-SNAPSHOT"})
public class UITreeNode
extends AbstractTreeNode
implements javax.faces.component.behavior.ClientBehaviorHolder, IterationStateHolder, MetaComponentEncoder, MetaComponentResolver, CoreProps, EventsKeyProps, EventsMouseProps, I18nProps, ImmediateProps, 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

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

Constructor Summary

Constructors

Constructor and Description
UITreeNode()

Method Summary

Methods

Modifier and Type	Method and Description
String	getDefaultEventName()
String	getDir() Direction indication for text that does not inherit directionality.
Collection<String>	getEventNames()
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	getOnbeforetoggle() The client-side script method to be called before the node is toggle.
String	getOnclick() Javascript code executed when a pointer button is clicked over this element.
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	getOntoggle() The client-side script method to be called after the node is toggle.
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	getType() The type of the this component.
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.
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	setToggleListener(javax.el.MethodExpression toggleListener)
void	setType(String type)

Methods inherited from class org.richfaces.component.AbstractTreeNode

addTreeToggleListener, broadcast, encodeMetaComponent, findTreeComponent, getData, getIterationState, getLocalExpandedValue, getOnbeforedomupdate, getOncomplete, getRender, getTreeToggleListeners, isExpanded, isLimitRender, queueEvent, removeTreeToggleListener, resolveClientId, setExpanded, setIterationState, setRender, substituteUnresolvedClientId, visitTree

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class javax.faces.component.UIComponent

getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent

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()

Description copied from interface: I18nProps

Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left).

Specified by:

getDir in interface I18nProps

setDir

public void setDir(String dir)

getHandleClass

public String getHandleClass()

Description copied from interface: TreeCommonProps

Space-separated list of CSS style class(es) to be applied to the tree node handles.

Specified by:

getHandleClass in interface TreeCommonProps

setHandleClass

public void setHandleClass(String handleClass)

getIconClass

public String getIconClass()

Description copied from interface: TreeCommonProps

Space-separated list of CSS style class(es) to be applied to the tree node icons.

Specified by:

getIconClass in interface TreeCommonProps

setIconClass

public void setIconClass(String iconClass)

getIconCollapsed

public String getIconCollapsed()

Description copied from interface: TreeCommonProps

The icon for collapsed node

Specified by:

getIconCollapsed in interface TreeCommonProps

setIconCollapsed

public void setIconCollapsed(String iconCollapsed)

getIconExpanded

public String getIconExpanded()

Description copied from interface: TreeCommonProps

The icon for expanded node

Specified by:

getIconExpanded in interface TreeCommonProps

setIconExpanded

public void setIconExpanded(String iconExpanded)

getIconLeaf

public String getIconLeaf()

Description copied from interface: TreeCommonProps

The icon for component leaves

Specified by:

getIconLeaf in interface TreeCommonProps

setIconLeaf

public void setIconLeaf(String iconLeaf)

isImmediate

public boolean isImmediate()

Description copied from interface: ImmediateProps

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.

Specified by:

isImmediate in interface ImmediateProps

setImmediate

public void setImmediate(boolean immediate)

getLabelClass

public String getLabelClass()

Description copied from interface: TreeCommonProps

Space-separated list of CSS style class(es) to be applied to the tree node labels.

Specified by:

getLabelClass in interface TreeCommonProps

setLabelClass

public void setLabelClass(String labelClass)

getLang

public String getLang()

Description copied from interface: I18nProps

Code describing the language used in the generated markup for this component.

Specified by:

getLang in interface 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()

Description copied from interface: EventsMouseProps

Javascript code executed when a pointer button is clicked over this element.

Specified by:

getOnclick in interface EventsMouseProps

setOnclick

public void setOnclick(String onclick)

getOndblclick

public String getOndblclick()

Description copied from interface: EventsMouseProps

Javascript code executed when a pointer button is double clicked over this element.

Specified by:

getOndblclick in interface EventsMouseProps

setOndblclick

public void setOndblclick(String ondblclick)

getOnkeydown

public String getOnkeydown()

Description copied from interface: EventsKeyProps

Javascript code executed when a key is pressed down over this element.

Specified by:

getOnkeydown in interface EventsKeyProps

setOnkeydown

public void setOnkeydown(String onkeydown)

getOnkeypress

public String getOnkeypress()

Description copied from interface: EventsKeyProps

Javascript code executed when a key is pressed and released over this element.

Specified by:

getOnkeypress in interface EventsKeyProps

setOnkeypress

public void setOnkeypress(String onkeypress)

getOnkeyup

public String getOnkeyup()

Description copied from interface: EventsKeyProps

Javascript code executed when a key is released over this element.

Specified by:

getOnkeyup in interface EventsKeyProps

setOnkeyup

public void setOnkeyup(String onkeyup)

getOnmousedown

public String getOnmousedown()

Description copied from interface: EventsMouseProps

Javascript code executed when a pointer button is pressed down over this element.

Specified by:

getOnmousedown in interface EventsMouseProps

setOnmousedown

public void setOnmousedown(String onmousedown)

getOnmousemove

public String getOnmousemove()

Description copied from interface: EventsMouseProps

Javascript code executed when a pointer button is moved within this element.

Specified by:

getOnmousemove in interface EventsMouseProps

setOnmousemove

public void setOnmousemove(String onmousemove)

getOnmouseout

public String getOnmouseout()

Description copied from interface: EventsMouseProps

Javascript code executed when a pointer button is moved away from this element.

Specified by:

getOnmouseout in interface EventsMouseProps

setOnmouseout

public void setOnmouseout(String onmouseout)

getOnmouseover

public String getOnmouseover()

Description copied from interface: EventsMouseProps

Javascript code executed when a pointer button is moved onto this element.

Specified by:

getOnmouseover in interface EventsMouseProps

setOnmouseover

public void setOnmouseover(String onmouseover)

getOnmouseup

public String getOnmouseup()

Description copied from interface: EventsMouseProps

Javascript code executed when a pointer button is released over this element.

Specified by:

getOnmouseup in interface 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()

Description copied from interface: CoreProps

CSS style(s) to be applied when this component is rendered.

Specified by:

getStyle in interface CoreProps

setStyle

public void setStyle(String style)

getStyleClass

public String getStyleClass()

Description copied from interface: CoreProps

Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.

Specified by:

getStyleClass in interface CoreProps

setStyleClass

public void setStyleClass(String styleClass)

getTitle

public String getTitle()

Description copied from interface: CoreProps

Advisory title information about markup elements generated for this component.

Specified by:

getTitle in interface CoreProps

setTitle

public void setTitle(String title)

getToggleListener

public javax.el.MethodExpression getToggleListener()

Description copied from interface: TreeCommonProps

MethodExpression representing an tree node toggle listener method that will be notified when the tree node is toggled. The expression must evaluate to a public method that takes an TreeToggleEvent parameter, with a return type of void, or to a public method that takes no arguments with a return type of void. In the latter case, the method has no way of easily knowing where the event came from, but this can be useful in cases where a notification is needed that "some action happened".

Specified by:

getToggleListener in interface TreeCommonProps

setToggleListener

public void setToggleListener(javax.el.MethodExpression toggleListener)

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)