|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIData
org.ajax4jsf.ajax.repeat.UIDataAdaptor
org.richfaces.component.UITree
public abstract class UITree
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.ajax4jsf.ajax.repeat.UIDataAdaptor |
---|
org.ajax4jsf.ajax.repeat.UIDataAdaptor.ComponentVisitor, org.ajax4jsf.ajax.repeat.UIDataAdaptor.IndexedEvent |
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_FAMILY
|
static java.lang.String |
COMPONENT_TYPE
|
static java.lang.String |
DEFAULT_HIGHLIGHTED_CSS_CLASS
|
static java.lang.String |
DEFAULT_SELECTED_CSS_CLASS
|
static java.lang.String |
EXPANDED_STATE_PARAMETER_NAME
|
static java.lang.String |
LAST_ELEMENT_FLAG
|
static java.lang.String |
PRESERVE_MODEL_NONE
|
static java.lang.String |
PRESERVE_MODEL_REQUEST
|
static java.lang.String |
PRESERVE_MODEL_STATE
|
static java.lang.String |
SELECTED_NODE_PARAMETER_NAME
|
static java.lang.String |
SELECTION_INPUT_ATTRIBUTE
|
static java.lang.String |
SWITCH_AJAX
|
static java.lang.String |
SWITCH_CLIENT
|
static java.lang.String |
SWITCH_SERVER
|
static java.lang.String |
TOGGLE_LINK_ATTRIBUTE
|
static java.lang.String |
TREE_DATA_LOCATOR_BINDING
|
Fields inherited from class org.ajax4jsf.ajax.repeat.UIDataAdaptor |
---|
COMPONENT_STATE_ATTRIBUTE, decodeVisitor, EMPTY_MODEL, updateVisitor, validateVisitor |
Fields inherited from interface javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
UITree()
|
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)
|
protected org.ajax4jsf.ajax.repeat.DataComponentState |
createComponentState()
|
protected org.ajax4jsf.ajax.repeat.ExtendedDataModel |
createDataModel()
|
protected java.util.Iterator |
dataChildren()
|
protected java.util.Iterator |
fixedChildren()
|
javax.faces.component.UIComponent |
getComponent()
|
org.ajax4jsf.dnd.event.DragListener[] |
getDragListeners()
|
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()
|
abstract java.lang.String |
getIconExpanded()
|
abstract java.lang.String |
getIconLeaf()
|
abstract java.lang.String |
getNodeFace()
|
UITreeNode |
getNodeFacet()
Locates UITreeNode instance that has type equal to current
nodeFace. |
protected UITreeNode |
getOrCreateDefaultFacet()
Lazily creates default node representation that is used if there is no UITreeNode child for that nodeFace |
abstract java.lang.String |
getPreserveModel()
|
boolean |
getRendersChildren()
|
abstract java.lang.String |
getSelectedClass()
|
java.lang.String |
getSelectionStateInputName(javax.faces.context.FacesContext context)
|
abstract java.lang.String |
getSwitchType()
|
boolean |
hasAjaxSubmitSelection()
|
abstract boolean |
isAjaxSubmitSelection()
|
boolean |
isExpanded()
Returns whether current node is expanded |
abstract boolean |
isImmediate()
|
boolean |
isLeaf()
Returns whether current node is leaf ie. has no children |
boolean |
isSelected()
Returns whether current node is selected |
abstract boolean |
isShowConnectingLines()
|
protected boolean |
isStopInCollapsed()
Returns whether switch type is set to "server" |
void |
processDecodes(javax.faces.context.FacesContext faces)
|
void |
queueCollapseAll()
Queues all node collapsion command |
void |
queueEvent(javax.faces.event.FacesEvent event)
|
void |
queueExpandAll()
Queues all node expansion command |
void |
queueNodeCollapse(TreeRowKey rowKey)
Queues collapsion command for node whose row key is equal to rowKey parameter |
void |
queueNodeExpand(TreeRowKey rowKey)
Queues expansion command for node whose row key is equal to rowKey parameter |
void |
removeDragListener(org.ajax4jsf.dnd.event.DragListener listener)
|
void |
removeDropListener(org.ajax4jsf.dnd.event.DropListener listener)
|
void |
resetDataModel()
|
void |
restoreState(javax.faces.context.FacesContext faces,
java.lang.Object object)
|
java.lang.Object |
saveState(javax.faces.context.FacesContext faces)
|
abstract void |
setAjaxSubmitSelection(boolean ajaxSubmitSelection)
|
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 |
setImmediate(boolean immediate)
|
abstract void |
setNodeFace(java.lang.String nodeFace)
|
abstract void |
setPreserveModel(java.lang.String preserveModel)
|
abstract void |
setSelectedClass(java.lang.String selectedClass)
|
abstract void |
setShowConnectingLines(boolean showConnectingLines)
|
abstract void |
setSwitchType(java.lang.String switchType)
|
void |
walk(javax.faces.context.FacesContext faces,
org.ajax4jsf.ajax.repeat.DataVisitor visitor)
|
void |
walk(javax.faces.context.FacesContext faces,
org.ajax4jsf.ajax.repeat.DataVisitor visitor,
TreeRowKey rowKey,
java.lang.Object argument)
Walks through model or some subset of it if rowKey is not null |
void |
walkModel(javax.faces.context.FacesContext faces,
org.ajax4jsf.ajax.repeat.DataVisitor visitor,
TreeRowKey key,
java.lang.Object argument)
Walks through backing data model if current data model has one. |
Methods inherited from class org.ajax4jsf.ajax.repeat.UIDataAdaptor |
---|
broadcastLocal, captureOrigValue, captureOrigValue, encodeAjaxChild, encodeBegin, getAjaxKeys, getBaseClientId, getChildrenRenderer, getChildState, getClientId, getComponentState, getEncodedIds, getExtendedDataModel, getRowCount, getRowData, getRowIndex, getRowKey, getVarState, isRowAvailable, iterate, processDecodes, processUpdates, processUpdates, processValidators, processValidators, resetComponent, restoreChildState, restoreOrigValue, restoreOrigValue, saveChildState, setAjaxKeys, setComponentState, setExtendedDataModel, setId, setRowIndex, setRowKey, setRowKey, setupVariable, setVarState, walk |
Methods inherited from class javax.faces.component.UIData |
---|
getFamily, getFirst, getFooter, getHeader, getRows, getValue, getVar, setFirst, setFooter, setHeader, setRows, setValue, setValueBinding, setVar |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addFacesListener, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setParent, setRendered, setRendererType, setTransient |
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, getDragType, getOndragend, getOndragstart, setDragIndicator, setDragListener, setDragType, setOndragend, setOndragstart |
Methods inherited from interface org.ajax4jsf.dnd.Dropzone |
---|
getAcceptedTypes, getOndragenter, getOndragexit, getOndrop, getOndropend, getTypeMapping, setAcceptedTypes, setOndragenter, setOndragexit, setOndrop, setOndropend, setTypeMapping |
Methods inherited from interface org.ajax4jsf.dnd.event.DropSource |
---|
getDropListener, setDropListener |
Field Detail |
---|
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String PRESERVE_MODEL_STATE
public static final java.lang.String PRESERVE_MODEL_REQUEST
public static final java.lang.String PRESERVE_MODEL_NONE
public static final java.lang.String SWITCH_SERVER
public static final java.lang.String SWITCH_CLIENT
public static final java.lang.String SWITCH_AJAX
public static final java.lang.String EXPANDED_STATE_PARAMETER_NAME
public static final java.lang.String SELECTED_NODE_PARAMETER_NAME
public static final java.lang.String LAST_ELEMENT_FLAG
public static final java.lang.String SELECTION_INPUT_ATTRIBUTE
public static final java.lang.String TOGGLE_LINK_ATTRIBUTE
public static final java.lang.String TREE_DATA_LOCATOR_BINDING
public static final java.lang.String DEFAULT_SELECTED_CSS_CLASS
public static final java.lang.String DEFAULT_HIGHLIGHTED_CSS_CLASS
Constructor Detail |
---|
public UITree()
Method Detail |
---|
public boolean getRendersChildren()
getRendersChildren
in class javax.faces.component.UIComponentBase
protected UITreeNode getOrCreateDefaultFacet()
UITreeNode
child for that nodeFace
public abstract boolean isImmediate()
public abstract void setImmediate(boolean immediate)
public void queueEvent(javax.faces.event.FacesEvent event)
queueEvent
in class org.ajax4jsf.ajax.repeat.UIDataAdaptor
public UITreeNode getNodeFacet()
UITreeNode
instance that has type equal to current
nodeFace. Default nodeFace is declared as #{var.type} by default where
var is "var" attribute value Calls getOrCreateDefaultFacet()
if none found.
UITreeNode
representing current nodeFacegetOrCreateDefaultFacet()
public void resetDataModel()
resetDataModel
in class org.ajax4jsf.ajax.repeat.UIDataAdaptor
public void walk(javax.faces.context.FacesContext faces, org.ajax4jsf.ajax.repeat.DataVisitor visitor) throws java.io.IOException
java.io.IOException
public void walk(javax.faces.context.FacesContext faces, org.ajax4jsf.ajax.repeat.DataVisitor visitor, TreeRowKey rowKey, java.lang.Object argument) throws java.io.IOException
faces
- FacesContext
instancevisitor
- UIDataAdaptor.ComponentVisitor
instancerowKey
- TreeRowKey
instance to start from or null to start
from rootargument
- implementation-specific visitor argument
java.io.IOException
public void walkModel(javax.faces.context.FacesContext faces, org.ajax4jsf.ajax.repeat.DataVisitor visitor, TreeRowKey key, java.lang.Object argument) throws java.io.IOException
faces
- FacesContext
instancevisitor
- UIDataAdaptor.ComponentVisitor
instancerowKey
- TreeRowKey
instance to start from or null to start
from rootargument
- implementation-specific visitor argument
java.io.IOException
public java.lang.String getSelectionStateInputName(javax.faces.context.FacesContext context)
public void processDecodes(javax.faces.context.FacesContext faces)
processDecodes
in class org.ajax4jsf.ajax.repeat.UIDataAdaptor
protected java.util.Iterator dataChildren()
dataChildren
in class org.ajax4jsf.ajax.repeat.UIDataAdaptor
public boolean isLeaf()
true
if current node is leaf else
false
public boolean isExpanded()
true
if node is expanded else false
public boolean isSelected()
true
if node is selected else false
protected java.util.Iterator fixedChildren()
fixedChildren
in class org.ajax4jsf.ajax.repeat.UIDataAdaptor
protected org.ajax4jsf.ajax.repeat.DataComponentState createComponentState()
createComponentState
in class org.ajax4jsf.ajax.repeat.UIDataAdaptor
protected boolean isStopInCollapsed()
true
if switch type is "server" else
false
public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
broadcast
in class org.ajax4jsf.ajax.repeat.UIDataAdaptor
javax.faces.event.AbortProcessingException
public boolean hasAjaxSubmitSelection()
hasAjaxSubmitSelection
in interface TreeListenerEventsProducer
protected org.ajax4jsf.ajax.repeat.ExtendedDataModel createDataModel()
createDataModel
in class org.ajax4jsf.ajax.repeat.UIDataAdaptor
public void queueNodeExpand(TreeRowKey rowKey) throws java.io.IOException
rowKey
- of the node to expand
java.io.IOException
public void queueNodeCollapse(TreeRowKey rowKey) throws java.io.IOException
rowKey
- of the node to expand
java.io.IOException
public void queueExpandAll() throws java.io.IOException
java.io.IOException
public void queueCollapseAll() throws java.io.IOException
java.io.IOException
public abstract java.lang.String getSwitchType()
public abstract void setSwitchType(java.lang.String switchType)
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 setShowConnectingLines(boolean showConnectingLines)
public abstract boolean isShowConnectingLines()
public abstract void setAjaxSubmitSelection(boolean ajaxSubmitSelection)
public abstract boolean isAjaxSubmitSelection()
public abstract java.lang.String getPreserveModel()
public abstract void setPreserveModel(java.lang.String preserveModel)
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 abstract void setNodeFace(java.lang.String nodeFace)
public abstract java.lang.String getNodeFace()
public void addChangeExpandListener(NodeExpandedListener listener)
addChangeExpandListener
in interface TreeListenerEventsProducer
public void addNodeSelectListener(NodeSelectedListener listener)
addNodeSelectListener
in interface TreeListenerEventsProducer
public java.lang.Object getDragValue()
getDragValue
in interface org.ajax4jsf.dnd.Draggable
public javax.faces.component.UIComponent getComponent()
public java.lang.Object getDropValue()
getDropValue
in interface org.ajax4jsf.dnd.Dropzone
public void addDropListener(org.ajax4jsf.dnd.event.DropListener listener)
addDropListener
in interface org.ajax4jsf.dnd.event.DropSource
public org.ajax4jsf.dnd.event.DropListener[] getDropListeners()
getDropListeners
in interface org.ajax4jsf.dnd.event.DropSource
public void removeDropListener(org.ajax4jsf.dnd.event.DropListener listener)
removeDropListener
in interface org.ajax4jsf.dnd.event.DropSource
public void addDragListener(org.ajax4jsf.dnd.event.DragListener listener)
addDragListener
in interface org.ajax4jsf.dnd.Draggable
public org.ajax4jsf.dnd.event.DragListener[] getDragListeners()
getDragListeners
in interface org.ajax4jsf.dnd.Draggable
public void removeDragListener(org.ajax4jsf.dnd.event.DragListener listener)
removeDragListener
in interface org.ajax4jsf.dnd.Draggable
public void setDragValue(java.lang.Object value)
setDragValue
in interface org.ajax4jsf.dnd.Draggable
public void setDropValue(java.lang.Object o)
setDropValue
in interface org.ajax4jsf.dnd.Dropzone
public java.lang.Object saveState(javax.faces.context.FacesContext faces)
saveState
in interface javax.faces.component.StateHolder
saveState
in class org.ajax4jsf.ajax.repeat.UIDataAdaptor
public void restoreState(javax.faces.context.FacesContext faces, java.lang.Object object)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class org.ajax4jsf.ajax.repeat.UIDataAdaptor
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |