Class UITree
java.lang.Object
jakarta.faces.component.UIComponent
jakarta.faces.component.UIComponentBase
jakarta.faces.component.UIData
org.apache.myfaces.tobago.internal.component.AbstractUIData
org.apache.myfaces.tobago.internal.component.AbstractUITree
org.apache.myfaces.tobago.component.UITree
- All Implemented Interfaces:
jakarta.faces.component.behavior.ClientBehaviorHolder,jakarta.faces.component.NamingContainer,jakarta.faces.component.PartialStateHolder,jakarta.faces.component.StateHolder,jakarta.faces.component.TransientStateHolder,jakarta.faces.component.UniqueIdVendor,jakarta.faces.event.ComponentSystemEventListener,jakarta.faces.event.FacesListener,jakarta.faces.event.SystemEventListenerHolder,EventListener,Visual
@Generated("component.stg")
public class UITree
extends AbstractUITree
implements jakarta.faces.component.behavior.ClientBehaviorHolder
A tree with classical look.
Usually used with icons and junction lines to open folder, etc.
UIComponent class, generated from template
component.stg with class
TreeTagDeclaration.-
Field Summary
FieldsFields inherited from class org.apache.myfaces.tobago.internal.component.AbstractUITree
SUFFIX_PARENTFields inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIData
SUFFIX_EXPANDED, SUFFIX_MARKED, SUFFIX_SELECTEDFields inherited from class jakarta.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEYFields inherited from interface jakarta.faces.component.NamingContainer
SEPARATOR_CHAR -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionSets a CSS class in its parent, if the parent supports it.Flag indicating whether or not this component should be render selectable items.booleanOnly applicable in the case that the data model is a tree.booleanOnly applicable in the case that the data model is a tree.voidrestoreState(jakarta.faces.context.FacesContext context, Object state) voidsetCustomClass(CustomClass customClass) voidvoidsetSelectable(Selectable selectable) voidsetShowRoot(boolean showRoot) voidsetShowRootJunction(boolean showRootJunction) Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUITree
getBaseClientId, getExpandedState, getRendersChildren, getSelectedState, getState, processDecodes, processUpdates, processValidators, saveState, setStateMethods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIData
createTreeDataModel, encodeBegin, findComponent, getDataModel, getPath, getRowClientId, getRowIndicesOfChildren, getRowParentClientId, getSelectableAsEnum, getTreeDataModel, invokeOnComponent, isFolder, isRendersRowContainer, isRowsUnlimited, isRowVisible, isTreeModel, stripRowIndex, visitTreeMethods inherited from class jakarta.faces.component.UIData
broadcast, createUniqueId, encodeEnd, getContainerClientId, getFirst, getFooter, getHeader, getRowCount, getRowData, getRowIndex, getRows, getValue, getVar, isRowAvailable, isRowStatePreserved, markInitialState, queueEvent, setDataModel, setFirst, setFooter, setHeader, setRowIndex, setRows, setRowStatePreserved, setValue, setValueExpression, setVarMethods inherited from class jakarta.faces.component.UIComponentBase
addClientBehavior, addFacesListener, clearInitialState, decode, encodeAll, encodeChildren, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransientMethods inherited from class jakarta.faces.component.UIComponent
getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, subscribeToEvent, unsubscribeFromEventMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface jakarta.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNamesMethods inherited from interface org.apache.myfaces.tobago.component.Visual
getRendererType, isPlain
-
Field Details
-
COMPONENT_TYPE
-
COMPONENT_FAMILY
- See Also:
-
-
Constructor Details
-
UITree
public UITree()
-
-
Method Details
-
getFamily
- Overrides:
getFamilyin classjakarta.faces.component.UIData
-
isShowRoot
public boolean isShowRoot()Only applicable in the case that the data model is a tree. This flag indicates that the root node should be displayed. Often in tree structures the root node is special and should not be displayed.
Default:false- Specified by:
isShowRootin classAbstractUIData
-
setShowRoot
public void setShowRoot(boolean showRoot) -
getMarkup
-
setMarkup
-
isShowRootJunction
public boolean isShowRootJunction()Only applicable in the case that the data model is a tree. This flag indicates that the root node should be displayed with an open-close-switch.
Default:false- Overrides:
isShowRootJunctionin classAbstractUIData
-
setShowRootJunction
public void setShowRootJunction(boolean showRootJunction) -
getSelectable
Flag indicating whether or not this component should be render selectable items. Possible values are:- none : not selectable
- multi : a multi section tree is rendered
- single : a single section tree is rendered
- multiLeafOnly : a multi section tree is rendered, only leaf's are selectable
- singleLeafOnly : a single section tree is rendered, only leaf's are selectable
Default:multi
Allowed Values:none,multi,single,multiLeafOnly,singleLeafOnly- Specified by:
getSelectablein classAbstractUIData
-
setSelectable
-
getCustomClass
Sets a CSS class in its parent, if the parent supports it. Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example:<tc:in> <tc:style customClass="my-emphasized"/> </tc:in>One capability is, to used external CSS libs.
This feature should not be used imprudent. Because it might be unstable against changes in the renderered HTML code.- Specified by:
getCustomClassin interfaceVisual
-
setCustomClass
- Specified by:
setCustomClassin interfaceVisual
-
restoreState
- Specified by:
restoreStatein interfacejakarta.faces.component.StateHolder- Overrides:
restoreStatein classAbstractUITree
-