HtmlInputFile (Jakarta Server Faces 3.0.0 API)

java.lang.Object
- jakarta.faces.component.UIComponent
- - jakarta.faces.component.UIComponentBase
  - - jakarta.faces.component.UIOutput
    - - jakarta.faces.component.UIInput
      - jakarta.faces.component.html.HtmlInputFile

All Implemented Interfaces:

ClientBehaviorHolder, EditableValueHolder, PartialStateHolder, StateHolder, TransientStateHolder, ValueHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder, EventListener
```
public class HtmlInputFile
extends UIInput
implements ClientBehaviorHolder
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class HtmlInputFile.PropertyKeys

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`HtmlInputFile.PropertyKeys`

Field Summary

Fields
Modifier and Type Field and Description

static String COMPONENT_TYPE
The standard component type for this component.
- Fields inherited from class jakarta.faces.component.UIInput
  ALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUE, COMPONENT_FAMILY, 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, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Fields
Modifier and Type	Field and Description
`static String`	`COMPONENT_TYPE` The standard component type for this component.

Constructor Summary

Constructors
Constructor and Description

HtmlInputFile()

Constructors
Constructor and Description
`HtmlInputFile()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAccesskey()` Return the value of the `accesskey` property.
`String`	`getAlt()` Return the value of the `alt` property.
`String`	`getAutocomplete()` Return the value of the `autocomplete` property.
`String`	`getDefaultEventName()` This is a default implementation of `ClientBehaviorHolder.getDefaultEventName()`.
`String`	`getDir()` Return the value of the `dir` property.
`Collection<String>`	`getEventNames()` This is a default implementation of `ClientBehaviorHolder.getEventNames()`.
`String`	`getLabel()` Return the value of the `label` property.
`String`	`getLang()` Return the value of the `lang` property.
`int`	`getMaxlength()` Return the value of the `maxlength` property.
`String`	`getOnblur()` Return the value of the `onblur` property.
`String`	`getOnchange()` Return the value of the `onchange` property.
`String`	`getOnclick()` Return the value of the `onclick` property.
`String`	`getOndblclick()` Return the value of the `ondblclick` property.
`String`	`getOnfocus()` Return the value of the `onfocus` property.
`String`	`getOnkeydown()` Return the value of the `onkeydown` property.
`String`	`getOnkeypress()` Return the value of the `onkeypress` property.
`String`	`getOnkeyup()` Return the value of the `onkeyup` property.
`String`	`getOnmousedown()` Return the value of the `onmousedown` property.
`String`	`getOnmousemove()` Return the value of the `onmousemove` property.
`String`	`getOnmouseout()` Return the value of the `onmouseout` property.
`String`	`getOnmouseover()` Return the value of the `onmouseover` property.
`String`	`getOnmouseup()` Return the value of the `onmouseup` property.
`String`	`getOnselect()` Return the value of the `onselect` property.
`String`	`getRole()` Return the value of the `role` property.
`int`	`getSize()` Return the value of the `size` property.
`String`	`getStyle()` Return the value of the `style` property.
`String`	`getStyleClass()` Return the value of the `styleClass` property.
`String`	`getTabindex()` Return the value of the `tabindex` property.
`String`	`getTitle()` Return the value of the `title` property.
`boolean`	`isDisabled()` Return the value of the `disabled` property.
`boolean`	`isReadonly()` Return the value of the `readonly` property.
`Object`	`saveState(FacesContext context)` Gets the state of the instance as a `Serializable` Object.
`void`	`setAccesskey(String accesskey)` Set the value of the `accesskey` property.
`void`	`setAlt(String alt)` Set the value of the `alt` property.
`void`	`setAutocomplete(String autocomplete)` Set the value of the `autocomplete` property.
`void`	`setDir(String dir)` Set the value of the `dir` property.
`void`	`setDisabled(boolean disabled)` Set the value of the `disabled` property.
`void`	`setLabel(String label)` Set the value of the `label` property.
`void`	`setLang(String lang)` Set the value of the `lang` property.
`void`	`setMaxlength(int maxlength)` Set the value of the `maxlength` property.
`void`	`setOnblur(String onblur)` Set the value of the `onblur` property.
`void`	`setOnchange(String onchange)` Set the value of the `onchange` property.
`void`	`setOnclick(String onclick)` Set the value of the `onclick` property.
`void`	`setOndblclick(String ondblclick)` Set the value of the `ondblclick` property.
`void`	`setOnfocus(String onfocus)` Set the value of the `onfocus` property.
`void`	`setOnkeydown(String onkeydown)` Set the value of the `onkeydown` property.
`void`	`setOnkeypress(String onkeypress)` Set the value of the `onkeypress` property.
`void`	`setOnkeyup(String onkeyup)` Set the value of the `onkeyup` property.
`void`	`setOnmousedown(String onmousedown)` Set the value of the `onmousedown` property.
`void`	`setOnmousemove(String onmousemove)` Set the value of the `onmousemove` property.
`void`	`setOnmouseout(String onmouseout)` Set the value of the `onmouseout` property.
`void`	`setOnmouseover(String onmouseover)` Set the value of the `onmouseover` property.
`void`	`setOnmouseup(String onmouseup)` Set the value of the `onmouseup` property.
`void`	`setOnselect(String onselect)` Set the value of the `onselect` property.
`void`	`setReadonly(boolean readonly)` Set the value of the `readonly` property.
`void`	`setRole(String role)` Set the value of the `role` property.
`void`	`setSize(int size)` Set the value of the `size` property.
`void`	`setStyle(String style)` Set the value of the `style` property.
`void`	`setStyleClass(String styleClass)` Set the value of the `styleClass` property.
`void`	`setTabindex(String tabindex)` Set the value of the `tabindex` property.
`void`	`setTitle(String title)` Set the value of the `title` property.

Methods inherited from class jakarta.faces.component.UIOutput
getConverter, getLocalValue, setConverter

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jakarta.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors

Methods inherited from interface jakarta.faces.component.ValueHolder
getConverter, getLocalValue, setConverter

- Field Detail
  - COMPONENT_TYPE
```
public static final String COMPONENT_TYPE
```
    The standard component type for this component.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HtmlInputFile
```
public HtmlInputFile()
```
- Method Detail
  - getAccesskey
```
public String getAccesskey()
```
    Return the value of the accesskey property.
    
    Contents: Access key that, when pressed, transfers focus to this element.
    
    Returns:
    
    the value of the property
  - setAccesskey
```
public void setAccesskey(String accesskey)
```
    Set the value of the accesskey property.
    
    Parameters:
    
    accesskey - the new property value
  - getAlt
```
public String getAlt()
```
    Return the value of the alt property.
    
    Contents: Alternate textual description of the element rendered by this component.
    
    Returns:
    
    the value of the property
  - setAlt
```
public void setAlt(String alt)
```
    Set the value of the alt property.
    
    Parameters:
    
    alt - the new property value
  - getAutocomplete
```
public String getAutocomplete()
```
    Return the value of the autocomplete property.
    
    Contents: If the value of this attribute is "off", render "off" as the value of the attribute. This indicates that the browser should disable its autocomplete feature for this component. This is useful for components that perform autocompletion and do not want the browser interfering. If this attribute is not set or the value is "on", render nothing.
    
    Returns:
    
    the value of the property
  - setAutocomplete
```
public void setAutocomplete(String autocomplete)
```
    Set the value of the autocomplete property.
    
    Parameters:
    
    autocomplete - the new property value
  - getDir
```
public String getDir()
```
    Return the value of the dir property.
    
    Contents: Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). These attributes are case sensitive when rendering to XHTML, so care must be taken to have the correct case.
    
    Returns:
    
    the value of the property
  - setDir
```
public void setDir(String dir)
```
    Set the value of the dir property.
    
    Parameters:
    
    dir - the new property value
  - isDisabled
```
public boolean isDisabled()
```
    Return the value of the disabled property.
    
    Contents: Flag indicating that this element must never receive focus or be included in a subsequent submit. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as disabled="disabled".
    
    Returns:
    
    the value of the property
  - setDisabled
```
public void setDisabled(boolean disabled)
```
    Set the value of the disabled property.
    
    Parameters:
    
    disabled - the new property value
  - getLabel
```
public String getLabel()
```
    Return the value of the label property.
    
    Contents: A localized user presentable name for this component.
    
    Returns:
    
    the value of the property
  - setLabel
```
public void setLabel(String label)
```
    Set the value of the label property.
    
    Parameters:
    
    label - the new property value
  - getLang
```
public String getLang()
```
    Return the value of the lang property.
    
    Contents: Code describing the language used in the generated markup for this component.
    
    Returns:
    
    the value of the property
  - setLang
```
public void setLang(String lang)
```
    Set the value of the lang property.
    
    Parameters:
    
    lang - the new property value
  - getMaxlength
```
public int getMaxlength()
```
    Return the value of the maxlength property.
    
    Contents: The maximum number of characters that may be entered in this field.
    
    Returns:
    
    the value of the property
  - setMaxlength
```
public void setMaxlength(int maxlength)
```
    Set the value of the maxlength property.
    
    Parameters:
    
    maxlength - the new property value
  - getOnblur
```
public String getOnblur()
```
    Return the value of the onblur property.
    
    Contents: JavaScript code executed when this element loses focus.
    
    Returns:
    
    the value of the property
  - setOnblur
```
public void setOnblur(String onblur)
```
    Set the value of the onblur property.
    
    Parameters:
    
    onblur - the new property value
  - getOnchange
```
public String getOnchange()
```
    Return the value of the onchange property.
    
    Contents: JavaScript code executed when this element loses focus and its value has been modified since gaining focus.
    
    Returns:
    
    the value of the property
  - setOnchange
```
public void setOnchange(String onchange)
```
    Set the value of the onchange property.
    
    Parameters:
    
    onchange - the new property value
  - getOnclick
```
public String getOnclick()
```
    Return the value of the onclick property.
    
    Contents: JavaScript code executed when a pointer button is clicked over this element.
    
    Returns:
    
    the value of the property
  - setOnclick
```
public void setOnclick(String onclick)
```
    Set the value of the onclick property.
    
    Parameters:
    
    onclick - the new property value
  - getOndblclick
```
public String getOndblclick()
```
    Return the value of the ondblclick property.
    
    Contents: JavaScript code executed when a pointer button is double clicked over this element.
    
    Returns:
    
    the value of the property
  - setOndblclick
```
public void setOndblclick(String ondblclick)
```
    Set the value of the ondblclick property.
    
    Parameters:
    
    ondblclick - the new property value
  - getOnfocus
```
public String getOnfocus()
```
    Return the value of the onfocus property.
    
    Contents: JavaScript code executed when this element receives focus.
    
    Returns:
    
    the value of the property
  - setOnfocus
```
public void setOnfocus(String onfocus)
```
    Set the value of the onfocus property.
    
    Parameters:
    
    onfocus - the new property value
  - getOnkeydown
```
public String getOnkeydown()
```
    Return the value of the onkeydown property.
    
    Contents: JavaScript code executed when a key is pressed down over this element.
    
    Returns:
    
    the value of the property
  - setOnkeydown
```
public void setOnkeydown(String onkeydown)
```
    Set the value of the onkeydown property.
    
    Parameters:
    
    onkeydown - the new property value
  - getOnkeypress
```
public String getOnkeypress()
```
    Return the value of the onkeypress property.
    
    Contents: JavaScript code executed when a key is pressed and released over this element.
    
    Returns:
    
    the value of the property
  - setOnkeypress
```
public void setOnkeypress(String onkeypress)
```
    Set the value of the onkeypress property.
    
    Parameters:
    
    onkeypress - the new property value
  - getOnkeyup
```
public String getOnkeyup()
```
    Return the value of the onkeyup property.
    
    Contents: JavaScript code executed when a key is released over this element.
    
    Returns:
    
    the value of the property
  - setOnkeyup
```
public void setOnkeyup(String onkeyup)
```
    Set the value of the onkeyup property.
    
    Parameters:
    
    onkeyup - the new property value
  - getOnmousedown
```
public String getOnmousedown()
```
    Return the value of the onmousedown property.
    
    Contents: JavaScript code executed when a pointer button is pressed down over this element.
    
    Returns:
    
    the value of the property
  - setOnmousedown
```
public void setOnmousedown(String onmousedown)
```
    Set the value of the onmousedown property.
    
    Parameters:
    
    onmousedown - the new property value
  - getOnmousemove
```
public String getOnmousemove()
```
    Return the value of the onmousemove property.
    
    Contents: JavaScript code executed when a pointer button is moved within this element.
    
    Returns:
    
    the value of the property
  - setOnmousemove
```
public void setOnmousemove(String onmousemove)
```
    Set the value of the onmousemove property.
    
    Parameters:
    
    onmousemove - the new property value
  - getOnmouseout
```
public String getOnmouseout()
```
    Return the value of the onmouseout property.
    
    Contents: JavaScript code executed when a pointer button is moved away from this element.
    
    Returns:
    
    the value of the property
  - setOnmouseout
```
public void setOnmouseout(String onmouseout)
```
    Set the value of the onmouseout property.
    
    Parameters:
    
    onmouseout - the new property value
  - getOnmouseover
```
public String getOnmouseover()
```
    Return the value of the onmouseover property.
    
    Contents: JavaScript code executed when a pointer button is moved onto this element.
    
    Returns:
    
    the value of the property
  - setOnmouseover
```
public void setOnmouseover(String onmouseover)
```
    Set the value of the onmouseover property.
    
    Parameters:
    
    onmouseover - the new property value
  - getOnmouseup
```
public String getOnmouseup()
```
    Return the value of the onmouseup property.
    
    Contents: JavaScript code executed when a pointer button is released over this element.
    
    Returns:
    
    the value of the property
  - setOnmouseup
```
public void setOnmouseup(String onmouseup)
```
    Set the value of the onmouseup property.
    
    Parameters:
    
    onmouseup - the new property value
  - getOnselect
```
public String getOnselect()
```
    Return the value of the onselect property.
    
    Contents: JavaScript code executed when text within this element is selected by the user.
    
    Returns:
    
    the value of the property
  - setOnselect
```
public void setOnselect(String onselect)
```
    Set the value of the onselect property.
    
    Parameters:
    
    onselect - the new property value
  - isReadonly
```
public boolean isReadonly()
```
    Return the value of the readonly property.
    
    Contents: Flag indicating that this component will prohibit changes by the user. The element may receive focus unless it has also been disabled. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as readonly="readonly".
    
    Returns:
    
    the value of the property
  - setReadonly
```
public void setReadonly(boolean readonly)
```
    Set the value of the readonly property.
    
    Parameters:
    
    readonly - the new property value
  - getRole
```
public String getRole()
```
    Return the value of the role property.
    
    Contents:
    Per the WAI-ARIA spec and its relationship to HTML5 (Section title ARIA Role Attriubute), every HTML element may have a "role" attribute whose value must be passed through unmodified on the element on which it is declared in the final rendered markup. The attribute, if specified, must have a value that is a string literal that is, or a Jakarta Expression Language Expression that evaluates to, a set of space-separated tokens representing the various WAI-ARIA roles that the element belongs to.
    
    It is the page author's responsibility to ensure that the user agent is capable of correctly interpreting the value of this attribute.
    
    Returns:
    
    the value of the property
  - setRole
```
public void setRole(String role)
```
    Set the value of the role property.
    
    Parameters:
    
    role - the new property value
  - getSize
```
public int getSize()
```
    Return the value of the size property.
    
    Contents: The number of characters used to determine the width of this field.
    
    Returns:
    
    the value of the property
  - setSize
```
public void setSize(int size)
```
    Set the value of the size property.
    
    Parameters:
    
    size - the new property value
  - getStyle
```
public String getStyle()
```
    Return the value of the style property.
    
    Contents: CSS style(s) to be applied when this component is rendered.
    
    Returns:
    
    the value of the property
  - setStyle
```
public void setStyle(String style)
```
    Set the value of the style property.
    
    Parameters:
    
    style - the new property value
  - getStyleClass
```
public String getStyleClass()
```
    Return the value of the styleClass property.
    
    Contents: Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.
    
    Returns:
    
    the value of the property
  - setStyleClass
```
public void setStyleClass(String styleClass)
```
    Set the value of the styleClass property.
    
    Parameters:
    
    styleClass - the new property value
  - getTabindex
```
public String getTabindex()
```
    Return the value of the tabindex property.
    
    Contents: Position of this element in the tabbing order for the current document. This value must be an integer between 0 and 32767.
    
    Returns:
    
    the value of the property
  - setTabindex
```
public void setTabindex(String tabindex)
```
    Set the value of the tabindex property.
    
    Parameters:
    
    tabindex - the new property value
  - getTitle
```
public String getTitle()
```
    Return the value of the title property.
    
    Contents: Advisory title information about markup elements generated for this component.
    
    Returns:
    
    the value of the property
  - setTitle
```
public void setTitle(String title)
```
    Set the value of the title property.
    
    Parameters:
    
    title - the new property value
  - getEventNames
```
public Collection<String> getEventNames()
```
    Description copied from class: UIComponentBase
    
    This is a default implementation of ClientBehaviorHolder.getEventNames(). UIComponent does not implement the ClientBehaviorHolder interface, but provides default implementations for the methods defined by ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the ClientBehaviorHolder contract must declare that the subclass implements ClientBehaviorHolder, and must override this method to return a non-Empty Collection of the client event names that the component supports.
    
    Specified by:
    
    getEventNames in interface ClientBehaviorHolder
    
    Overrides:
    
    getEventNames in class UIComponentBase
    
    Returns:
    
    the collection of event names.
  - getDefaultEventName
```
public String getDefaultEventName()
```
    Description copied from class: UIComponentBase
    
    This is a default implementation of ClientBehaviorHolder.getDefaultEventName(). UIComponent does not implement the ClientBehaviorHolder interface, but provides default implementations for the methods defined by ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the ClientBehaviorHolder contract must declare that the subclass implements ClientBehaviorHolder, and must provide an implementation of ClientBehaviorHolder.getEventNames().
    
    Specified by:
    
    getDefaultEventName in interface ClientBehaviorHolder
    
    Overrides:
    
    getDefaultEventName in class UIComponentBase
    
    Returns:
    
    the default event name.
  - saveState
```
public Object saveState(FacesContext context)
```
    Description copied from interface: StateHolder
    Gets the state of the instance as a Serializable Object.
    
    If the class that implements this interface has references to instances that implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the StateHolder.saveState(jakarta.faces.context.FacesContext) method on all those instances as well. This method must not save the state of children and facets. That is done via the StateManager
    
    This method must not alter the state of the implementing object. In other words, after executing this code:
```
 
 Object state = component.saveState(facesContext);
 
 
