org.richfaces.component
Class UITreeNode

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

public abstract class UITreeNode
extends javax.faces.component.UIComponentBase
implements TreeListenerEventsProducer, org.ajax4jsf.dnd.Draggable, org.ajax4jsf.dnd.Dropzone

Author:
Nick Belaevski - nbelaevski@exadel.com created 22.11.2006 Component class providing concrete representation for tree node

Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
protected static java.lang.String DEFAULT_NODE_FACE_ATTRIBUTE_NAME
          Attribute name to indicate if this tree node is a virtual UITreeNode providing default representation for node.
 
Constructor Summary
UITreeNode()
           
 
Method Summary
 void addChangeExpandListener(NodeExpandedListener listener)
           
 void addDragListener(org.ajax4jsf.dnd.event.DragListener listener)
           
 void addDropListener(org.ajax4jsf.dnd.event.DropListener listener)
           
 void addNodeSelectListener(NodeSelectedListener listener)
           
 void broadcast(javax.faces.event.FacesEvent event)
           
 java.lang.Object getAcceptedTypes()
           
abstract  java.lang.String getAjaxSubmitSelection()
           
 java.util.Map getAttributes()
           
 NodeExpandedListener[] getChangeExpandListeners()
           
 org.ajax4jsf.dnd.event.DragListener[] getDragListeners()
           
 java.lang.String getDragType()
           
 java.lang.Object getDragValue()
           
 org.ajax4jsf.dnd.event.DropListener[] getDropListeners()
           
 java.lang.Object getDropValue()
           
abstract  java.lang.String getHighlightedClass()
           
abstract  java.lang.String getIcon()
           
abstract  java.lang.String getIconCollapsed()
           
 javax.faces.component.UIComponent getIconCollapsedFacet()
           
abstract  java.lang.String getIconExpanded()
           
 javax.faces.component.UIComponent getIconExpandedFacet()
           
 javax.faces.component.UIComponent getIconFacet()
           
abstract  java.lang.String getIconLeaf()
           
 javax.faces.component.UIComponent getIconLeafFacet()
           
 NodeSelectedListener[] getNodeSelectListeners()
           
abstract  java.lang.String getSelectedClass()
           
abstract  java.lang.String getType()
           
 UITree getUITree()
          Finds direct parent UITree component or throws ClassCastException if parent is not UITree
 boolean hasAjaxSubmitSelection()
           
 void removeChangeExpandListener(NodeExpandedListener listener)
           
 void removeDragListener(org.ajax4jsf.dnd.event.DragListener listener)
           
 void removeDropListener(org.ajax4jsf.dnd.event.DropListener listener)
           
 void removeNodeSelectListener(NodeSelectedListener listener)
           
 void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext context)
           
 void setAcceptedTypes(java.lang.Object types)
           
abstract  void setAjaxSubmitSelection(java.lang.String ajaxSubmitSelection)
           
 void setDragType(java.lang.String dragType)
           
 void setDragValue(java.lang.Object value)
           
 void setDropValue(java.lang.Object o)
           
abstract  void setHighlightedClass(java.lang.String selectedClass)
           
abstract  void setIcon(java.lang.String icon)
           
abstract  void setIconCollapsed(java.lang.String icon)
           
abstract  void setIconExpanded(java.lang.String icon)
           
abstract  void setIconLeaf(java.lang.String icon)
           
abstract  void setSelectedClass(java.lang.String selectedClass)
           
abstract  void setType(java.lang.String type)
           
 
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 javax.faces.component.UIComponent
getFamily
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.richfaces.component.TreeListenerEventsProducer
getChangeExpandListener, getDragListener, getDropListener, getNodeSelectListener, setChangeExpandListener, setDragListener, setDropListener, setNodeSelectListener
 
Methods inherited from interface org.ajax4jsf.dnd.Draggable
getDragIndicator, getDragListener, getOndragend, getOndragstart, setDragIndicator, setDragListener, setOndragend, setOndragstart
 
Methods inherited from interface org.ajax4jsf.dnd.Dropzone
getOndragenter, getOndragexit, getOndrop, getOndropend, getTypeMapping, setOndragenter, setOndragexit, setOndrop, setOndropend, setTypeMapping
 
Methods inherited from interface org.ajax4jsf.dnd.event.DropSource
getDropListener, setDropListener
 

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

DEFAULT_NODE_FACE_ATTRIBUTE_NAME

protected static final java.lang.String DEFAULT_NODE_FACE_ATTRIBUTE_NAME
Attribute name to indicate if this tree node is a virtual UITreeNode providing default representation for node. Default tree node representation should use attributes of its parent UITree component

See Also:
Constant Field Values
Constructor Detail

UITreeNode

public UITreeNode()
Method Detail

getType

public abstract java.lang.String getType()

setType

public abstract void setType(java.lang.String type)

getIcon

public abstract java.lang.String getIcon()

setIcon

public abstract void setIcon(java.lang.String icon)

getIconExpanded

public abstract java.lang.String getIconExpanded()

