org.apache.myfaces.tobago.component

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.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

public class UITreeListbox
extends AbstractUITreeListbox
implements Visual

A tree data structure displayed as a set of list boxes. UIComponent class, generated from template component.stg with class TreeListboxTagDeclaration.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE

Fields 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

Constructor and Description
UITreeListbox()

Method Summary

Modifier and Type	Method and 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.
Style	getStyle() For internal use.
boolean	isRequired() Flag indicating that a value is required.
void	setCustomClass(CustomClass customClass)
void	setMarkup(Markup markup)
void	setRequired(boolean required)
void	setSelectable(Selectable selectable)
void	setSize(Integer size)
void	setStyle(Style style)

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, restoreState, saveState, setState

Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIData

createTreeDataModel, encodeBegin, getDataModel, getPath, getRowClientId, getRowIndicesOfChildren, getRowParentClientId, getSelectableAsEnum, getTreeDataModel, hasRows, 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 org.apache.myfaces.tobago.component.Visual

getRendererType

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

UITreeListbox

public UITreeListbox()

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UIData

getMarkup

public Markup getMarkup()

Specified by:

getMarkup in interface Visual

setMarkup

public void setMarkup(Markup markup)

Specified by:

setMarkup in interface Visual

getSize

public Integer getSize()

The number of the shown rows in the element. E. g. the size attribute of the select element in HTML.

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 class AbstractUIData

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 interface Visual

setCustomClass

public void setCustomClass(CustomClass customClass)

Specified by:

setCustomClass in interface Visual

getStyle

public Style getStyle()

For internal use. Used for rendering, if there is a child tag <tc:style>

Specified by:

getStyle in interface Visual

setStyle

public void setStyle(Style style)

Specified by:

setStyle in interface Visual

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)