org.richfaces.component.html
Class HtmlTreeNode

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by org.richfaces.component.UITreeNode
              extended by org.richfaces.component.html.HtmlTreeNode
All Implemented Interfaces:
javax.faces.component.StateHolder, org.ajax4jsf.dnd.Draggable, org.ajax4jsf.dnd.Dropzone, org.ajax4jsf.dnd.event.DropSource, TreeListenerEventsProducer

public class HtmlTreeNode
extends UITreeNode

Component-Type org.richfaces.TreeNode Component-Family org.richfaces.TreeNode Renderer-Type org.richfaces.TreeNodeRenderer


Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
 
Fields inherited from class org.richfaces.component.UITreeNode
DEFAULT_NODE_FACE_ATTRIBUTE_NAME
 
Constructor Summary
HtmlTreeNode()
          Constructor to init default renderers
 
Method Summary
 java.lang.String getAjaxSubmitSelection()
          An algorithm of AJAX request submission.
 javax.faces.el.MethodBinding getChangeExpandListener()
          Listener called on expand/collapse event on the node.
 java.lang.String getDragIndicator()
          Id of the dragIndicator component used as drag operation cursor.
 javax.faces.el.MethodBinding getDragListener()
          MethodBinding representing an action listener method that will be notified after drag operation.
 javax.faces.el.MethodBinding getDropListener()
          MethodBinding representing an action listener method that will be notified after drop operation.
 java.lang.String getFamily()
           
 java.lang.String getHighlightedClass()
          Corresponds to the HTML class attribute.
 java.lang.String getIcon()
          The icon for node Getter for icon
 java.lang.String getIconCollapsed()
          The icon for collapsed node Getter for iconCollapsed
 java.lang.String getIconExpanded()
          The icon for expanded node Getter for iconExpanded
 java.lang.String getIconLeaf()
          An icon for component leaves.
 java.lang.String getNodeClass()
          Name of node CSS class Getter for nodeClass
 javax.faces.el.MethodBinding getNodeSelectListener()
          MethodBinding representing an action listener method that will be notified after selection of node.
 java.lang.String getOncollapse()
          HTML: script expression to invoke on node collapsion Getter for oncollapse
 java.lang.String getOncontextmenu()
          JavaScript handler to be called on right click.
 java.lang.String getOndragend()
          A JavaScript event handler called after a drag operation.
 java.lang.String getOndragenter()
          A JavaScript event handler called on enter draggable object to zone.
 java.lang.String getOndragexit()
          A JavaScript event handler called after a drag object leaves zone.
 java.lang.String getOndragstart()
          A JavaScript event handler called before drag object.
 java.lang.String getOndrop()
          It's an event that is called when something is dropped on a drop zone Getter for ondrop
 java.lang.String getOndropend()
          A Javascript handler for event fired on a drop even the drop for a given type is not available Getter for ondropend
 java.lang.String getOnexpand()
          HTML: script expression to invoke on node expansion Getter for onexpand
 java.lang.String getOnselected()
          HTML: script expression to invoke on node selection Getter for onselected
 java.lang.Object getReRender()
          Id[s] (in format of call UIComponent.findComponent()) of components, rendered in case of AjaxRequest caused by this component.
 java.lang.String getSelectedClass()
          Corresponds to the HTML class attribute.
 java.lang.String getType()
          A node type.
 java.lang.Object getTypeMapping()
          Map between a draggable type and an indicator name on zone.
 void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext context)
           
 void setAjaxSubmitSelection(java.lang.String __ajaxSubmitSelection)
          An algorithm of AJAX request submission.
 void setChangeExpandListener(javax.faces.el.MethodBinding __changeExpandListener)
          Listener called on expand/collapse event on the node.
 void setDragIndicator(java.lang.String __dragIndicator)
          Id of the dragIndicator component used as drag operation cursor.
 void setDragListener(javax.faces.el.MethodBinding __dragListener)
          MethodBinding representing an action listener method that will be notified after drag operation.
 void setDropListener(javax.faces.el.MethodBinding __dropListener)
          MethodBinding representing an action listener method that will be notified after drop operation.
 void setHighlightedClass(java.lang.String __highlightedClass)
          Corresponds to the HTML class attribute.
 void setIcon(java.lang.String __icon)
          The icon for node Setter for icon
 void setIconCollapsed(java.lang.String __iconCollapsed)
          The icon for collapsed node Setter for iconCollapsed
 void setIconExpanded(java.lang.String __iconExpanded)
          The icon for expanded node Setter for iconExpanded
 void setIconLeaf(java.lang.String __iconLeaf)
          An icon for component leaves.
 void setNodeClass(java.lang.String __nodeClass)
          Name of node CSS class Setter for nodeClass
 void setNodeSelectListener(javax.faces.el.MethodBinding __nodeSelectListener)
          MethodBinding representing an action listener method that will be notified after selection of node.
 void setOncollapse(java.lang.String __oncollapse)
          HTML: script expression to invoke on node collapsion Setter for oncollapse
 void setOncontextmenu(java.lang.String __oncontextmenu)
          JavaScript handler to be called on right click.
 void setOndragend(java.lang.String __ondragend)
          A JavaScript event handler called after a drag operation.
 void setOndragenter(java.lang.String __ondragenter)
          A JavaScript event handler called on enter draggable object to zone.
 void setOndragexit(java.lang.String __ondragexit)
          A JavaScript event handler called after a drag object leaves zone.
 void setOndragstart(java.lang.String __ondragstart)
          A JavaScript event handler called before drag object.
 void setOndrop(java.lang.String __ondrop)
          It's an event that is called when something is dropped on a drop zone Setter for ondrop
 void setOndropend(java.lang.String __ondropend)
          A Javascript handler for event fired on a drop even the drop for a given type is not available Setter for ondropend
 void setOnexpand(java.lang.String __onexpand)
          HTML: script expression to invoke on node expansion Setter for onexpand
 void setOnselected(java.lang.String __onselected)
          HTML: script expression to invoke on node selection Setter for onselected
 void setReRender(java.lang.Object __reRender)
          Id[s] (in format of call UIComponent.findComponent()) of components, rendered in case of AjaxRequest caused by this component.
 void setSelectedClass(java.lang.String __selectedClass)
          Corresponds to the HTML class attribute.
 void setType(java.lang.String __type)
          A node type.
 void setTypeMapping(java.lang.Object __typeMapping)
          Map between a draggable type and an indicator name on zone.
 
