Class UISelectManyShuttle

java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIOutput
javax.faces.component.UIInput
All Implemented Interfaces:
EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.EditableValueHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, SupportsHelp, SupportsLabelLayout, Visual

@Generated("component.stg") public class UISelectManyShuttle extends AbstractUISelectManyShuttle
UIComponent class, generated from template component.stg with class SelectManyShuttleTagDeclaration.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
     
    static final String
     

    Fields inherited from class javax.faces.component.UISelectMany

    INVALID_MESSAGE_ID

    Fields inherited from class javax.faces.component.UIInput

    CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME

    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
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    Sets a CSS class in its parent, if the parent supports it.
     
     
     
    Text value to display as a help.
    A localized user presentable label for this component.
    Defines the position of the label relative to the field.
     
    A localized user presentable label for the right select box.
    The number of the shown rows in the element.
    Controls the navigation of the focus through the input controls on a page with the Tab-Key.
    Text value to display as tooltip.
    A localized user presentable label for the left select box.
    boolean
    Flag indicating that this element is disabled.
    boolean
    Flag indicating this component should receive the focus.
    boolean
    Flag indicating that this component will prohibit changes by the user.
    void
    restoreState(javax.faces.context.FacesContext context, Object state)
     
    void
     
    void
    setDisabled(boolean disabled)
     
    void
    setFocus(boolean focus)
     
    void
     
    void
     
    void
     
    void
    setMarkup(Markup markup)
     
    void
    setReadonly(boolean readonly)
     
    void
    setSelectedLabel(String selectedLabel)
     
    void
     
    void
    setTabIndex(Integer tabIndex)
     
    void
     
    void
    setUnselectedLabel(String unselectedLabel)
     

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

    hasLabel, isLabelLayoutSkip

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

    getSelectedValues

    Methods inherited from class javax.faces.component.UISelectMany

    compareValues, getConvertedValue, getValueBinding, getValueExpression, setSelectedValues, setValueBinding, setValueExpression, validate, validateValue

    Methods inherited from class javax.faces.component.UIInput

    addValidator, addValueChangeListener, broadcast, clearInitialState, decode, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel

    Methods inherited from class javax.faces.component.UIOutput

    getConverter, getLocalValue, setConverter

    Methods inherited from class javax.faces.component.UIComponentBase

    addClientBehavior, addFacesListener, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, initialStateMarked, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, visitTree

    Methods inherited from class javax.faces.component.UIComponent

    getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, 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 javax.faces.component.behavior.ClientBehaviorHolder

    addClientBehavior, getClientBehaviors

    Methods inherited from interface javax.faces.component.ValueHolder

    getConverter, getLocalValue, setConverter

    Methods inherited from interface org.apache.myfaces.tobago.component.Visual

    getRendererType, isPlain
  • Field Details

  • Constructor Details

    • UISelectManyShuttle

      public UISelectManyShuttle()
  • Method Details

    • getEventNames

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

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

      public String getFamily()
      Overrides:
      getFamily in class javax.faces.component.UISelectMany
    • getMarkup

      public Markup getMarkup()
    • setMarkup

      public void setMarkup(Markup markup)
    • getSelectedLabel

      public String getSelectedLabel()
      A localized user presentable label for the right select box.
      Specified by:
      getSelectedLabel in class AbstractUISelectManyShuttle
    • setSelectedLabel

      public void setSelectedLabel(String selectedLabel)
    • 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 AbstractUISelectManyBase
    • 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)
    • getUnselectedLabel

      public String getUnselectedLabel()
      A localized user presentable label for the left select box.
      Specified by:
      getUnselectedLabel in class AbstractUISelectManyShuttle
    • setUnselectedLabel

      public void setUnselectedLabel(String unselectedLabel)
    • 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)
    • getSize

      public Integer getSize()
      The number of the shown rows in the element. E. g. the size attribute of the select element in HTML.
      Specified by:
      getSize in class AbstractUISelectManyShuttle
    • setSize

      public void setSize(Integer size)
    • 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 class AbstractUISelectManyBase
    • 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(javax.faces.context.FacesContext context, Object state)
      Specified by:
      restoreState in interface javax.faces.component.StateHolder
      Overrides:
      restoreState in class javax.faces.component.UIInput