setIconExpanded

public abstract void setIconExpanded(java.lang.String icon)

getIconCollapsed

public abstract java.lang.String getIconCollapsed()

setIconCollapsed

public abstract void setIconCollapsed(java.lang.String icon)

getIconLeaf

public abstract java.lang.String getIconLeaf()

setIconLeaf

public abstract void setIconLeaf(java.lang.String icon)

setAjaxSubmitSelection

public abstract void setAjaxSubmitSelection(java.lang.String ajaxSubmitSelection)

getAjaxSubmitSelection

public abstract java.lang.String getAjaxSubmitSelection()

setHighlightedClass

public abstract void setHighlightedClass(java.lang.String selectedClass)

getHighlightedClass

public abstract java.lang.String getHighlightedClass()

setSelectedClass

public abstract void setSelectedClass(java.lang.String selectedClass)

getSelectedClass

public abstract java.lang.String getSelectedClass()

hasAjaxSubmitSelection

public boolean hasAjaxSubmitSelection()
Specified by:
hasAjaxSubmitSelection in interface TreeListenerEventsProducer

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException
Overrides:
broadcast in class javax.faces.component.UIComponentBase
Throws:
javax.faces.event.AbortProcessingException

addChangeExpandListener

public void addChangeExpandListener(NodeExpandedListener listener)
Specified by:
addChangeExpandListener in interface TreeListenerEventsProducer

addNodeSelectListener

public void addNodeSelectListener(NodeSelectedListener listener)
Specified by:
addNodeSelectListener in interface TreeListenerEventsProducer

removeChangeExpandListener

public void removeChangeExpandListener(NodeExpandedListener listener)

removeNodeSelectListener

public void removeNodeSelectListener(NodeSelectedListener listener)

getChangeExpandListeners

public NodeExpandedListener[] getChangeExpandListeners()

getNodeSelectListeners

public NodeSelectedListener[] getNodeSelectListeners()

getUITree

public UITree getUITree()
                 throws java.lang.ClassCastException
Finds direct parent UITree component or throws ClassCastException if parent is not UITree

Returns:
UITree instance
Throws:
java.lang.ClassCastException

addDropListener

public void addDropListener(org.ajax4jsf.dnd.event.DropListener listener)
Specified by:
addDropListener in interface org.ajax4jsf.dnd.event.DropSource

getDropListeners

public org.ajax4jsf.dnd.event.DropListener[] getDropListeners()
Specified by:
getDropListeners in interface org.ajax4jsf.dnd.event.DropSource

removeDropListener

public void removeDropListener(org.ajax4jsf.dnd.event.DropListener listener)
Specified by:
removeDropListener in interface org.ajax4jsf.dnd.event.DropSource

addDragListener

public void addDragListener(org.ajax4jsf.dnd.event.DragListener listener)
Specified by:
addDragListener in interface org.ajax4jsf.dnd.Draggable

getDragListeners

public org.ajax4jsf.dnd.event.DragListener[] getDragListeners()
Specified by:
getDragListeners in interface org.ajax4jsf.dnd.Draggable

removeDragListener

public void removeDragListener(org.ajax4jsf.dnd.event.DragListener listener)
Specified by:
removeDragListener in interface org.ajax4jsf.dnd.Draggable

getAttributes

public java.util.Map getAttributes()
Overrides:
getAttributes in class javax.faces.component.UIComponentBase

getDragValue

public java.lang.Object getDragValue()
Specified by:
getDragValue in interface org.ajax4jsf.dnd.Draggable

setDragValue

public void setDragValue(java.lang.Object value)
Specified by:
setDragValue in interface org.ajax4jsf.dnd.Draggable

getDropValue

public java.lang.Object getDropValue()
Specified by:
getDropValue in interface org.ajax4jsf.dnd.Dropzone

setDropValue

public void setDropValue(java.lang.Object o)
Specified by:
setDropValue in interface org.ajax4jsf.dnd.Dropzone

setAcceptedTypes

public void setAcceptedTypes(java.lang.Object types)
Specified by:
setAcceptedTypes in interface org.ajax4jsf.dnd.Dropzone

getAcceptedTypes

public java.lang.Object getAcceptedTypes()
Specified by:
getAcceptedTypes in interface org.ajax4jsf.dnd.Dropzone

setDragType

public void setDragType(java.lang.String dragType)
Specified by:
setDragType in interface org.ajax4jsf.dnd.Draggable

getDragType

public java.lang.String getDragType()
Specified by:
getDragType in interface org.ajax4jsf.dnd.Draggable

getIconFacet

public javax.faces.component.UIComponent getIconFacet()

getIconLeafFacet

public javax.faces.component.UIComponent getIconLeafFacet()

getIconExpandedFacet

public javax.faces.component.UIComponent getIconExpandedFacet()

getIconCollapsedFacet

public javax.faces.component.UIComponent getIconCollapsedFacet()

saveState

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

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 javax.faces.component.UIComponentBase


Copyright © 2007. All Rights Reserved.