org.apache.myfaces.tobago.component

Class UISelectItem

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UISelectItem

org.apache.myfaces.tobago.internal.component.AbstractUISelectItem

org.apache.myfaces.tobago.component.UISelectItem

All Implemented Interfaces:

EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, Visual

public class UISelectItem
extends AbstractUISelectItem
implements Visual

Add a child UISelectItem component to the UIComponent associated with the closed parent UIComponent custom action. UIComponent class, generated from template component.stg with class SelectItemTagDeclaration.

Field Summary

Fields

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

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

Constructor Summary

Constructors

Constructor and Description
UISelectItem()

Method Summary

Modifier and Type	Method and Description
CustomClass	getCustomClass() Sets a CSS class in its parent, if the parent supports it.
String	getFamily()
String	getItemImage() Image to be displayed to the user for this option.
Markup	getMarkup()
Style	getStyle() For internal use.
String	getTip() Text value to display as tooltip.
void	setCustomClass(CustomClass customClass)
void	setItemImage(String itemImage)
void	setMarkup(Markup markup)
void	setStyle(Style style)
void	setTip(String tip)

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

getItemValue, setItemValue

Methods inherited from class javax.faces.component.UISelectItem

getFacesContext, getItemDescription, getItemLabel, getValue, isItemDisabled, isItemEscaped, isNoSelectionOption, setItemDescription, setItemDisabled, setItemEscaped, setItemLabel, setNoSelectionOption, setRendered, setValue

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendererType, setTransient, setValueBinding, visitTree

Methods inherited from class javax.faces.component.UIComponent

getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, 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

UISelectItem

public UISelectItem()

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UISelectItem

getMarkup

public Markup getMarkup()

Specified by:

getMarkup in interface Visual

setMarkup

public void setMarkup(Markup markup)

Specified by:

setMarkup in interface Visual

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

getTip

public String getTip()

Text value to display as tooltip.

setTip

public void setTip(String tip)

getItemImage

public String getItemImage()

Image to be displayed to the user for this option.

setItemImage

public void setItemImage(String itemImage)