|
ICEfaces ACE Components 3.3.0 Java API Documentation |
||||||||
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.icefaces.ace.component.tree.TreeBase
public class TreeBase
Renders a hierarchical structure of ace:node contents. Supports client-side and server-side node selection and expansion. Other features available include: user reordering of nodes, multiple selection and lazy node state initialization.
For more information, see the Tree Wiki Documentation.
Nested Class Summary | |
---|---|
protected static class |
TreeBase.PropertyKeys
|
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_TYPE
|
static java.lang.String |
RENDERER_TYPE
|
Fields inherited from class javax.faces.component.UIData |
---|
COMPONENT_FAMILY |
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 javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
TreeBase()
|
Method Summary | |
---|---|
void |
addClientBehavior(java.lang.String eventName,
javax.faces.component.behavior.ClientBehavior behavior)
|
java.lang.String |
getDefaultEventName()
|
java.lang.String |
getDefaultExecute(java.lang.String event)
|
java.lang.String |
getDefaultRender(java.lang.String event)
|
java.util.Collection<java.lang.String> |
getEventNames()
|
TreeExpansionMode |
getExpansionMode()
Return the value of the expansionMode property. |
java.lang.String |
getFamily()
|
KeySegmentConverter |
getKeyConverter()
Return the value of the keyConverter property. |
TreeSelectionMode |
getSelectionMode()
Return the value of the selectionMode property. |
NodeStateCreationCallback |
getStateCreationCallback()
Return the value of the stateCreationCallback property. |
NodeStateMap |
getStateMap()
Return the value of the stateMap property. |
java.lang.String |
getStateVar()
Return the value of the stateVar property. |
java.lang.String |
getType()
Return the value of the type property. |
java.lang.Boolean |
isExpansion()
Return the value of the expansion property. |
java.lang.Boolean |
isReordering()
Return the value of the reordering property. |
java.lang.Boolean |
isSelection()
Return the value of the selection property. |
java.lang.Boolean |
isSelectMultiple()
Return the value of the selectMultiple property. |
void |
setExpansion(java.lang.Boolean expansion)
Set the value of the expansion property. |
void |
setExpansionMode(TreeExpansionMode expansionMode)
Set the value of the expansionMode property. |
void |
setKeyConverter(KeySegmentConverter keyConverter)
Set the value of the keyConverter property. |
void |
setReordering(java.lang.Boolean reordering)
Set the value of the reordering property. |
void |
setSelection(java.lang.Boolean selection)
Set the value of the selection property. |
void |
setSelectionMode(TreeSelectionMode selectionMode)
Set the value of the selectionMode property. |
void |
setSelectMultiple(java.lang.Boolean selectMultiple)
Set the value of the selectMultiple property. |
void |
setStateCreationCallback(NodeStateCreationCallback stateCreationCallback)
Set the value of the stateCreationCallback property. |
void |
setStateMap(NodeStateMap stateMap)
Set the value of the stateMap property. |
void |
setStateVar(java.lang.String stateVar)
Set the value of the stateVar property. |
void |
setType(java.lang.String type)
Set the value of the type property. |
Methods inherited from class javax.faces.component.UIData |
---|
broadcast, createUniqueId, encodeBegin, getClientId, getDataModel, getFirst, getFooter, getHeader, getRowCount, getRowData, getRowIndex, getRows, getValue, getVar, invokeOnComponent, isRowAvailable, isRowStatePreserved, markInitialState, processDecodes, processUpdates, processValidators, queueEvent, restoreState, saveState, setDataModel, setFirst, setFooter, setHeader, setRowIndex, setRows, setRowStatePreserved, setValue, setValueBinding, setValueExpression, setVar, visitTree |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addFacesListener, clearInitialState, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEvent |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView |
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 |
---|
getClientBehaviors |
Field Detail |
---|
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String RENDERER_TYPE
Constructor Detail |
---|
public TreeBase()
Method Detail |
---|
public java.lang.String getFamily()
getFamily
in class javax.faces.component.UIData
public void setExpansion(java.lang.Boolean expansion)
Set the value of the expansion
property.
Contents: Enable expansion feature of this tree component. This toggles this feature for the entire tree, per-node configuration of this feature available via the NodeState.
setExpansion
in interface ITree
public java.lang.Boolean isExpansion()
Return the value of the expansion
property.
Contents: Enable expansion feature of this tree component. This toggles this feature for the entire tree, per-node configuration of this feature available via the NodeState. Default = 'false'.
isExpansion
in interface ITree
public void setExpansionMode(TreeExpansionMode expansionMode)
Set the value of the expansionMode
property.
Contents: Select the request behaviour of the expansion feature. When 'client', the children of every node are pre-rendered in the DOM and exposed by JavaScript when nodes are expanded. In the default 'server' mode, only visible nodes are inthe DOM and expansion and contraction are caused by ajax page updates.
setExpansionMode
in interface ITree
public TreeExpansionMode getExpansionMode()
Return the value of the expansionMode
property.
Contents: Select the request behaviour of the expansion feature. When 'client', the children of every node are pre-rendered in the DOM and exposed by JavaScript when nodes are expanded. In the default 'server' mode, only visible nodes are inthe DOM and expansion and contraction are caused by ajax page updates. Default = 'org.icefaces.ace.component.tree.TreeExpansionMode.server'.
getExpansionMode
in interface ITree
public void setKeyConverter(KeySegmentConverter keyConverter)
Set the value of the keyConverter
property.
Contents: Optionally define a custom KeySegmentConverter object to produce segmented identifier keys for nodes based on something other than indexes.
setKeyConverter
in interface ITree
public KeySegmentConverter getKeyConverter()
Return the value of the keyConverter
property.
Contents: Optionally define a custom KeySegmentConverter object to produce segmented identifier keys for nodes based on something other than indexes.
getKeyConverter
in interface ITree
public void setReordering(java.lang.Boolean reordering)
Set the value of the reordering
property.
Contents: Enable reordering of the nodes of this tree.
setReordering
in interface ITree
public java.lang.Boolean isReordering()
Return the value of the reordering
property.
Contents: Enable reordering of the nodes of this tree. Default = 'false'.
isReordering
in interface ITree
public void setSelectMultiple(java.lang.Boolean selectMultiple)
Set the value of the selectMultiple
property.
Contents: Disable the selection of multiple nodes simultaneously.
setSelectMultiple
in interface ITree
public java.lang.Boolean isSelectMultiple()
Return the value of the selectMultiple
property.
Contents: Disable the selection of multiple nodes simultaneously. Default = 'true'.
isSelectMultiple
in interface ITree
public void setSelection(java.lang.Boolean selection)
Set the value of the selection
property.
Contents: Enable selection feature of this tree component. This toggles this feature for the entire tree, per-node configuration of this feature available via the NodeState.
setSelection
in interface ITree
public java.lang.Boolean isSelection()
Return the value of the selection
property.
Contents: Enable selection feature of this tree component. This toggles this feature for the entire tree, per-node configuration of this feature available via the NodeState. Default = 'false'.
isSelection
in interface ITree
public void setSelectionMode(TreeSelectionMode selectionMode)
Set the value of the selectionMode
property.
Contents: Select the request behaviour of the selection feature. When 'client', the (de)selection of a node is recorded on the client, and communicated to the server on the next request executing this component. In the default 'server' mode, when a node is (de)selected, the component communicates the change the server immediately with an ajax update.
setSelectionMode
in interface ITree
public TreeSelectionMode getSelectionMode()
Return the value of the selectionMode
property.
Contents: Select the request behaviour of the selection feature. When 'client', the (de)selection of a node is recorded on the client, and communicated to the server on the next request executing this component. In the default 'server' mode, when a node is (de)selected, the component communicates the change the server immediately with an ajax update. Default = 'org.icefaces.ace.component.tree.TreeSelectionMode.server'.
getSelectionMode
in interface ITree
public void setStateCreationCallback(NodeStateCreationCallback stateCreationCallback)
Set the value of the stateCreationCallback
property.
Contents: Bind an implementer of the NodeStateCreationCallback interface to take as input, a node object and a default NodeState and return a NodeState configured with the state appropriatefor the given node object.
setStateCreationCallback
in interface ITree
public NodeStateCreationCallback getStateCreationCallback()
Return the value of the stateCreationCallback
property.
Contents: Bind an implementer of the NodeStateCreationCallback interface to take as input, a node object and a default NodeState and return a NodeState configured with the state appropriatefor the given node object.
getStateCreationCallback
in interface ITree
public void setStateMap(NodeStateMap stateMap)
Set the value of the stateMap
property.
Contents: Define a NodeStateMap ValueExpression to access the store of Tree node object state information. The state map provides an API for looking up the state of a particular node object, as well as reverse look-ups to get node objects with a particular state.
setStateMap
in interface ITree
public NodeStateMap getStateMap()
Return the value of the stateMap
property.
Contents: Define a NodeStateMap ValueExpression to access the store of Tree node object state information. The state map provides an API for looking up the state of a particular node object, as well as reverse look-ups to get node objects with a particular state.
getStateMap
in interface ITree
public void setStateVar(java.lang.String stateVar)
Set the value of the stateVar
property.
Contents: The request-scope attribute exposing the state object for the currentnode when iterating.
setStateVar
in interface ITree
public java.lang.String getStateVar()
Return the value of the stateVar
property.
Contents: The request-scope attribute exposing the state object for the currentnode when iterating. Default = 'nodeState'.
getStateVar
in interface ITree
public void setType(java.lang.String type)
Set the value of the type
property.
Contents: Define a ValueExpression that returns a String representation of the 'rendering type' of this node. The rendering type is matched against the String 'type' attribute of ace:node tag instances to determine which node template should be used to render a given node object.
setType
in interface ITree
public java.lang.String getType()
Return the value of the type
property.
Contents: Define a ValueExpression that returns a String representation of the 'rendering type' of this node. The rendering type is matched against the String 'type' attribute of ace:node tag instances to determine which node template should be used to render a given node object.
getType
in interface ITree
public java.util.Collection<java.lang.String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
getEventNames
in class javax.faces.component.UIComponentBase
public java.lang.String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class javax.faces.component.UIComponentBase
public java.lang.String getDefaultRender(java.lang.String event)
getDefaultRender
in interface IceClientBehaviorHolder
public java.lang.String getDefaultExecute(java.lang.String event)
getDefaultExecute
in interface IceClientBehaviorHolder
public void addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior)
addClientBehavior
in interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior
in class javax.faces.component.UIComponentBase
|
ICEfaces ACE Components 3.3.0 Java API Documentation |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |