Class UISelectManyList

java.lang.Object
org.apache.myfaces.tobago.internal.component.AbstractUISelectManyBase
org.apache.myfaces.tobago.internal.component.AbstractUISelectManyList
org.apache.myfaces.tobago.component.UISelectManyList
All Implemented Interfaces:
EventListener, SupportFieldId, SupportsAutoSpacing, SupportsDecorationPosition, SupportsFilter, SupportsHelp, SupportsLabelLayout, Visual
@Generated("component.stg") public class UISelectManyList extends AbstractUISelectManyList
Render a multi selection option list. UIComponent class, generated from template component.stg with class SelectManyListTagDeclaration.

  • Field Details

  • Constructor Details

    • UISelectManyList

      public UISelectManyList()

  • Method Details

    • getEventNames

      public Collection<String> getEventNames()

    • getDefaultEventName

      public String getDefaultEventName()

    • getFamily

      public String getFamily()

    • getFooter

      public String getFooter()
      Replace the no-entries footer at the end of the result list with a custom footer. The text in the custom footer is set by this attribute. If the string is empty, the footer is hidden.
      Specified by:
      getFooter in class AbstractUISelectManyList

    • setFooter

      public void setFooter(String footer)

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

    • isFocus

      public boolean isFocus()
      Flag indicating this component should receive the focus.
      Default: false
      Specified by:
      isFocus in class AbstractUISelectManyBase

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

    • setTabIndex

      public void setTabIndex(Integer tabIndex)

    • isLocalMenu

      public boolean isLocalMenu()

      By default, dropdown menus are rendered in the '.tobago-page-menuStore'. If localMenu=true, the dropdown menu is rendered on the component.


      Default: false
      Specified by:
      isLocalMenu in class AbstractUISelectManyList

    • setLocalMenu

      public void setLocalMenu(boolean localMenu)

    • isExpanded

      public boolean isExpanded()
      Flag indicating this component should rendered as an expanded element.
      Default: false
      Specified by:
      isExpanded in class AbstractUISelectManyList

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

    • setReadonly

      public void setReadonly(boolean readonly)

    • isDisabled

      public boolean isDisabled()
      Flag indicating that this element is disabled.
      Default: false
      Specified by:
      isDisabled in class AbstractUISelectManyBase

    • setDisabled

      public void setDisabled(boolean disabled)

    • getTip

      public String getTip()
      Text value to display as tooltip.

    • setTip

      public void setTip(String tip)

    • getMarkup

      public Markup getMarkup()

    • setMarkup

      public void setMarkup(Markup markup)

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

    • 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 interface SupportsFilter
      Specified by:
      getFilter in class AbstractUISelectManyList

    • 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 - popover - link group - button group - before facet - after facet - label facet - bar facet

    • setAutoSpacing

      public void setAutoSpacing(Boolean autoSpacing)

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

    • restoreState

      public void restoreState(jakarta.faces.context.FacesContext context, Object state)

    • addClientBehavior

      void addClientBehavior(String arg0, jakarta.faces.component.behavior.ClientBehavior arg1)

    • getClientBehaviors

      Map<String, List<jakarta.faces.component.behavior.ClientBehavior>> getClientBehaviors()

    • setSelectedValues

      public void setSelectedValues(Object[] arg0)

    • getValueExpression

      public jakarta.el.ValueExpression getValueExpression(String arg0)

    • setValueExpression

      public void setValueExpression(String arg0, jakarta.el.ValueExpression arg1)

    • compareValues

      protected boolean compareValues(Object arg0, Object arg1)

    • validateValue

      protected void validateValue(jakarta.faces.context.FacesContext arg0, Object arg1)

    • getConvertedValue

      protected Object getConvertedValue(jakarta.faces.context.FacesContext arg0, Object arg1) throws jakarta.faces.convert.ConverterException
      Throws:
      jakarta.faces.convert.ConverterException

    • setValue

      public void setValue(Object arg0)

    • getValue

      public Object getValue()

    • processDecodes

      public void processDecodes(jakarta.faces.context.FacesContext arg0)

    • processValidators

      public void processValidators(jakarta.faces.context.FacesContext arg0)

    • processUpdates

      public void processUpdates(jakarta.faces.context.FacesContext arg0)

    • decode

      public void decode(jakarta.faces.context.FacesContext arg0)

    • broadcast

      public void broadcast(jakarta.faces.event.FacesEvent arg0) throws jakarta.faces.event.AbortProcessingException
      Throws:
      jakarta.faces.event.AbortProcessingException

    • updateModel

      public void updateModel(jakarta.faces.context.FacesContext arg0)

    • validate

      public void validate(jakarta.faces.context.FacesContext arg0)

    • resetValue

      public void resetValue()

    • isImmediate

      public boolean isImmediate()

    • setImmediate

      public void setImmediate(boolean arg0)

    • isRequired

      public boolean isRequired()

    • setRequired

      public void setRequired(boolean arg0)

    • getConverterMessage

      public String getConverterMessage()

    • setConverterMessage

      public void setConverterMessage(String arg0)

    • getRequiredMessage

      public String getRequiredMessage()

    • setRequiredMessage

      public void setRequiredMessage(String arg0)

    • addValidator

      public void addValidator(jakarta.faces.validator.Validator arg0)

    • removeValidator

      public void removeValidator(jakarta.faces.validator.Validator arg0)

    • getValidators

      public jakarta.faces.validator.Validator[] getValidators()

    • getValidatorMessage

      public String getValidatorMessage()

    • setValidatorMessage

      public void setValidatorMessage(String arg0)

    • isValid

      public boolean isValid()

    • setValid

      public void setValid(boolean arg0)

    • isLocalValueSet

      public boolean isLocalValueSet()

    • setLocalValueSet

      public void setLocalValueSet(boolean arg0)

    • getSubmittedValue

      public Object getSubmittedValue()

    • setSubmittedValue

      public void setSubmittedValue(Object arg0)

    • addValueChangeListener

      public void addValueChangeListener(jakarta.faces.event.ValueChangeListener arg0)

    • removeValueChangeListener

      public void removeValueChangeListener(jakarta.faces.event.ValueChangeListener arg0)

    • getValueChangeListeners

      public jakarta.faces.event.ValueChangeListener[] getValueChangeListeners()

    • markInitialState

      public void markInitialState()

    • clearInitialState

      public void clearInitialState()

    • saveState

      public Object saveState(jakarta.faces.context.FacesContext arg0)

    • isEmpty

      public static boolean isEmpty(Object arg0)

    • getLocalValue

      Object getLocalValue()

    • getConverter

      jakarta.faces.convert.Converter getConverter()

    • setConverter

      void setConverter(jakarta.faces.convert.Converter arg0)

    • getLocalValue

      public Object getLocalValue()

    • getConverter

      public jakarta.faces.convert.Converter getConverter()

    • setConverter

      public void setConverter(jakarta.faces.convert.Converter arg0)

    • setId

      public void setId(String arg0)

    • setParent

      public void setParent(jakarta.faces.component.UIComponent arg0)

    • addClientBehavior

      public void addClientBehavior(String arg0, jakarta.faces.component.behavior.ClientBehavior arg1)

    • encodeAll

      public void encodeAll(jakarta.faces.context.FacesContext arg0) throws IOException
      Throws:
      IOException

    • encodeBegin

      public void encodeBegin(jakarta.faces.context.FacesContext arg0) throws IOException
      Throws:
      IOException

    • encodeChildren

      public void encodeChildren(jakarta.faces.context.FacesContext arg0) throws IOException
      Throws:
      IOException

    • encodeEnd

      public void encodeEnd(jakarta.faces.context.FacesContext arg0) throws IOException
      Throws:
      IOException

    • findComponent

      public jakarta.faces.component.UIComponent findComponent(String arg0)

    • getAttributes

      public Map<String,Object> getAttributes()

    • getPassThroughAttributes

      public Map<String,Object> getPassThroughAttributes(boolean arg0)

    • getChildCount

      public int getChildCount()

    • getChildren

      public List<jakarta.faces.component.UIComponent> getChildren()

    • getClientBehaviors

      public Map<String, List<jakarta.faces.component.behavior.ClientBehavior>> getClientBehaviors()

    • getClientId

      public String getClientId(jakarta.faces.context.FacesContext arg0)

    • getFacet

      public jakarta.faces.component.UIComponent getFacet(String arg0)

    • getFacetCount

      public int getFacetCount()

    • getFacets

      public Map<String, jakarta.faces.component.UIComponent> getFacets()

    • getFacetsAndChildren

      public Iterator<jakarta.faces.component.UIComponent> getFacetsAndChildren()

    • getId

      public String getId()

    • getParent

      public jakarta.faces.component.UIComponent getParent()

    • getRendererType

      public String getRendererType()

    • getRendersChildren

      public boolean getRendersChildren()

    • invokeOnComponent

      public boolean invokeOnComponent(jakarta.faces.context.FacesContext arg0, String arg1, jakarta.faces.component.ContextCallback arg2) throws jakarta.faces.FacesException
      Throws:
      jakarta.faces.FacesException

    • visitTree

      public boolean visitTree(jakarta.faces.component.visit.VisitContext arg0, jakarta.faces.component.visit.VisitCallback arg1)

    • isRendered

      public boolean isRendered()

    • isTransient

      public boolean isTransient()

    • addFacesListener

      protected void addFacesListener(jakarta.faces.event.FacesListener arg0)

    • getFacesContext

      protected jakarta.faces.context.FacesContext getFacesContext()

    • getFacesListeners

      protected jakarta.faces.event.FacesListener[] getFacesListeners(Class arg0)

    • getRenderer

      protected jakarta.faces.render.Renderer getRenderer(jakarta.faces.context.FacesContext arg0)

    • removeFacesListener

      protected void removeFacesListener(jakarta.faces.event.FacesListener arg0)

    • queueEvent

      public void queueEvent(jakarta.faces.event.FacesEvent arg0)

    • processSaveState

      public Object processSaveState(jakarta.faces.context.FacesContext arg0)

    • processRestoreState

      public void processRestoreState(jakarta.faces.context.FacesContext arg0, Object arg1)

    • setTransient

      public void setTransient(boolean arg0)

    • saveAttachedState

      public static Object saveAttachedState(jakarta.faces.context.FacesContext arg0, Object arg1)

    • restoreAttachedState

      public static Object restoreAttachedState(jakarta.faces.context.FacesContext arg0, Object arg1) throws IllegalStateException
      Throws:
      IllegalStateException

    • setRendered

      public void setRendered(boolean arg0)

    • setRendererType

      public void setRendererType(String arg0)

    • getPassThroughAttributes

      public Map<String,Object> getPassThroughAttributes()

    • initialStateMarked

      public boolean initialStateMarked()

    • isCompositeComponent

      public static boolean isCompositeComponent(jakarta.faces.component.UIComponent arg0)

    • isInView

      public boolean isInView()

    • isVisitable

      protected boolean isVisitable(jakarta.faces.component.visit.VisitContext arg0)

    • getClientId

      public String getClientId()

    • getCompositeComponentParent

      public static jakarta.faces.component.UIComponent getCompositeComponentParent(jakarta.faces.component.UIComponent arg0)

    • getContainerClientId

      public String getContainerClientId(jakarta.faces.context.FacesContext arg0)

    • getCurrentComponent

      public static jakarta.faces.component.UIComponent getCurrentComponent(jakarta.faces.context.FacesContext arg0)

    • getCurrentCompositeComponent

      public static jakarta.faces.component.UIComponent getCurrentCompositeComponent(jakarta.faces.context.FacesContext arg0)

    • getListenersForEventClass

      public List<jakarta.faces.event.SystemEventListener> getListenersForEventClass(Class<? extends jakarta.faces.event.SystemEvent> arg0)

    • getNamingContainer

      public jakarta.faces.component.UIComponent getNamingContainer()

    • setInView

      public void setInView(boolean arg0)

    • getResourceBundleMap

      public Map<String,String> getResourceBundleMap()

    • processEvent

      public void processEvent(jakarta.faces.event.ComponentSystemEvent arg0) throws jakarta.faces.event.AbortProcessingException
      Throws:
      jakarta.faces.event.AbortProcessingException

    • subscribeToEvent

      public void subscribeToEvent(Class<? extends jakarta.faces.event.SystemEvent> arg0, jakarta.faces.event.ComponentSystemEventListener arg1)

    • unsubscribeFromEvent

      public void unsubscribeFromEvent(Class<? extends jakarta.faces.event.SystemEvent> arg0, jakarta.faces.event.ComponentSystemEventListener arg1)

    • getStateHelper

      protected jakarta.faces.component.StateHelper getStateHelper()

    • getStateHelper

      protected jakarta.faces.component.StateHelper getStateHelper(boolean arg0)

    • getTransientStateHelper

      public jakarta.faces.component.TransientStateHelper getTransientStateHelper()

    • getTransientStateHelper

      public jakarta.faces.component.TransientStateHelper getTransientStateHelper(boolean arg0)

    • restoreTransientState

      public void restoreTransientState(jakarta.faces.context.FacesContext arg0, Object arg1)

    • saveTransientState

      public Object saveTransientState(jakarta.faces.context.FacesContext arg0)

    • popComponentFromEL

      public void popComponentFromEL(jakarta.faces.context.FacesContext arg0)

    • pushComponentToEL

      public void pushComponentToEL(jakarta.faces.context.FacesContext arg0, jakarta.faces.component.UIComponent arg1)