Class UITreeListbox
- 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.internal.component.AbstractUITreeListbox
-
- org.apache.myfaces.tobago.component.UITreeListbox
-
- 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 UITreeListbox extends AbstractUITreeListbox implements jakarta.faces.component.behavior.ClientBehaviorHolder
A tree data structure displayed as a set of list boxes. UIComponent class, generated from templatecomponent.stg
with classTreeListboxTagDeclaration
.
-
-
Field Summary
Fields Modifier and Type Field Description static String
COMPONENT_FAMILY
static String
COMPONENT_TYPE
-
Fields inherited from class org.apache.myfaces.tobago.internal.component.AbstractUITree
SUFFIX_PARENT
-
Fields inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIData
SUFFIX_EXPANDED, SUFFIX_MARKED, SUFFIX_SELECTED
-
-
Constructor Summary
Constructors Constructor Description UITreeListbox()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CustomClass
getCustomClass()
Sets a CSS class in its parent, if the parent supports it.String
getFamily()
Markup
getMarkup()
Selectable
getSelectable()
Flag indicating whether or not this component should be render selectable items.Integer
getSize()
The number of the shown rows in the element.boolean
isRequired()
Flag indicating that a value is required.void
restoreState(jakarta.faces.context.FacesContext context, Object state)
void
setCustomClass(CustomClass customClass)
void
setMarkup(Markup markup)
void
setRequired(boolean required)
void
setSelectable(Selectable selectable)
void
setSize(Integer size)
-
Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUITreeListbox
isShowRoot
-
Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUITree
getBaseClientId, getExpandedState, getRendersChildren, getSelectedState, getState, processDecodes, processUpdates, processValidators, saveState, setState
-
Methods 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, isShowRootJunction, isTreeModel, stripRowIndex, visitTree
-
Methods 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, setVar
-
Methods 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, setTransient
-
Methods 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, unsubscribeFromEvent
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface jakarta.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames
-
Methods inherited from interface org.apache.myfaces.tobago.component.Visual
getRendererType, isPlain
-
-
-
-
Field Detail
-
COMPONENT_TYPE
public static final String COMPONENT_TYPE
-
COMPONENT_FAMILY
public static final String COMPONENT_FAMILY
- See Also:
- Constant Field Values
-
-
Method Detail
-
getFamily
public String getFamily()
- Overrides:
getFamily
in classjakarta.faces.component.UIData
-
getSize
public Integer getSize()
The number of the shown rows in the element. E. g. the size attribute of the select element in HTML.- Specified by:
getSize
in classAbstractUITreeListbox
-
setSize
public void setSize(Integer size)
-
getSelectable
public Selectable getSelectable()
Flag indicating whether or not this component should be render selectable items. Possible values are:- 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:single
Allowed Values:single,multiLeafOnly,singleLeafOnly
- Specified by:
getSelectable
in classAbstractUIData
-
setSelectable
public void setSelectable(Selectable selectable)
-
getCustomClass
public CustomClass 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:
getCustomClass
in interfaceVisual
-
setCustomClass
public void setCustomClass(CustomClass customClass)
- Specified by:
setCustomClass
in interfaceVisual
-
isRequired
public boolean isRequired()
Flag indicating that a value is required. If the value is an empty string a ValidationError occurs and a Error Message is rendered.
Default:false
-
setRequired
public void setRequired(boolean required)
-
restoreState
public void restoreState(jakarta.faces.context.FacesContext context, Object state)
- Specified by:
restoreState
in interfacejakarta.faces.component.StateHolder
- Overrides:
restoreState
in classAbstractUITree
-
-