Methods inherited from class org.richfaces.component.UITreeNode
addChangeExpandListener, addDragListener, addDropListener, addNodeSelectListener, broadcast, getAcceptedTypes, getAttributes, getChangeExpandListeners, getDragListeners, getDragType, getDragValue, getDropListeners, getDropValue, getIconCollapsedFacet, getIconExpandedFacet, getIconFacet, getIconLeafFacet, getNodeSelectListeners, getUITree, hasAjaxSubmitSelection, removeChangeExpandListener, removeDragListener, removeDropListener, removeNodeSelectListener, setAcceptedTypes, setDragType, setDragValue, setDropValue
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY
See Also:
Constant Field Values
Constructor Detail

HtmlTreeNode

public HtmlTreeNode()
Constructor to init default renderers

Method Detail

setChangeExpandListener

public void setChangeExpandListener(javax.faces.el.MethodBinding __changeExpandListener)
Listener called on expand/collapse event on the node. Setter for changeExpandListener

Parameters:
changeExpandListener - - new value

getChangeExpandListener

public javax.faces.el.MethodBinding getChangeExpandListener()
Listener called on expand/collapse event on the node. Getter for changeExpandListener

Returns:
changeExpandListener value from local variable or value bindings

setReRender

public void setReRender(java.lang.Object __reRender)
Id[s] (in format of call UIComponent.findComponent()) of components, rendered in case of AjaxRequest caused by this component. Can be single id, comma-separated list of Ids, or EL Expression with array or Collection Setter for reRender

Parameters:
reRender - - new value

getReRender

public java.lang.Object getReRender()
Id[s] (in format of call UIComponent.findComponent()) of components, rendered in case of AjaxRequest caused by this component. Can be single id, comma-separated list of Ids, or EL Expression with array or Collection Getter for reRender

Returns:
reRender value from local variable or value bindings

setDragListener

public void setDragListener(javax.faces.el.MethodBinding __dragListener)
MethodBinding representing an action listener method that will be notified after drag operation. Setter for dragListener

Parameters:
dragListener - - new value

getDragListener

public javax.faces.el.MethodBinding getDragListener()
MethodBinding representing an action listener method that will be notified after drag operation. Getter for dragListener

Returns:
dragListener value from local variable or value bindings

setIconCollapsed

public void setIconCollapsed(java.lang.String __iconCollapsed)
The icon for collapsed node Setter for iconCollapsed

Specified by:
setIconCollapsed in class UITreeNode
Parameters:
iconCollapsed - - new value

getIconCollapsed

public java.lang.String getIconCollapsed()
The icon for collapsed node Getter for iconCollapsed

Specified by:
getIconCollapsed in class UITreeNode
Returns:
iconCollapsed value from local variable or value bindings

setDropListener

