Class UIFile

java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIOutput
javax.faces.component.UIInput
org.apache.myfaces.tobago.internal.component.AbstractUIFile
org.apache.myfaces.tobago.component.UIFile
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, SupportFieldId, SupportsHelp, SupportsLabelLayout, Visual

@Generated("component.stg") public class UIFile extends AbstractUIFile

Renders a file input field.

For content constraints please use tc:validateFileItem.

UIComponent class, generated from template component.stg with class FileTagDeclaration.
  • Field Summary

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

    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
    The access key of this control.
    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.
     
    Displays a short text in the input field, that describes the meaning of this field.
    Controls the navigation of the focus through the input controls on a page with the Tab-Key.
    Text value to display as tooltip.
    boolean
    Flag indicating that this element is disabled.
    boolean
    Flag indicating this component should receive the focus.
    boolean
     
    boolean
    Flag indicating that this component will prohibit changes by the user.
    void
    restoreState(javax.faces.context.FacesContext context, Object state)
     
    void
     
    void
     
    void
    setDisabled(boolean disabled)
     
    void
    setFocus(boolean focus)
     
    void
     
    void
     
    void
     
    void
    setMarkup(Markup markup)
     
    void
    setMultiple(boolean multiple)
     
    void
    setPlaceholder(String placeholder)
     
    void
    setReadonly(boolean readonly)
     
    void
    setTabIndex(Integer tabIndex)
     
    void
     

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

    getFieldId, isLabelLayoutSkip, validate

    Methods inherited from class javax.faces.component.UIInput

    addValidator, addValueChangeListener, broadcast, clearInitialState, compareValues, decode, getConvertedValue, 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, validateValue

    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, getValueBinding, initialStateMarked, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree

    Methods inherited from class javax.faces.component.UIComponent

    getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, 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 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

    • UIFile

      public UIFile()
  • 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.UIInput
    • 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)
    • isMultiple

      public boolean isMultiple()
      Specified by:
      isMultiple in class AbstractUIFile
    • setMultiple

      public void setMultiple(boolean multiple)
    • isFocus

      public boolean isFocus()
      Flag indicating this component should receive the focus.
      Default: false
    • 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 AbstractUIFile
    • 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)
    • isReadonly

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

      public void setReadonly(boolean readonly)
    • getAccessKey

      public Character getAccessKey()
      The access key of this control.
    • setAccessKey

      public void setAccessKey(Character accessKey)
    • 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 AbstractUIFile
    • setDisabled

      public void setDisabled(boolean disabled)
    • getTip

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

      public void setTip(String tip)
    • getPlaceholder

      public String getPlaceholder()

      Displays a short text in the input field, that describes the meaning of this field. This is part of HTML 5, the theme should emulate the behaviour, when the browser doesn't support it.

      The text will not be displayed, when the input field is readonly or disabled.

      Specified by:
      getPlaceholder in class AbstractUIFile
    • setPlaceholder

      public void setPlaceholder(String placeholder)
    • 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