Package io.jans.jsf2.component

Class UIInputContainer

java.lang.Object
jakarta.faces.component.UIComponent
jakarta.faces.component.UIComponentBase
io.jans.jsf2.component.UIInputContainer
All Implemented Interfaces:
jakarta.faces.component.NamingContainer, jakarta.faces.component.PartialStateHolder, jakarta.faces.component.StateHolder, jakarta.faces.component.TransientStateHolder, jakarta.faces.event.ComponentSystemEventListener, jakarta.faces.event.FacesListener, jakarta.faces.event.SystemEventListenerHolder, EventListener
public class UIInputContainer extends jakarta.faces.component.UIComponentBase implements jakarta.faces.component.NamingContainer

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    UIInputContainer.InputContainerElements
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    COMPONENT_TYPE
    The standard component type for this component.
    protected static final String
    HTML_CLASS_ATTR_NAME
     
    protected static final String
    HTML_ID_ATTR_NAME
     
    protected static final String
    HTML_STYLE_ATTR_NAME
     

    Fields inherited from class jakarta.faces.component.UIComponent

    ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

    Fields inherited from interface jakarta.faces.component.NamingContainer

    SEPARATOR_CHAR

  • Constructor Summary

    Constructors
    Constructor
    Description
    UIInputContainer()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    assignIds(UIInputContainer.InputContainerElements elements, jakarta.faces.context.FacesContext context)
     
    void
    encodeBegin(jakarta.faces.context.FacesContext context)
     
    void
    encodeEnd(jakarta.faces.context.FacesContext context)
     
    protected void
    endContainerElement(jakarta.faces.context.FacesContext context)
     
    protected String
    generateLabel(UIInputContainer.InputContainerElements elements, jakarta.faces.context.FacesContext context)
     
    String
    getContainerElementName()
     
    String
    getDefaultInputId()
     
    String
    getDefaultLabelId()
     
    String
    getDefaultMessageId()
     
    String
    getElementsAttributeName()
    The name of the auto-generated composite component attribute that holds the elements in this input container.
    String
    getEncloseAttributeName()
    The name of the composite component attribute that holds a boolean indicating whether the component template should be enclosed in an HTML element, so that it be referenced from JavaScript.
    String
    getFamily()
     
    String
    getInvalidAttributeName()
    The name of the auto-generated composite component attribute that holds a boolean indicating whether the the template contains an invalid input.
    String
    getLabelAttributeName()
    The name of the composite component attribute that holds the string label for this set of inputs.
    String
    getRequiredAttributeName()
    The name of the auto-generated composite component attribute that holds a boolean indicating whether the template contains a required input.
    protected UIInputContainer.InputContainerElements
    scan(jakarta.faces.component.UIComponent component, UIInputContainer.InputContainerElements elements, jakarta.faces.context.FacesContext context)
    Walk the component tree branch built by the composite component and locate the input container elements.
    protected void
    startContainerElement(jakarta.faces.context.FacesContext context)
     
    protected void
    wire(UIInputContainer.InputContainerElements elements, jakarta.faces.context.FacesContext context)
    Wire the label and messages to the input(s)

    Methods inherited from class jakarta.faces.component.UIComponentBase

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

    Methods inherited from class jakarta.faces.component.UIComponent

    encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Constructor Details

    • UIInputContainer

      public UIInputContainer()

  • Method Details

    • getFamily

      public String getFamily()
      Specified by:
      getFamily in class jakarta.faces.component.UIComponent

    • getInvalidAttributeName

      public String getInvalidAttributeName()
      The name of the auto-generated composite component attribute that holds a boolean indicating whether the the template contains an invalid input.

    • getRequiredAttributeName

      public String getRequiredAttributeName()
      The name of the auto-generated composite component attribute that holds a boolean indicating whether the template contains a required input.

    • getLabelAttributeName

      public String getLabelAttributeName()
      The name of the composite component attribute that holds the string label for this set of inputs. If the label attribute is not provided, one will be generated from the id of the composite component or, if the id is defaulted, the name of the property bound to the first input.

    • getElementsAttributeName

      public String getElementsAttributeName()
      The name of the auto-generated composite component attribute that holds the elements in this input container. The elements include the label, a list of inputs and a cooresponding list of messages.

    • getEncloseAttributeName

      public String getEncloseAttributeName()
      The name of the composite component attribute that holds a boolean indicating whether the component template should be enclosed in an HTML element, so that it be referenced from JavaScript.

    • getContainerElementName

      public String getContainerElementName()

    • getDefaultLabelId

      public String getDefaultLabelId()

    • getDefaultInputId

      public String getDefaultInputId()

    • getDefaultMessageId

      public String getDefaultMessageId()

    • encodeBegin

      public void encodeBegin(jakarta.faces.context.FacesContext context) throws IOException
      Overrides:
      encodeBegin in class jakarta.faces.component.UIComponentBase
      Throws:
      IOException

    • encodeEnd

      public void encodeEnd(jakarta.faces.context.FacesContext context) throws IOException
      Overrides:
      encodeEnd in class jakarta.faces.component.UIComponentBase
      Throws:
      IOException

    • startContainerElement

      protected void startContainerElement(jakarta.faces.context.FacesContext context) throws IOException
      Throws:
      IOException

    • endContainerElement

      protected void endContainerElement(jakarta.faces.context.FacesContext context) throws IOException
      Throws:
      IOException

    • generateLabel

      protected String generateLabel(UIInputContainer.InputContainerElements elements, jakarta.faces.context.FacesContext context)

    • scan

      protected UIInputContainer.InputContainerElements scan(jakarta.faces.component.UIComponent component, UIInputContainer.InputContainerElements elements, jakarta.faces.context.FacesContext context)
      Walk the component tree branch built by the composite component and locate the input container elements.
      Returns:
      a composite object of the input container elements

    • assignIds

      public void assignIds(UIInputContainer.InputContainerElements elements, jakarta.faces.context.FacesContext context)

    • wire

      protected void wire(UIInputContainer.InputContainerElements elements, jakarta.faces.context.FacesContext context)
      Wire the label and messages to the input(s)