|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.faces.component.UIComponent javax.faces.component.UIComponentBase org.richfaces.component.UITreeNode
public abstract class UITreeNode
Nested Class Summary | |
---|---|
protected static class |
UITreeNode.DnDEventWrapper
Helper inner class used to wrap drag and drop events to suspend them to ensure that events will processed last. |
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. |
Fields inherited from class javax.faces.component.UIComponent |
---|
bindings |
Fields inherited from interface org.ajax4jsf.component.AjaxComponent |
---|
AJAX_COMPONETT_PARAMETER |
Constructor Summary | |
---|---|
UITreeNode()
|
Method Summary | |
---|---|
void |
addChangeExpandListener(org.richfaces.event.NodeExpandedListener listener)
|
void |
addDragListener(org.richfaces.event.DragListener listener)
|
void |
addDropListener(org.richfaces.event.DropListener listener)
|
void |
addNodeSelectListener(org.richfaces.event.NodeSelectedListener listener)
|
void |
broadcast(javax.faces.event.FacesEvent event)
|
java.lang.Object |
getAcceptedTypes()
|
abstract java.lang.String |
getAjaxSubmitSelection()
|
org.richfaces.event.NodeExpandedListener[] |
getChangeExpandListeners()
|
java.lang.Object |
getData()
Serialized (on default with JSON) data passed on the client by a developer on AJAX request. |
protected java.lang.String |
getDefaultOndragend()
|
protected java.lang.String |
getDefaultOndragenter()
|
protected java.lang.String |
getDefaultOndragexit()
|
protected java.lang.String |
getDefaultOndragstart()
|
protected java.lang.String |
getDefaultOndrop()
|
protected java.lang.String |
getDefaultOndropend()
|
protected java.lang.Object |
getDefaultReRender()
|
protected int |
getDefaultTimeout()
|
java.lang.String |
getDragIndicator()
|
org.richfaces.event.DragListener[] |
getDragListeners()
|
java.lang.String |
getDragType()
|
org.richfaces.event.DropListener[] |
getDropListeners()
|
java.lang.String |
getEventsQueue()
Name of requests queue to avoid send next request before complete other from same event. |
java.lang.String |
getFocus()
id of element to set focus after request completed on client side Getter for focus |
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()
|
protected java.lang.String |
getLocalDragIndicator()
|
org.richfaces.event.NodeSelectedListener[] |
getNodeSelectListeners()
|
java.lang.String |
getOncomplete()
JavaScript code for call after request completed on client side Getter for oncomplete |
java.lang.Object |
getProcess()
|
int |
getRequestDelay()
Attribute defines the time (in ms.) that the request will be wait in the queue before it is ready to send. |
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 |
getResolvedDragIndicator(javax.faces.context.FacesContext facesContext)
|
abstract java.lang.String |
getSelectedClass()
|
java.lang.String |
getSimilarityGroupingId()
|
java.lang.String |
getStatus()
ID (in format of call UIComponent.findComponent()) of Request status component Getter for status |
int |
getTimeout()
Response waiting time on a particular request. |
abstract java.lang.String |
getType()
|
UITree |
getUITree()
Finds direct parent UITree component or throws |
boolean |
hasAjaxSubmitSelection()
|
boolean |
isAjaxSingle()
if "true", submits ONLY one field/link, instead of all form controls Getter for ajaxSingle |
boolean |
isBypassUpdates()
If "true", after process validations phase it skips updates of model beans on a force render response. |
boolean |
isIgnoreDupResponses()
Attribute allows to ignore an Ajax Response produced by a request if the newest 'similar' request is in a queue already. |
boolean |
isLimitToList()
If "true", updates on client side ONLY elements from this 'reRender' property. |
void |
queueEvent(javax.faces.event.FacesEvent event)
Queue an event for broadcast at the end of the current request processing lifecycle phase. |
void |
removeChangeExpandListener(org.richfaces.event.NodeExpandedListener listener)
|
void |
removeDragListener(org.richfaces.event.DragListener listener)
|
void |
removeDropListener(org.richfaces.event.DropListener listener)
|
void |
removeNodeSelectListener(org.richfaces.event.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)
|
void |
setAjaxSingle(boolean __ajaxSingle)
if "true", submits ONLY one field/link, instead of all form controls Setter for ajaxSingle |
abstract void |
setAjaxSubmitSelection(java.lang.String ajaxSubmitSelection)
|
void |
setBypassUpdates(boolean __bypassUpdates)
If "true", after process validations phase it skips updates of model beans on a force render response. |
void |
setData(java.lang.Object __data)
Serialized (on default with JSON) data passed on the client by a developer on AJAX request. |
void |
setDragIndicator(java.lang.String dragIndicator)
|
void |
setDragType(java.lang.String dragType)
|
void |
setEventsQueue(java.lang.String __eventsQueue)
Name of requests queue to avoid send next request before complete other from same event. |
void |
setFocus(java.lang.String __focus)
id of element to set focus after request completed on client side Setter for focus |
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)
|
void |
setIgnoreDupResponses(boolean __ignoreDupResponses)
Attribute allows to ignore an Ajax Response produced by a request if the newest 'similar' request is in a queue already. |
void |
setLimitToList(boolean __limitToList)
If "true", updates on client side ONLY elements from this 'reRender' property. |
void |
setOncomplete(java.lang.String __oncomplete)
JavaScript code for call after request completed on client side Setter for oncomplete |
void |
setProcess(java.lang.Object process)
|
void |
setRequestDelay(int __requestDelay)
Attribute defines the time (in ms.) that the request will be wait in the queue before it is ready to send. |
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. |
abstract void |
setSelectedClass(java.lang.String selectedClass)
|
void |
setSimilarityGroupingId(java.lang.String __similarityGroupingId)
|
void |
setStatus(java.lang.String __status)
ID (in format of call UIComponent.findComponent()) of Request status component Setter for status |
void |
setTimeout(int __timeout)
Response waiting time on a particular request. |
abstract void |
setType(java.lang.String type)
|
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getContainerClientId, getFamily, getValueExpression, setValueExpression |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.richfaces.event.TreeListenerEventsProducer |
---|
getChangeExpandListener, getDragListener, getDropListener, getNodeSelectListener, setChangeExpandListener, setDragListener, setDropListener, setNodeSelectListener |
Methods inherited from interface org.richfaces.component.Draggable |
---|
getDragListener, getDragValue, getGrabbingCursors, getGrabCursors, getOndragend, getOndragstart, getOndropout, getOndropover, setDragListener, setDragValue, setGrabbingCursors, setGrabCursors, setOndragend, setOndragstart, setOndropout, setOndropover |
Methods inherited from interface org.richfaces.component.Dropzone |
---|
getAcceptCursors, getCursorTypeMapping, getDropValue, getOndragenter, getOndragexit, getOndrop, getOndropend, getRejectCursors, getTypeMapping, setAcceptCursors, setCursorTypeMapping, setDropValue, setOndragenter, setOndragexit, setOndrop, setOndropend, setRejectCursors, setTypeMapping |
Methods inherited from interface org.richfaces.event.DropSource |
---|
getDropListener, setDropListener |
Methods inherited from interface org.ajax4jsf.component.AjaxComponent |
---|
getOnbeforedomupdate, setOnbeforedomupdate |
Field Detail |
---|
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String COMPONENT_FAMILY
protected static final java.lang.String DEFAULT_NODE_FACE_ATTRIBUTE_NAME
UITreeNode
providing default representation for node. Default
tree node representation should use attributes of its parent
UITree
component
Constructor Detail |
---|
public UITreeNode()
Method Detail |
---|
public abstract java.lang.String getType()
public abstract void setType(java.lang.String type)
public abstract java.lang.String getIcon()
public abstract void setIcon(java.lang.String icon)
public abstract java.lang.String getIconExpanded()
public abstract void setIconExpanded(java.lang.String icon)
public abstract java.lang.String getIconCollapsed()
public abstract void setIconCollapsed(java.lang.String icon)
public abstract java.lang.String getIconLeaf()
public abstract void setIconLeaf(java.lang.String icon)
public abstract void setAjaxSubmitSelection(java.lang.String ajaxSubmitSelection)
public abstract java.lang.String getAjaxSubmitSelection()
public abstract void setHighlightedClass(java.lang.String selectedClass)
public abstract java.lang.String getHighlightedClass()
public abstract void setSelectedClass(java.lang.String selectedClass)
public abstract java.lang.String getSelectedClass()
public boolean hasAjaxSubmitSelection()
hasAjaxSubmitSelection
in interface org.richfaces.event.TreeListenerEventsProducer
public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
broadcast
in class javax.faces.component.UIComponentBase
javax.faces.event.AbortProcessingException
public void queueEvent(javax.faces.event.FacesEvent event)
Queue an event for broadcast at the end of the current request
processing lifecycle phase. The default implementation in
UIComponentBase
must delegate this call to the
queueEvent()
method of the parent UIComponent
.
queueEvent
in class javax.faces.component.UIComponentBase
event
- FacesEvent
to be queued
java.lang.IllegalStateException
- if this component is not a descendant of a UIViewRoot
java.lang.NullPointerException
- if event
is null
public void addChangeExpandListener(org.richfaces.event.NodeExpandedListener listener)
addChangeExpandListener
in interface org.richfaces.event.TreeListenerEventsProducer
public void addNodeSelectListener(org.richfaces.event.NodeSelectedListener listener)
addNodeSelectListener
in interface org.richfaces.event.TreeListenerEventsProducer
public void removeChangeExpandListener(org.richfaces.event.NodeExpandedListener listener)
public void removeNodeSelectListener(org.richfaces.event.NodeSelectedListener listener)
public org.richfaces.event.NodeExpandedListener[] getChangeExpandListeners()
public org.richfaces.event.NodeSelectedListener[] getNodeSelectListeners()
public UITree getUITree()
UITree
component or throws
UITree
instancepublic void addDropListener(org.richfaces.event.DropListener listener)
addDropListener
in interface org.richfaces.event.DropSource
public org.richfaces.event.DropListener[] getDropListeners()
getDropListeners
in interface org.richfaces.event.DropSource
public void removeDropListener(org.richfaces.event.DropListener listener)
removeDropListener
in interface org.richfaces.event.DropSource
public void addDragListener(org.richfaces.event.DragListener listener)
addDragListener
in interface org.richfaces.component.Draggable
public org.richfaces.event.DragListener[] getDragListeners()
getDragListeners
in interface org.richfaces.component.Draggable
public void removeDragListener(org.richfaces.event.DragListener listener)
removeDragListener
in interface org.richfaces.component.Draggable
public void setAcceptedTypes(java.lang.Object types)
setAcceptedTypes
in interface org.richfaces.component.Dropzone
public java.lang.Object getAcceptedTypes()
getAcceptedTypes
in interface org.richfaces.component.Dropzone
public void setDragType(java.lang.String dragType)
setDragType
in interface org.richfaces.component.Draggable
public java.lang.String getDragType()
getDragType
in interface org.richfaces.component.Draggable
public javax.faces.component.UIComponent getIconFacet()
public javax.faces.component.UIComponent getIconLeafFacet()
public javax.faces.component.UIComponent getIconExpandedFacet()
public javax.faces.component.UIComponent getIconCollapsedFacet()
public java.lang.Object saveState(javax.faces.context.FacesContext context)
saveState
in interface javax.faces.component.StateHolder
saveState
in class javax.faces.component.UIComponentBase
public void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class javax.faces.component.UIComponentBase
public void setDragIndicator(java.lang.String dragIndicator)
setDragIndicator
in interface org.richfaces.component.Draggable
protected java.lang.String getLocalDragIndicator()
public java.lang.String getDragIndicator()
getDragIndicator
in interface org.richfaces.component.Draggable
public java.lang.String getResolvedDragIndicator(javax.faces.context.FacesContext facesContext)
getResolvedDragIndicator
in interface org.richfaces.component.Draggable
protected java.lang.String getDefaultOndragend()
protected java.lang.String getDefaultOndragenter()
protected java.lang.String getDefaultOndragexit()
protected java.lang.String getDefaultOndragstart()
protected java.lang.String getDefaultOndrop()
protected java.lang.String getDefaultOndropend()
protected int getDefaultTimeout()
protected java.lang.Object getDefaultReRender()
public void setAjaxSingle(boolean __ajaxSingle)
setAjaxSingle
in interface org.ajax4jsf.component.AjaxComponent
ajaxSingle
- - new valuepublic boolean isAjaxSingle()
isAjaxSingle
in interface org.ajax4jsf.component.AjaxComponent
public java.lang.Object getProcess()
getProcess
in interface org.ajax4jsf.component.AjaxComponent
public void setProcess(java.lang.Object process)
setProcess
in interface org.ajax4jsf.component.AjaxComponent
public void setBypassUpdates(boolean __bypassUpdates)
setBypassUpdates
in interface org.ajax4jsf.component.AjaxComponent
bypassUpdates
- - new valuepublic boolean isBypassUpdates()
isBypassUpdates
in interface org.ajax4jsf.component.AjaxComponent
public void setLimitToList(boolean __limitToList)
setLimitToList
in interface org.ajax4jsf.component.AjaxComponent
limitToList
- - new valuepublic boolean isLimitToList()
isLimitToList
in interface org.ajax4jsf.component.AjaxComponent
public void setReRender(java.lang.Object __reRender)
setReRender
in interface org.ajax4jsf.component.AjaxComponent
reRender
- - new valuepublic java.lang.Object getReRender()
getReRender
in interface org.ajax4jsf.component.AjaxComponent
public void setStatus(java.lang.String __status)
setStatus
in interface org.ajax4jsf.component.AjaxComponent
status
- - new valuepublic java.lang.String getStatus()
getStatus
in interface org.ajax4jsf.component.AjaxComponent
public void setEventsQueue(java.lang.String __eventsQueue)
setEventsQueue
in interface org.ajax4jsf.component.AjaxComponent
eventsQueue
- - new valuepublic java.lang.String getEventsQueue()
getEventsQueue
in interface org.ajax4jsf.component.AjaxComponent
public void setSimilarityGroupingId(java.lang.String __similarityGroupingId)
setSimilarityGroupingId
in interface org.ajax4jsf.component.AjaxComponent
similarityGroupingId
- - new valuepublic java.lang.String getSimilarityGroupingId()
getSimilarityGroupingId
in interface org.ajax4jsf.component.AjaxComponent
public void setRequestDelay(int __requestDelay)
setRequestDelay
in interface org.ajax4jsf.component.AjaxComponent
requestDelay
- - new valuepublic int getRequestDelay()
getRequestDelay
in interface org.ajax4jsf.component.AjaxComponent
public void setOncomplete(java.lang.String __oncomplete)
setOncomplete
in interface org.ajax4jsf.component.AjaxComponent
oncomplete
- - new valuepublic java.lang.String getOncomplete()
getOncomplete
in interface org.ajax4jsf.component.AjaxComponent
public void setFocus(java.lang.String __focus)
setFocus
in interface org.ajax4jsf.component.AjaxComponent
focus
- - new valuepublic java.lang.String getFocus()
getFocus
in interface org.ajax4jsf.component.AjaxComponent
public void setData(java.lang.Object __data)
setData
in interface org.ajax4jsf.component.AjaxComponent
data
- - new valuepublic java.lang.Object getData()
getData
in interface org.ajax4jsf.component.AjaxComponent
public void setIgnoreDupResponses(boolean __ignoreDupResponses)
setIgnoreDupResponses
in interface org.ajax4jsf.component.AjaxComponent
ignoreDupResponses
- - new valuepublic boolean isIgnoreDupResponses()
isIgnoreDupResponses
in interface org.ajax4jsf.component.AjaxComponent
public void setTimeout(int __timeout)
setTimeout
in interface org.ajax4jsf.component.AjaxComponent
timeout
- - new valuepublic int getTimeout()
getTimeout
in interface org.ajax4jsf.component.AjaxComponent
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |