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 template
component.stg with class
TreeListboxTagDeclaration.-
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.getSize()The number of the shown rows in the element.booleanFlag indicating that a value is required.voidrestoreState(jakarta.faces.context.FacesContext context, Object state) voidsetCustomClass(CustomClass customClass) voidvoidsetRequired(boolean required) voidsetSelectable(Selectable selectable) voidMethods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUITreeListbox
isShowRootMethods 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, isShowRootJunction, 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
-
UITreeListbox
public UITreeListbox()
-
-
Method Details
-
getFamily
- Overrides:
getFamilyin classjakarta.faces.component.UIData
-
getMarkup
-
setMarkup
-
getSize
The number of the shown rows in the element. E. g. the size attribute of the select element in HTML.- Specified by:
getSizein classAbstractUITreeListbox
-
setSize
-
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:
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
-
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
- Specified by:
restoreStatein interfacejakarta.faces.component.StateHolder- Overrides:
restoreStatein classAbstractUITree
-