@Generated(value={"RichFaces CDK","4.5.0-SNAPSHOT"}) public class UIFileUpload extends AbstractFileUpload implements javax.faces.component.behavior.ClientBehaviorHolder, AjaxProps, CoreProps, DisabledProps, EventsKeyProps, EventsMouseProps, I18nProps
The <rich:fileUpload> component allows the user to upload files to a server. It features multiple uploads, progress bars, restrictions on file types, and restrictions on sizes of the files to be uploaded.
Modifier and Type | Class and Description |
---|---|
protected static class |
UIFileUpload.Properties |
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
Constructor and Description |
---|
UIFileUpload() |
Modifier and Type | Method and Description |
---|---|
String |
getAcceptedTypes()
Defines comma separated list of file extensions accepted by component.
|
String |
getAddLabel()
The label for the Add button.
|
String |
getClearAllLabel()
The label for the Clear button.
|
String |
getClearLabel()
The label displayed for the Clear link
|
Object |
getData()
Serialized (on default with JSON) data passed to the client by a developer on an AJAX request.
|
String |
getDefaultEventName() |
String |
getDeleteLabel()
The label displayed for the Delete link
|
String |
getDir()
Direction indication for text that does not inherit directionality.
|
String |
getDoneLabel()
The label displayed when a file is successfully uploaded.
|
Collection<String> |
getEventNames() |
Object |
getExecute()
IDs of components that will participate in the "execute" portion of the Request Processing Lifecycle.
|
String |
getFamily() |
javax.el.MethodExpression |
getFileUploadListener()
A listener function on the server side after each file is uploaded.
|
String |
getLang()
Code describing the language used in the generated markup for this component.
|
String |
getListHeight()
Defines height of file list.
|
Integer |
getMaxFilesQuantity()
Defines maximum number of files allowed to be uploaded.
|
String |
getOnbeforedomupdate()
The client-side script method to be called after the ajax response comes back, but before the DOM is updated
|
String |
getOnbegin()
The client-side script method to be called before an ajax request.
|
String |
getOnclear()
Javascript code executed when a file is cleared
|
String |
getOnclick()
Javascript code executed when a pointer button is clicked over this element.
|
String |
getOncomplete()
The client-side script method to be called after the DOM is updated
|
String |
getOndblclick()
Javascript code executed when a pointer button is double clicked over this element.
|
String |
getOnfileselect()
Javascript code executed when a file is selected
|
String |
getOnfilesubmit()
Javascript code executed when a file is submitted
|
String |
getOnkeydown()
Javascript code executed when a key is pressed down over this element.
|
String |
getOnkeypress()
Javascript code executed when a key is pressed and released over this element.
|
String |
getOnkeyup()
Javascript code executed when a key is released over this element.
|
String |
getOnmousedown()
Javascript code executed when a pointer button is pressed down over this element.
|
String |
getOnmousemove()
Javascript code executed when a pointer button is moved within this element.
|
String |
getOnmouseout()
Javascript code executed when a pointer button is moved away from this element.
|
String |
getOnmouseover()
Javascript code executed when a pointer button is moved onto this element.
|
String |
getOnmouseup()
Javascript code executed when a pointer button is released over this element.
|
String |
getOntyperejected()
Javascript code executed when a file does not meet the conditions stated by acceptedTypes parameter.
|
String |
getOnuploadcomplete()
Javascript code executed when a file upload is complete
|
Object |
getRender()
IDs of components that will participate in the "render" portion of the Request Processing Lifecycle.
|
String |
getServerErrorLabel()
The label displayed when a file upload fails due to a server error.
|
String |
getSizeExceededLabel()
The label displayed when a file exceeds the size limit.
|
String |
getStatus()
Name of the request status component that will indicate the status of the Ajax request
|
String |
getStyle()
CSS style(s) to be applied when this component is rendered.
|
String |
getStyleClass()
Space-separated list of CSS style class(es) to be applied when this element is rendered.
|
String |
getTitle()
Advisory title information about markup elements generated for this component.
|
String |
getUploadLabel()
The label for the Upload button.
|
boolean |
isDisabled()
Flag indicating that this element must never receive focus or be included in a subsequent submit.
|
boolean |
isImmediateUpload()
If "true" upload stats immediately after file selection
|
boolean |
isLimitRender()
If "true", render only those ids specified in the "render" attribute, forgoing the render of the auto-rendered panels
|
boolean |
isNoDuplicate()
If "true" duplicate file uploads are prevented
|
boolean |
isResetValues()
If true, indicate that this particular Ajax transaction is a value reset transaction.
|
void |
setAcceptedTypes(String acceptedTypes) |
void |
setAddLabel(String addLabel) |
void |
setClearAllLabel(String clearAllLabel) |
void |
setClearLabel(String clearLabel) |
void |
setData(Object data) |
void |
setDeleteLabel(String deleteLabel) |
void |
setDir(String dir) |
void |
setDisabled(boolean disabled) |
void |
setDoneLabel(String doneLabel) |
void |
setExecute(Object execute) |
void |
setFileUploadListener(javax.el.MethodExpression fileUploadListener) |
void |
setImmediateUpload(boolean immediateUpload) |
void |
setLang(String lang) |
void |
setLimitRender(boolean limitRender) |
void |
setListHeight(String listHeight) |
void |
setMaxFilesQuantity(Integer maxFilesQuantity) |
void |
setNoDuplicate(boolean noDuplicate) |
void |
setOnbeforedomupdate(String onbeforedomupdate) |
void |
setOnbegin(String onbegin) |
void |
setOnclear(String onclear) |
void |
setOnclick(String onclick) |
void |
setOncomplete(String oncomplete) |
void |
setOndblclick(String ondblclick) |
void |
setOnfileselect(String onfileselect) |
void |
setOnfilesubmit(String onfilesubmit) |
void |
setOnkeydown(String onkeydown) |
void |
setOnkeypress(String onkeypress) |
void |
setOnkeyup(String onkeyup) |
void |
setOnmousedown(String onmousedown) |
void |
setOnmousemove(String onmousemove) |
void |
setOnmouseout(String onmouseout) |
void |
setOnmouseover(String onmouseover) |
void |
setOnmouseup(String onmouseup) |
void |
setOntyperejected(String ontyperejected) |
void |
setOnuploadcomplete(String onuploadcomplete) |
void |
setRender(Object render) |
void |
setResetValues(boolean resetValues) |
void |
setServerErrorLabel(String serverErrorLabel) |
void |
setSizeExceededLabel(String sizeExceededLabel) |
void |
setStatus(String status) |
void |
setStyle(String style) |
void |
setStyleClass(String styleClass) |
void |
setTitle(String title) |
void |
setUploadLabel(String uploadLabel) |
acceptsFile, addFileUploadListener, getAcceptedTypesList, getFileUploadListeners, processEvent, queueEvent, removeFileUploadListener
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public String getFamily()
getFamily
in class javax.faces.component.UIComponent
public Collection<String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
getEventNames
in class javax.faces.component.UIComponentBase
public String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class javax.faces.component.UIComponentBase
public String getAcceptedTypes()
AbstractFileUpload
getAcceptedTypes
in class AbstractFileUpload
public void setAcceptedTypes(String acceptedTypes)
public String getAddLabel()
AbstractFileUpload
getAddLabel
in class AbstractFileUpload
public void setAddLabel(String addLabel)
public String getClearAllLabel()
AbstractFileUpload
getClearAllLabel
in class AbstractFileUpload
public void setClearAllLabel(String clearAllLabel)
public String getClearLabel()
AbstractFileUpload
getClearLabel
in class AbstractFileUpload
public void setClearLabel(String clearLabel)
public Object getData()
AjaxActivatorProps
getData
in interface AjaxActivatorProps
public void setData(Object data)
public String getDeleteLabel()
AbstractFileUpload
getDeleteLabel
in class AbstractFileUpload
public void setDeleteLabel(String deleteLabel)
public String getDir()
I18nProps
public void setDir(String dir)
public boolean isDisabled()
DisabledProps
isDisabled
in interface DisabledProps
public void setDisabled(boolean disabled)
public String getDoneLabel()
AbstractFileUpload
getDoneLabel
in class AbstractFileUpload
public void setDoneLabel(String doneLabel)
public Object getExecute()
AjaxProps
getExecute
in interface AjaxProps
public void setExecute(Object execute)
public javax.el.MethodExpression getFileUploadListener()
AbstractFileUpload
getFileUploadListener
in class AbstractFileUpload
public void setFileUploadListener(javax.el.MethodExpression fileUploadListener)
public boolean isImmediateUpload()
AbstractFileUpload
If "true" upload stats immediately after file selection
Default is "false"
isImmediateUpload
in class AbstractFileUpload
public void setImmediateUpload(boolean immediateUpload)
public String getLang()
I18nProps
public void setLang(String lang)
public boolean isLimitRender()
AjaxActivatorProps
isLimitRender
in interface AjaxActivatorProps
public void setLimitRender(boolean limitRender)
public String getListHeight()
AbstractFileUpload
Defines height of file list.
Default value is "210px".
getListHeight
in class AbstractFileUpload
public void setListHeight(String listHeight)
public Integer getMaxFilesQuantity()
AbstractFileUpload
getMaxFilesQuantity
in class AbstractFileUpload
public void setMaxFilesQuantity(Integer maxFilesQuantity)
public boolean isNoDuplicate()
AbstractFileUpload
If "true" duplicate file uploads are prevented
Default is "false"
isNoDuplicate
in class AbstractFileUpload
public void setNoDuplicate(boolean noDuplicate)
public String getOnbeforedomupdate()
AjaxActivatorProps
getOnbeforedomupdate
in interface AjaxActivatorProps
public void setOnbeforedomupdate(String onbeforedomupdate)
public String getOnbegin()
AjaxProps
getOnbegin
in interface AjaxProps
public void setOnbegin(String onbegin)
public String getOnclear()
AbstractFileUpload
getOnclear
in class AbstractFileUpload
public void setOnclear(String onclear)
public String getOnclick()
EventsMouseProps
getOnclick
in interface EventsMouseProps
public void setOnclick(String onclick)
public String getOncomplete()
AjaxActivatorProps
getOncomplete
in interface AjaxActivatorProps
public void setOncomplete(String oncomplete)
public String getOndblclick()
EventsMouseProps
getOndblclick
in interface EventsMouseProps
public void setOndblclick(String ondblclick)
public String getOnfileselect()
AbstractFileUpload
getOnfileselect
in class AbstractFileUpload
public void setOnfileselect(String onfileselect)
public String getOnfilesubmit()
AbstractFileUpload
getOnfilesubmit
in class AbstractFileUpload
public void setOnfilesubmit(String onfilesubmit)
public String getOnkeydown()
EventsKeyProps
getOnkeydown
in interface EventsKeyProps
public void setOnkeydown(String onkeydown)
public String getOnkeypress()
EventsKeyProps
getOnkeypress
in interface EventsKeyProps
public void setOnkeypress(String onkeypress)
public String getOnkeyup()
EventsKeyProps
getOnkeyup
in interface EventsKeyProps
public void setOnkeyup(String onkeyup)
public String getOnmousedown()
EventsMouseProps
getOnmousedown
in interface EventsMouseProps
public void setOnmousedown(String onmousedown)
public String getOnmousemove()
EventsMouseProps
getOnmousemove
in interface EventsMouseProps
public void setOnmousemove(String onmousemove)
public String getOnmouseout()
EventsMouseProps
getOnmouseout
in interface EventsMouseProps
public void setOnmouseout(String onmouseout)
public String getOnmouseover()
EventsMouseProps
getOnmouseover
in interface EventsMouseProps
public void setOnmouseover(String onmouseover)
public String getOnmouseup()
EventsMouseProps
getOnmouseup
in interface EventsMouseProps
public void setOnmouseup(String onmouseup)
public String getOntyperejected()
AbstractFileUpload
getOntyperejected
in class AbstractFileUpload
public void setOntyperejected(String ontyperejected)
public String getOnuploadcomplete()
AbstractFileUpload
getOnuploadcomplete
in class AbstractFileUpload
public void setOnuploadcomplete(String onuploadcomplete)
public Object getRender()
AjaxActivatorProps
getRender
in interface AjaxActivatorProps
public void setRender(Object render)
public boolean isResetValues()
AjaxActivatorProps
isResetValues
in interface AjaxActivatorProps
public void setResetValues(boolean resetValues)
public String getServerErrorLabel()
AbstractFileUpload
getServerErrorLabel
in class AbstractFileUpload
public void setServerErrorLabel(String serverErrorLabel)
public String getSizeExceededLabel()
AbstractFileUpload
getSizeExceededLabel
in class AbstractFileUpload
public void setSizeExceededLabel(String sizeExceededLabel)
public String getStatus()
AjaxProps
public void setStatus(String status)
public String getStyle()
CoreProps
public void setStyle(String style)
public String getStyleClass()
CoreProps
getStyleClass
in interface CoreProps
public void setStyleClass(String styleClass)
public String getTitle()
CoreProps
public void setTitle(String title)
public String getUploadLabel()
AbstractFileUpload
getUploadLabel
in class AbstractFileUpload
public void setUploadLabel(String uploadLabel)
Copyright © 2015 JBoss by Red Hat. All Rights Reserved.