public void setDropListener(javax.faces.el.MethodBinding __dropListener)
MethodBinding representing an action listener method that will be notified after drop operation. Setter for dropListener

Parameters:
dropListener - - new value

getDropListener

public javax.faces.el.MethodBinding getDropListener()
MethodBinding representing an action listener method that will be notified after drop operation. Getter for dropListener

Returns:
dropListener value from local variable or value bindings

setType

public void setType(java.lang.String __type)
A node type. Setter for type

Specified by:
setType in class UITreeNode
Parameters:
type - - new value

getType

public java.lang.String getType()
A node type. Getter for type

Specified by:
getType in class UITreeNode
Returns:
type value from local variable or value bindings

setAjaxSubmitSelection

public void setAjaxSubmitSelection(java.lang.String __ajaxSubmitSelection)
An algorithm of AJAX request submission. "inherit", "true", "false" values are possible Setter for ajaxSubmitSelection

Specified by:
setAjaxSubmitSelection in class UITreeNode
Parameters:
ajaxSubmitSelection - - new value

getAjaxSubmitSelection

public java.lang.String getAjaxSubmitSelection()
An algorithm of AJAX request submission. "inherit", "true", "false" values are possible Getter for ajaxSubmitSelection

Specified by:
getAjaxSubmitSelection in class UITreeNode
Returns:
ajaxSubmitSelection value from local variable or value bindings

setNodeSelectListener

public void setNodeSelectListener(javax.faces.el.MethodBinding __nodeSelectListener)
MethodBinding representing an action listener method that will be notified after selection of node. Setter for nodeSelectListener

Parameters:
nodeSelectListener - - new value

getNodeSelectListener

public javax.faces.el.MethodBinding getNodeSelectListener()
MethodBinding representing an action listener method that will be notified after selection of node. Getter for nodeSelectListener

Returns:
nodeSelectListener value from local variable or value bindings

setIconLeaf

public void setIconLeaf(java.lang.String __iconLeaf)
An icon for component leaves. Setter for iconLeaf

Specified by:
setIconLeaf in class UITreeNode
Parameters:
iconLeaf - - new value

getIconLeaf

public java.lang.String getIconLeaf()
An icon for component leaves. Getter for iconLeaf

Specified by:
getIconLeaf in class UITreeNode
Returns:
iconLeaf value from local variable or value bindings

setIcon

public void setIcon(java.lang.String __icon)
The icon for node Setter for icon

Specified by:
setIcon in class UITreeNode
Parameters:
icon - - new value

getIcon

public java.lang.String getIcon()
The icon for node Getter for icon

Specified by:
getIcon in class UITreeNode
Returns:
icon value from local variable or value bindings

setOncollapse

public void setOncollapse(java.lang.String __oncollapse)
HTML: script expression to invoke on node collapsion Setter for oncollapse

Parameters:
oncollapse - - new value

getOncollapse

public java.lang.String getOncollapse()
HTML: script expression to invoke on node collapsion Getter for oncollapse

Returns:
oncollapse value from local variable or value bindings

setOncontextmenu

public void setOncontextmenu(java.lang.String __oncontextmenu)
JavaScript handler to be called on right click. Returning false prevents default browser context menu from being displayed Setter for oncontextmenu

Parameters:
oncontextmenu - - new value

getOncontextmenu

public java.lang.String getOncontextmenu()
JavaScript handler to be called on right click. Returning false prevents default browser context menu from being displayed Getter for oncontextmenu

Returns:
oncontextmenu value from local variable or value bindings

setOnexpand

public void setOnexpand(java.lang.String __onexpand)
HTML: script expression to invoke on node expansion Setter for onexpand

Parameters:
onexpand - - new value

getOnexpand

public java.lang.String getOnexpand()
HTML: script expression to invoke on node expansion Getter for onexpand

Returns:
onexpand value from local variable or value bindings

setIconExpanded

public void setIconExpanded(java.lang.String __iconExpanded)
The icon for expanded node Setter for iconExpanded

Specified by:
setIconExpanded in class UITreeNode
Parameters:
iconExpanded - - new value

getIconExpanded

public java.lang.String getIconExpanded()
The icon for expanded node Getter for iconExpanded

Specified by:
getIconExpanded in class UITreeNode
Returns:
iconExpanded value from local variable or value bindings

setHighlightedClass

public void setHighlightedClass(java.lang.String __highlightedClass)
Corresponds to the HTML class attribute. Applied to highlighted node Setter for highlightedClass

Specified by:
setHighlightedClass in class UITreeNode
Parameters:
highlightedClass - - new value

getHighlightedClass