```
    component should be the same as before executing it.
    
    The return from this method must be Serializable
    Specified by:
    
    saveState in interface StateHolder
    
    Overrides:
    
    saveState in class UIInput
    
    Parameters:
    
    context - the Faces context.
    
    Returns:
    
    the saved state.

Class HtmlInputFile

Nested Class Summary

Field Summary

Fields inherited from class jakarta.faces.component.UIInput

Fields inherited from class jakarta.faces.component.UIComponent

Constructor Summary

Method Summary

Methods inherited from class jakarta.faces.component.UIInput

Methods inherited from class jakarta.faces.component.UIOutput

Methods inherited from class jakarta.faces.component.UIComponentBase

Methods inherited from class jakarta.faces.component.UIComponent

Methods inherited from class java.lang.Object

Methods inherited from interface jakarta.faces.component.behavior.ClientBehaviorHolder

Methods inherited from interface jakarta.faces.component.ValueHolder

Field Detail

COMPONENT_TYPE

Constructor Detail

HtmlInputFile

Method Detail

getAccesskey

setAccesskey

getAlt

setAlt

getAutocomplete

setAutocomplete

getDir

setDir

isDisabled

setDisabled

getLabel

setLabel

getLang

setLang

getMaxlength

setMaxlength

getOnblur

setOnblur

getOnchange

setOnchange

getOnclick

setOnclick

getOndblclick

setOndblclick

getOnfocus

setOnfocus

getOnkeydown

setOnkeydown

getOnkeypress

setOnkeypress

getOnkeyup

setOnkeyup

getOnmousedown

setOnmousedown

getOnmousemove

setOnmousemove

getOnmouseout

setOnmouseout

getOnmouseover

setOnmouseover

getOnmouseup

setOnmouseup

getOnselect

setOnselect

isReadonly

setReadonly

getRole

setRole

getSize

setSize

getStyle

setStyle

getStyleClass

setStyleClass

getTabindex

setTabindex

getTitle

setTitle

getEventNames

getDefaultEventName

saveState