Class UISelectOneList
- java.lang.Object
-
- jakarta.faces.component.UIComponent
-
- jakarta.faces.component.UIComponentBase
-
- jakarta.faces.component.UIOutput
-
- jakarta.faces.component.UIInput
-
- jakarta.faces.component.UISelectOne
-
- org.apache.myfaces.tobago.internal.component.AbstractUISelectOneBase
-
- org.apache.myfaces.tobago.internal.component.AbstractUISelectOneList
-
- org.apache.myfaces.tobago.component.UISelectOneList
-
- All Implemented Interfaces:
jakarta.faces.component.behavior.ClientBehaviorHolder
,jakarta.faces.component.EditableValueHolder
,jakarta.faces.component.PartialStateHolder
,jakarta.faces.component.StateHolder
,jakarta.faces.component.TransientStateHolder
,jakarta.faces.component.ValueHolder
,jakarta.faces.event.ComponentSystemEventListener
,jakarta.faces.event.FacesListener
,jakarta.faces.event.SystemEventListenerHolder
,EventListener
,SupportFieldId
,SupportsAutoSpacing
,SupportsDecorationPosition
,SupportsHelp
,SupportsLabelLayout
,Visual
@Generated("component.stg") public class UISelectOneList extends AbstractUISelectOneList
Render a single selection option list. UIComponent class, generated from templatecomponent.stg
with classSelectOneListTagDeclaration
.
-
-
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.AbstractUISelectOneBase
MESSAGE_VALUE_REQUIRED
-
-
Constructor Summary
Constructors Constructor Description UISelectOneList()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Boolean
getAutoSpacing()
Automatically add spacing (margins/paddings) to the component for better positioning.CustomClass
getCustomClass()
Sets a CSS class in its parent, if the parent supports it.String
getDefaultEventName()
Collection<String>
getEventNames()
String
getFamily()
String
getFilter()
The name of the current filter.String
getHelp()
Text value to display as a help.DecorationPosition
getHelpPosition()
Defines the position and the appearance of a help message on a component.String
getLabel()
A localized user presentable label for this component.LabelLayout
getLabelLayout()
Defines the position of the label relative to the field.Markup
getMarkup()
DecorationPosition
getMessagePosition()
Defines the position and the appearance of additional faces messages (like error message or help message) on a component.Integer
getTabIndex()
Controls the navigation of the focus through the input controls on a page with the Tab-Key.String
getTip()
Text value to display as tooltip.boolean
isDisabled()
Flag indicating that this element is disabled.boolean
isExpanded()
Flag indicating this component should rendered as an expanded element.boolean
isFocus()
Flag indicating this component should receive the focus.boolean
isReadonly()
Flag indicating that this component will prohibit changes by the user.void
restoreState(jakarta.faces.context.FacesContext context, Object state)
void
setAutoSpacing(Boolean autoSpacing)
void
setCustomClass(CustomClass customClass)
void
setDisabled(boolean disabled)
void
setExpanded(boolean expanded)
void
setFilter(String filter)
void
setFocus(boolean focus)
void
setHelp(String help)
void
setHelpPosition(DecorationPosition helpPosition)
void
setLabel(String label)
void
setLabelLayout(LabelLayout labelLayout)
void
setMarkup(Markup markup)
void
setMessagePosition(DecorationPosition messagePosition)
void
setReadonly(boolean readonly)
void
setTabIndex(Integer tabIndex)
void
setTip(String tip)
-
Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUISelectOneList
getFieldId
-
Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUISelectOneBase
isError, isNextToRenderIsLabel, setNextToRenderIsLabel, validate
-
Methods inherited from class jakarta.faces.component.UISelectOne
getGroup, processValidators, setGroup, validateValue
-
Methods inherited from class jakarta.faces.component.UIInput
addValidator, addValueChangeListener, broadcast, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidatorMessage, getValidators, getValue, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, removeValidator, removeValueChangeListener, resetValue, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidatorMessage, setValue, updateModel
-
Methods inherited from class jakarta.faces.component.UIOutput
getConverter, getLocalValue, setConverter
-
Methods inherited from class jakarta.faces.component.UIComponentBase
addClientBehavior, addFacesListener, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, visitTree
-
Methods inherited from class jakarta.faces.component.UIComponent
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, 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 jakarta.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors
-
Methods inherited from interface org.apache.myfaces.tobago.component.SupportsAutoSpacing
getAutoSpacing
-
Methods inherited from interface jakarta.faces.component.ValueHolder
getConverter, getLocalValue, setConverter
-
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
-
getEventNames
public Collection<String> getEventNames()
- Specified by:
getEventNames
in interfacejakarta.faces.component.behavior.ClientBehaviorHolder
- Overrides:
getEventNames
in classjakarta.faces.component.UIComponentBase
-
getDefaultEventName
public String getDefaultEventName()
- Specified by:
getDefaultEventName
in interfacejakarta.faces.component.behavior.ClientBehaviorHolder
- Overrides:
getDefaultEventName
in classjakarta.faces.component.UIComponentBase
-
getFamily
public String getFamily()
- Overrides:
getFamily
in classjakarta.faces.component.UISelectOne
-
getMarkup
public Markup getMarkup()
-
setMarkup
public void setMarkup(Markup markup)
-
getLabelLayout
public LabelLayout getLabelLayout()
Defines the position of the label relative to the field. The default is flexLeft, if the label is set, or none, if the label isn't set. Set to 'skip' to avoid surrounding label container. Hint for tc:out: set also compact=true to render only text (without html tags).
-
setLabelLayout
public void setLabelLayout(LabelLayout labelLayout)
-
getMessagePosition
public DecorationPosition getMessagePosition()
Defines the position and the appearance of additional faces messages (like error message or help message) on a component. The default is popoverRight.
-
setMessagePosition
public void setMessagePosition(DecorationPosition messagePosition)
-
isFocus
public boolean isFocus()
Flag indicating this component should receive the focus.
Default:false
- Specified by:
isFocus
in classAbstractUISelectOneBase
-
setFocus
public void setFocus(boolean focus)
-
getTabIndex
public Integer getTabIndex()
Controls the navigation of the focus through the input controls on a page with the Tab-Key. The navigation starts from the element with the lowest tabIndex value to the element with the highest value. Elements that have identical tabIndex values should be navigated in the order they appear in the character stream Elements that are disabled or with a negative tabIndex do not participate in the tabbing order.- Specified by:
getTabIndex
in classAbstractUISelectOneBase
-
setTabIndex
public void setTabIndex(Integer tabIndex)
-
getLabel
public String getLabel()
A localized user presentable label for this component.
-
setLabel
public void setLabel(String label)
-
getFilter
public String getFilter()
The name of the current filter. There are some predefined filters: contains, startsWith, containsExact, startsWithExact The TobagoFilterRegistry (tobago-filter-registry.ts) can be used to add a custom filter.- Specified by:
getFilter
in classAbstractUISelectOneList
-
setFilter
public void setFilter(String filter)
-
getHelp
public String getHelp()
Text value to display as a help.
-
setHelp
public void setHelp(String help)
-
getAutoSpacing
public Boolean getAutoSpacing()
Automatically add spacing (margins/paddings) to the component for better positioning. Default is 'true' except the component is inside a: - header - footer - bar - sheet - tree - link group - button group - before facet - after facet - label facet - bar facet
-
setAutoSpacing
public void setAutoSpacing(Boolean autoSpacing)
-
isExpanded
public boolean isExpanded()
Flag indicating this component should rendered as an expanded element.
Default:false
- Specified by:
isExpanded
in classAbstractUISelectOneList
-
setExpanded
public void setExpanded(boolean expanded)
-
isReadonly
public boolean isReadonly()
Flag indicating that this component will prohibit changes by the user.
Default:false
- Specified by:
isReadonly
in classAbstractUISelectOneBase
-
setReadonly
public void setReadonly(boolean readonly)
-
getHelpPosition
public DecorationPosition getHelpPosition()
Defines the position and the appearance of a help message on a component. The default is popoverRight.
-
setHelpPosition
public void setHelpPosition(DecorationPosition helpPosition)
-
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.
-
setCustomClass
public void setCustomClass(CustomClass customClass)
-
isDisabled
public boolean isDisabled()
Flag indicating that this element is disabled.
Default:false
- Specified by:
isDisabled
in classAbstractUISelectOneBase
-
setDisabled
public void setDisabled(boolean disabled)
-
getTip
public String getTip()
Text value to display as tooltip.
-
setTip
public void setTip(String tip)
-
restoreState
public void restoreState(jakarta.faces.context.FacesContext context, Object state)
- Specified by:
restoreState
in interfacejakarta.faces.component.StateHolder
- Overrides:
restoreState
in classjakarta.faces.component.UIInput
-
-