org.apache.myfaces.custom.fileupload
Class HtmlInputFileUpload

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              javax.faces.component.UIInput
                  javax.faces.component.html.HtmlInputText
                      org.apache.myfaces.custom.fileupload.AbstractHtmlInputFileUpload
                          org.apache.myfaces.custom.fileupload.HtmlInputFileUpload

All Implemented Interfaces:

javax.faces.component.EditableValueHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder, AlignProperty, UserRoleAware

public class HtmlInputFileUpload
extends AbstractHtmlInputFileUpload

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	DEFAULT_RENDERER_TYPE

Fields inherited from class org.apache.myfaces.custom.fileupload.AbstractHtmlInputFileUpload

SIZE_LIMIT_MESSAGE_ID

Fields inherited from class javax.faces.component.UIInput

CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID

Fields inherited from interface org.apache.myfaces.component.UserRoleAware

ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR

Constructor Summary

HtmlInputFileUpload()

Method Summary

java.lang.String	getAccept() This attribute specifies a comma-separated list of content types that a server processing this form will handle correctly.
java.lang.String	getAlign() HTML: Specifies the horizontal alignment of this element.
java.lang.String	getEnabledOnUserRole() If user is in given role, this component will be rendered normally.
java.lang.String	getFamily()
java.lang.String	getStorage() This setting was intended to allow control over how the contents of the file get temporarily stored during processing.
java.lang.String	getVisibleOnUserRole() If user is in given role, this component will be rendered normally.
void	restoreState(javax.faces.context.FacesContext facesContext, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext facesContext)
void	setAccept(java.lang.String accept)
void	setAlign(java.lang.String align)
void	setEnabledOnUserRole(java.lang.String enabledOnUserRole)
void	setStorage(java.lang.String storage)
void	setVisibleOnUserRole(java.lang.String visibleOnUserRole)

Methods inherited from class org.apache.myfaces.custom.fileupload.AbstractHtmlInputFileUpload

getUploadedFile, getValue, isRendered, setUploadedFile, validateValue

Methods inherited from class javax.faces.component.html.HtmlInputText

getAccesskey, getAlt, getDir, getLang, getMaxlength, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getSize, getStyle, getStyleClass, getTabindex, getTitle, isDisabled, isReadonly, setAccesskey, setAlt, setDir, setDisabled, setLang, setMaxlength, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setReadonly, setSize, setStyle, setStyleClass, setTabindex, setTitle

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, broadcast, compareValues, decode, getConvertedValue, getSubmittedValue, getValidator, getValidators, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, setImmediate, setLocalValueSet, setRequired, setSubmittedValue, setValid, setValidator, setValue, setValueChangeListener, updateModel, validate

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

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.ValueHolder

getConverter, getLocalValue, setConverter

Field Detail

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

DEFAULT_RENDERER_TYPE

public static final java.lang.String DEFAULT_RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

HtmlInputFileUpload

public HtmlInputFileUpload()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UIInput

getStorage

public java.lang.String getStorage()

Description copied from class: AbstractHtmlInputFileUpload

This setting was intended to allow control over how the contents of the file get temporarily stored during processing.

It allows three options

• "default": The file is handled on memory while the file size is below uploadThresholdSize value, otherwise is handled on disk or file storage when decode occur (set submitted value)
• "memory": The file is loaded to memory when decode occur (set submitted value). In other words, before set the uploaded file as submitted value it is loaded to memory. Use with caution, because it could cause OutOfMemory exceptions when the uploaded files are too big.
• "file": The file is handled on disk or file storage.

Specified by:

getStorage in class AbstractHtmlInputFileUpload

setStorage

public void setStorage(java.lang.String storage)

getAccept

public java.lang.String getAccept()

Description copied from class: AbstractHtmlInputFileUpload

This attribute specifies a comma-separated list of content types that a server processing this form will handle correctly. User agents may use this information to filter out non-conforming files when prompting a user to select files to be sent to the server (cf. the INPUT element when type="file")."

Specified by:

getAccept in class AbstractHtmlInputFileUpload

setAccept

public void setAccept(java.lang.String accept)

getEnabledOnUserRole

public java.lang.String getEnabledOnUserRole()

Description copied from interface: UserRoleAware

If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.

Returns:

setEnabledOnUserRole

public void setEnabledOnUserRole(java.lang.String enabledOnUserRole)

getVisibleOnUserRole

public java.lang.String getVisibleOnUserRole()

Description copied from interface: UserRoleAware

If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.

Returns:

setVisibleOnUserRole

public void setVisibleOnUserRole(java.lang.String visibleOnUserRole)

getAlign

public java.lang.String getAlign()

Description copied from interface: AlignProperty

HTML: Specifies the horizontal alignment of this element. Deprecated in HTML 4.01.

setAlign

public void setAlign(java.lang.String align)

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext facesContext)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.html.HtmlInputText

restoreState

public void restoreState(javax.faces.context.FacesContext facesContext,
                         java.lang.Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.html.HtmlInputText