|
ICEfaces ICE 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.UICommand
com.icesoft.faces.component.tree.Tree
public class Tree
Tree is a JSF component class that represent an ICEfaces tree.
The tree component displays hierarchical data as a "tree" of branches and leaf nodes. Optionally, the tree may also display navigation controls for the dynamic expansion and collapse of branch nodes. Nodes may also support an action event when clicked that can be used to respond to user click events. This component extends the JSF UICommand component and implemnents the JSF NamingContainer interface. By default this component is rendered by the "com.icesoft.faces.View" renderer type.
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_TYPE
String constant specifying component type |
static java.lang.String |
ID_PREFIX
String constant for tree node id prefix. |
static java.lang.String |
NAVIGATION_EVENT_COLLAPSE
String constant for tree node collapse event. |
static java.lang.String |
NAVIGATION_EVENT_EXPAND
String constant for tree node expand event. |
protected java.util.Map |
savedChildren
This map contains ChildState instances for each child
component, keyed by the client id of the child. |
Fields inherited from class javax.faces.component.UICommand |
---|
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 | |
---|---|
Tree()
default no args constructor |
Method Summary | |
---|---|
void |
broadcast(javax.faces.event.FacesEvent event)
|
void |
encodeBegin(javax.faces.context.FacesContext context)
|
java.lang.String |
getComponentType()
|
javax.swing.tree.DefaultMutableTreeNode |
getCurrentNode()
|
java.lang.String |
getDocumentImage()
|
javax.swing.tree.TreeModel |
getDummyModel()
|
java.lang.String |
getFamily()
|
java.lang.String |
getFolderImage()
|
java.lang.String |
getFolderOpenImage()
|
java.lang.String |
getHideNavigation()
|
java.lang.String |
getHideRootNode()
|
java.lang.String |
getImage(java.lang.String imageProperty,
java.lang.String bindingName,
java.lang.String defaultImage)
|
java.lang.String |
getImageDir()
|
java.lang.String |
getLineBlank()
|
java.lang.String |
getLineBlankImage()
|
java.lang.String |
getLineBottomImage()
|
java.lang.String |
getLineBottomNode()
|
java.lang.String |
getLineMiddleImage()
|
java.lang.String |
getLineMiddleNode()
|
java.lang.String |
getLineVertical()
|
java.lang.String |
getLineVerticalImage()
|
javax.swing.tree.TreeModel |
getModel()
|
java.lang.String |
getNavCloseBottom()
|
java.lang.String |
getNavCloseBottomImage()
|
java.lang.String |
getNavCloseMiddle()
|
java.lang.String |
getNavCloseMiddleImage()
|
java.lang.String |
getNavCloseTop()
|
java.lang.String |
getNavCloseTopImage()
|
java.lang.String |
getNavCloseTopNoSiblings()
|
java.lang.String |
getNavCloseTopNoSiblingsImage()
|
java.lang.String |
getNavExpandedMiddle()
|
java.lang.String |
getNavExpandedTop()
|
javax.swing.tree.DefaultMutableTreeNode |
getNavigatedNode()
|
java.lang.String |
getNavigationEventType()
|
java.lang.String |
getNavOpenBottom()
|
java.lang.String |
getNavOpenBottomImage()
|
java.lang.String |
getNavOpenMiddle()
|
java.lang.String |
getNavOpenMiddleImage()
|
java.lang.String |
getNavOpenTop()
|
java.lang.String |
getNavOpenTopImage()
|
java.lang.String |
getNavOpenTopNoSiblings()
|
java.lang.String |
getNavOpenTopNoSiblingsImage()
|
javax.swing.tree.DefaultMutableTreeNode |
getNodeAtPathsEnd(java.lang.String pathToSelectedNode)
|
java.lang.String |
getNodePath()
|
java.lang.String |
getRendererType()
|
java.lang.String |
getStyle()
Set the value of the style property. |
java.lang.String |
getStyleClass()
Set the value of the styleClass property. |
java.lang.String |
getTitle()
|
TreeNode |
getTreeNodeTemplate()
|
java.lang.String |
getVar()
|
boolean |
invokeOnComponent(javax.faces.context.FacesContext context,
java.lang.String clientId,
javax.faces.component.ContextCallback callback)
|
boolean |
isKeyboardNavigationEnabled()
|
void |
processDecodes(javax.faces.context.FacesContext context)
|
void |
processUpdates(javax.faces.context.FacesContext context)
|
void |
processValidators(javax.faces.context.FacesContext context)
|
void |
queueEvent(javax.faces.event.FacesEvent event)
|
protected void |
restoreChild(javax.faces.component.UIComponent component,
javax.faces.context.FacesContext context)
Restore state information for the given child component. |
protected void |
restoreChildrenState(javax.faces.context.FacesContext context)
Restore state information for all child components. |
void |
restoreState(javax.faces.context.FacesContext context,
java.lang.Object state)
restore the tree component state |
protected void |
saveChild(javax.faces.component.UIComponent component,
javax.faces.context.FacesContext context)
Save state information for the given child component. |
protected void |
saveChildrenState(javax.faces.context.FacesContext context)
Save state information for all children of this component. |
protected void |
saveChildState(javax.faces.component.UIComponent component,
javax.faces.context.FacesContext context)
Save state information for the given child component and its children. |
java.lang.Object |
saveState(javax.faces.context.FacesContext context)
save the tree component state |
void |
setCurrentNode(javax.swing.tree.DefaultMutableTreeNode currentNode)
|
void |
setDocumentImage(java.lang.String documentImage)
|
void |
setFolderImage(java.lang.String folderImage)
|
void |
setFolderOpenImage(java.lang.String folderOpenImage)
|
void |
setHideNavigation(java.lang.String b)
|
void |
setHideRootNode(java.lang.String b)
|
void |
setImageDir(java.lang.String imageDir)
|
void |
setKeyboardNavigationEnabled(boolean keyboardNavigationEnabled)
|
void |
setLineBlank(java.lang.String lineBlank)
|
void |
setLineBottomNode(java.lang.String lineBottomNode)
|
void |
setLineMiddleNode(java.lang.String lineMiddleNode)
|
void |
setLineVertical(java.lang.String lineVertical)
|
void |
setNavCloseBottom(java.lang.String navCloseBottom)
|
void |
setNavCloseMiddle(java.lang.String navCloseMiddle)
|
void |
setNavCloseTop(java.lang.String navCloseTop)
|
void |
setNavCloseTopNoSiblings(java.lang.String navCloseTopNoSiblings)
|
void |
setNavExpandedMiddle(java.lang.String navExpandedMiddle)
|
void |
setNavExpandedTop(java.lang.String navExpandedTop)
|
void |
setNavigatedNode(javax.swing.tree.DefaultMutableTreeNode navigatedNode)
|
void |
setNavigationEventType(java.lang.String string)
|
void |
setNavOpenBottom(java.lang.String navOpenBottom)
|
void |
setNavOpenMiddle(java.lang.String navOpenMiddle)
|
void |
setNavOpenTop(java.lang.String navOpenTop)
|
void |
setNavOpenTopNoSiblings(java.lang.String navOpenTopNoSiblings)
|
void |
setNodePath(java.lang.String nodePath)
|
void |
setStyle(java.lang.String style)
Set the value of the style property. |
void |
setStyleClass(java.lang.String styleClass)
Set the value of the styleClass property. |
void |
setTitle(java.lang.String title)
|
void |
setVar(java.lang.String var)
|
boolean |
visitTree(javax.faces.component.visit.VisitContext context,
javax.faces.component.visit.VisitCallback callback)
|
Methods inherited from class javax.faces.component.UICommand |
---|
addActionListener, getAction, getActionExpression, getActionListener, getActionListeners, getValue, isImmediate, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate, setValue |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addClientBehavior, addFacesListener, clearInitialState, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendersChildren, getValueBinding, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, 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, setValueExpression |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String NAVIGATION_EVENT_COLLAPSE
public static final java.lang.String NAVIGATION_EVENT_EXPAND
public static final java.lang.String ID_PREFIX
public static final java.lang.String COMPONENT_TYPE
protected java.util.Map savedChildren
This map contains ChildState
instances for each child
component, keyed by the client id of the child.
Constructor Detail |
---|
public Tree()
Method Detail |
---|
public java.lang.String getRendererType()
getRendererType
in class javax.faces.component.UIComponentBase
public java.lang.String getComponentType()
public java.lang.String getFamily()
getFamily
in class javax.faces.component.UICommand
public void setCurrentNode(javax.swing.tree.DefaultMutableTreeNode currentNode)
currentNode
- public javax.swing.tree.DefaultMutableTreeNode getCurrentNode()
public void encodeBegin(javax.faces.context.FacesContext context) throws java.io.IOException
encodeBegin
in class javax.faces.component.UIComponentBase
java.io.IOException
public void setNodePath(java.lang.String nodePath)
nodePath
- public java.lang.String getNodePath()
public javax.swing.tree.TreeModel getModel()
public javax.swing.tree.TreeModel getDummyModel()
public TreeNode getTreeNodeTemplate() throws MalformedTreeTagException
MalformedTreeTagException
public javax.swing.tree.DefaultMutableTreeNode getNodeAtPathsEnd(java.lang.String pathToSelectedNode)
pathToSelectedNode
-
public java.lang.String getImageDir()
public java.lang.String getStyleClass()
Set the value of the styleClass
property.
public void setStyleClass(java.lang.String styleClass)
Set the value of the styleClass
property.
styleClass
- public java.lang.String getStyle()
Set the value of the style
property.
public void setStyle(java.lang.String style)
Set the value of the style
property.
style
- public java.lang.String getImage(java.lang.String imageProperty, java.lang.String bindingName, java.lang.String defaultImage)
imageProperty
- bindingName
- defaultImage
-
public java.lang.String getFolderImage()
public java.lang.String getFolderOpenImage()
public java.lang.String getDocumentImage()
public java.lang.String getLineBottomImage()
public java.lang.String getLineVerticalImage()
public java.lang.String getLineMiddleImage()
public java.lang.String getNavCloseMiddleImage()
public java.lang.String getNavOpenMiddleImage()
public java.lang.String getNavCloseTopImage()
public java.lang.String getNavOpenTopImage()
public java.lang.String getNavOpenTopNoSiblingsImage()
public java.lang.String getNavCloseTopNoSiblingsImage()
public java.lang.String getNavCloseBottomImage()
public java.lang.String getNavOpenBottomImage()
public java.lang.String getLineBlankImage()
public java.lang.String getLineBottomNode()
public void setLineBottomNode(java.lang.String lineBottomNode)
lineBottomNode
- public java.lang.String getLineMiddleNode()
public void setLineMiddleNode(java.lang.String lineMiddleNode)
lineMiddleNode
- public java.lang.String getLineVertical()
public void setLineVertical(java.lang.String lineVertical)
lineVertical
- public java.lang.String getNavExpandedMiddle()
public void setNavExpandedMiddle(java.lang.String navExpandedMiddle)
navExpandedMiddle
- public java.lang.String getNavExpandedTop()
public void setNavExpandedTop(java.lang.String navExpandedTop)
navExpandedTop
- public void setImageDir(java.lang.String imageDir)
imageDir
- public void setDocumentImage(java.lang.String documentImage)
documentImage
- public void setFolderImage(java.lang.String folderImage)
folderImage
- public java.lang.String getNavCloseTop()
public void setNavCloseTop(java.lang.String navCloseTop)
navCloseTop
- public java.lang.String getNavOpenTop()
public void setNavOpenTop(java.lang.String navOpenTop)
navOpenTop
- public java.lang.String getNavOpenTopNoSiblings()
public void setNavOpenTopNoSiblings(java.lang.String navOpenTopNoSiblings)
navOpenTopNoSiblings
- public java.lang.String getNavCloseTopNoSiblings()
public void setNavCloseTopNoSiblings(java.lang.String navCloseTopNoSiblings)
navCloseTopNoSiblings
- public void setFolderOpenImage(java.lang.String folderOpenImage)
folderOpenImage
- public java.lang.String getNavCloseBottom()
public void setNavCloseBottom(java.lang.String navCloseBottom)
navCloseBottom
- public java.lang.String getNavCloseMiddle()
public void setNavCloseMiddle(java.lang.String navCloseMiddle)
navCloseMiddle
- public java.lang.String getNavOpenBottom()
public void setNavOpenBottom(java.lang.String navOpenBottom)
navOpenBottom
- public java.lang.String getNavOpenMiddle()
public void setNavOpenMiddle(java.lang.String navOpenMiddle)
navOpenMiddle
- public java.lang.String getVar()
public void setVar(java.lang.String var)
var
- public java.lang.String getLineBlank()
public void setLineBlank(java.lang.String lineBlank)
lineBlank
- public javax.swing.tree.DefaultMutableTreeNode getNavigatedNode()
public void setNavigatedNode(javax.swing.tree.DefaultMutableTreeNode navigatedNode)
navigatedNode
- public void setNavigationEventType(java.lang.String string)
string
- public java.lang.String getNavigationEventType()
public java.lang.Object saveState(javax.faces.context.FacesContext context)
saveState
in interface javax.faces.component.StateHolder
saveState
in class javax.faces.component.UIComponentBase
context
-
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
context
- state
- public void processDecodes(javax.faces.context.FacesContext context)
processDecodes
in class javax.faces.component.UIComponentBase
public void processValidators(javax.faces.context.FacesContext context)
processValidators
in class javax.faces.component.UIComponentBase
public void processUpdates(javax.faces.context.FacesContext context)
processUpdates
in class javax.faces.component.UIComponentBase
public void queueEvent(javax.faces.event.FacesEvent event)
queueEvent
in class javax.faces.component.UICommand
public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
broadcast
in class javax.faces.component.UICommand
javax.faces.event.AbortProcessingException
public java.lang.String getHideNavigation()
public void setHideNavigation(java.lang.String b)
b
- public java.lang.String getHideRootNode()
public void setHideRootNode(java.lang.String b)
b
- public java.lang.String getTitle()
public void setTitle(java.lang.String title)
protected void restoreChildrenState(javax.faces.context.FacesContext context)
Restore state information for all child components.
context
- protected void restoreChild(javax.faces.component.UIComponent component, javax.faces.context.FacesContext context)
Restore state information for the given child component.
component
- context
- protected void saveChildrenState(javax.faces.context.FacesContext context)
Save state information for all children of this component.
context
- protected void saveChild(javax.faces.component.UIComponent component, javax.faces.context.FacesContext context)
Save state information for the given child component.
component
- context
- protected void saveChildState(javax.faces.component.UIComponent component, javax.faces.context.FacesContext context)
Save state information for the given child component and its children.
component
- context
- public boolean invokeOnComponent(javax.faces.context.FacesContext context, java.lang.String clientId, javax.faces.component.ContextCallback callback) throws javax.faces.FacesException
invokeOnComponent
in class javax.faces.component.UIComponentBase
javax.faces.FacesException
public boolean visitTree(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback)
visitTree
in class javax.faces.component.UIComponent
public boolean isKeyboardNavigationEnabled()
public void setKeyboardNavigationEnabled(boolean keyboardNavigationEnabled)
|
ICEfaces ICE Components 3.3.0 Java API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |