Package org.apache.myfaces.tobago.component

Class UISelectOneListbox

    • Field Summary

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

      • Fields inherited from class jakarta.faces.component.UISelectOne

        INVALID_MESSAGE_ID

      • Fields inherited from class jakarta.faces.component.UIInput

        ALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUE, CONVERSION_MESSAGE_ID, EMPTY_STRING_AS_NULL_PARAM_NAME, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME

      • Fields 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_KEY

    • 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 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 getSize()
      The number of the shown rows in the element.
      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 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 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 setSize​(Integer size)  
      void setTabIndex​(Integer tabIndex)  
      void setTip​(String tip)  

      • 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 interface jakarta.faces.component.behavior.ClientBehaviorHolder

        addClientBehavior, getClientBehaviors

      • Methods inherited from interface jakarta.faces.component.ValueHolder

        getConverter, getLocalValue, setConverter

    • Constructor Detail

      • UISelectOneListbox

        public UISelectOneListbox()

    • Method Detail

      • getEventNames

        public Collection<String> getEventNames()
        Specified by:
        getEventNames in interface jakarta.faces.component.behavior.ClientBehaviorHolder
        Overrides:
        getEventNames in class jakarta.faces.component.UIComponentBase

      • getDefaultEventName

        public String getDefaultEventName()
        Specified by:
        getDefaultEventName in interface jakarta.faces.component.behavior.ClientBehaviorHolder
        Overrides:
        getDefaultEventName in class jakarta.faces.component.UIComponentBase

      • getFamily

        public String getFamily()
        Overrides:
        getFamily in class jakarta.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 class AbstractUISelectOneBase

      • 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 class AbstractUISelectOneBase

      • setTabIndex

        public void setTabIndex​(Integer tabIndex)

      • getLabel

        public String getLabel()
        A localized user presentable label for this component.

      • setLabel

        public void setLabel​(String label)

      • 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)

      • isReadonly

        public boolean isReadonly()
        Flag indicating that this component will prohibit changes by the user.
        Default: false
        Specified by:
        isReadonly in class AbstractUISelectOneBase

      • setReadonly

        public void setReadonly​(boolean readonly)

      • setSize

        public void setSize​(Integer size)

      • getHelpPosition

        public DecorationPosition getHelpPosition()
        Defines the position and the appearance of a help message on a component. The default is popoverRight.

      • 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)

      • 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 interface jakarta.faces.component.StateHolder
        Overrides:
        restoreState in class jakarta.faces.component.UIInput