Class UITreeListbox
java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.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:
EventListener
,javax.faces.component.behavior.ClientBehaviorHolder
,javax.faces.component.NamingContainer
,javax.faces.component.PartialStateHolder
,javax.faces.component.StateHolder
,javax.faces.component.UniqueIdVendor
,javax.faces.event.ComponentSystemEventListener
,javax.faces.event.FacesListener
,javax.faces.event.SystemEventListenerHolder
,Visual
@Generated("component.stg")
public class UITreeListbox
extends AbstractUITreeListbox
implements javax.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
MARKED, MESSAGE_NOT_LEAF, SELECT_STATE, SEP
Fields inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIData
SUFFIX_EXPANDED, SUFFIX_MARKED, SUFFIX_SELECTED
Fields inherited from class javax.faces.component.UIComponent
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY
Fields inherited from interface javax.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.boolean
Flag indicating that a value is required.void
restoreState
(javax.faces.context.FacesContext context, Object state) void
setCustomClass
(CustomClass customClass) void
void
setRequired
(boolean required) void
setSelectable
(Selectable selectable) void
Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUITreeListbox
isShowRoot
Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUITree
getExpandedState, getRendersChildren, getRoot, getSelectedState, getState, processDecodes, processUpdates, processValidators, saveState, setState
Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIData
createTreeDataModel, encodeBegin, getDataModel, getPath, getRowClientId, getRowIndicesOfChildren, getRowParentClientId, getSelectableAsEnum, getTreeDataModel, invokeOnComponent, isFolder, isRendersRowContainer, isRowsUnlimited, isRowVisible, isShowRootJunction, isTreeModel, visitTree
Methods inherited from class javax.faces.component.UIData
broadcast, createUniqueId, encodeEnd, getContainerClientId, getFirst, getFooter, getHeader, getRowCount, getRowData, getRowIndex, getRows, getValue, getVar, isRowAvailable, queueEvent, setDataModel, setFirst, setFooter, setHeader, setRowIndex, setRows, setValue, setValueExpression, setVar
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, clearInitialState, decode, encodeAll, encodeChildren, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getValueBinding, initialStateMarked, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
Methods inherited from class javax.faces.component.UIComponent
getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, 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 javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames
Methods 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:
getFamily
in classjavax.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:
getSize
in 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:
getSelectable
in 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:
getCustomClass
in interfaceVisual
-
setCustomClass
- 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
- Specified by:
restoreState
in interfacejavax.faces.component.StateHolder
- Overrides:
restoreState
in classAbstractUITree
-