public java.lang.String getHighlightedClass()
Corresponds to the HTML class attribute. Applied to highlighted node Getter for highlightedClass

Specified by:
getHighlightedClass in class UITreeNode
Returns:
highlightedClass value from local variable or value bindings

setOnselected

public void setOnselected(java.lang.String __onselected)
HTML: script expression to invoke on node selection Setter for onselected

Parameters:
onselected - - new value

getOnselected

public java.lang.String getOnselected()
HTML: script expression to invoke on node selection Getter for onselected

Returns:
onselected value from local variable or value bindings

setOndragend

public void setOndragend(java.lang.String __ondragend)
A JavaScript event handler called after a drag operation. Setter for ondragend

Parameters:
ondragend - - new value

getOndragend

public java.lang.String getOndragend()
A JavaScript event handler called after a drag operation. Getter for ondragend

Returns:
ondragend value from local variable or value bindings

setSelectedClass

public void setSelectedClass(java.lang.String __selectedClass)
Corresponds to the HTML class attribute. Applied to selected node Setter for selectedClass

Specified by:
setSelectedClass in class UITreeNode
Parameters:
selectedClass - - new value

getSelectedClass

public java.lang.String getSelectedClass()
Corresponds to the HTML class attribute. Applied to selected node Getter for selectedClass

Specified by:
getSelectedClass in class UITreeNode
Returns:
selectedClass value from local variable or value bindings

setTypeMapping

public void setTypeMapping(java.lang.Object __typeMapping)
Map between a draggable type and an indicator name on zone. it's defined with the pair (drag type:indicator name)) Setter for typeMapping

Parameters:
typeMapping - - new value

getTypeMapping

public java.lang.Object getTypeMapping()
Map between a draggable type and an indicator name on zone. it's defined with the pair (drag type:indicator name)) Getter for typeMapping

Returns:
typeMapping value from local variable or value bindings

setOndrop

public void setOndrop(java.lang.String __ondrop)
It's an event that is called when something is dropped on a drop zone Setter for ondrop

Parameters:
ondrop - - new value

getOndrop

public java.lang.String getOndrop()
It's an event that is called when something is dropped on a drop zone Getter for ondrop

Returns:
ondrop value from local variable or value bindings

setOndragstart

public void setOndragstart(java.lang.String __ondragstart)
A JavaScript event handler called before drag object. Setter for ondragstart

Parameters:
ondragstart - - new value

getOndragstart

public java.lang.String getOndragstart()
A JavaScript event handler called before drag object. Getter for ondragstart

Returns:
ondragstart value from local variable or value bindings

setOndragexit

public void setOndragexit(java.lang.String __ondragexit)
A JavaScript event handler called after a drag object leaves zone. Setter for ondragexit

Parameters:
ondragexit - - new value

getOndragexit

public java.lang.String getOndragexit()
A JavaScript event handler called after a drag object leaves zone. Getter for ondragexit

Returns:
ondragexit value from local variable or value bindings

setOndragenter

public void setOndragenter(java.lang.String __ondragenter)
A JavaScript event handler called on enter draggable object to zone. Setter for ondragenter

Parameters:
ondragenter - - new value

getOndragenter

public java.lang.String getOndragenter()
A JavaScript event handler called on enter draggable object to zone. Getter for ondragenter

Returns:
ondragenter value from local variable or value bindings

setNodeClass

public void setNodeClass(java.lang.String __nodeClass)
Name of node CSS class Setter for nodeClass

Parameters:
nodeClass - - new value

getNodeClass

public java.lang.String getNodeClass()
Name of node CSS class Getter for nodeClass

Returns:
nodeClass value from local variable or value bindings

setDragIndicator

public void setDragIndicator(java.lang.String __dragIndicator)
Id of the dragIndicator component used as drag operation cursor. Setter for dragIndicator

Parameters:
dragIndicator - - new value

getDragIndicator

public java.lang.String getDragIndicator()
Id of the dragIndicator component used as drag operation cursor. Getter for dragIndicator

Returns:
dragIndicator value from local variable or value bindings

setOndropend

public void setOndropend(java.lang.String __ondropend)
A Javascript handler for event fired on a drop even the drop for a given type is not available Setter for ondropend

Parameters:
ondropend - - new value

getOndropend

public java.lang.String getOndropend()
A Javascript handler for event fired on a drop even the drop for a given type is not available Getter for ondropend

Returns:
ondropend value from local variable or value bindings

getFamily

public java.lang.String getFamily()
Specified by:
getFamily in class javax.faces.component.UIComponent

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class UITreeNode

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class UITreeNode


Copyright © 2007. All Rights Reserved.