|
RichFaces UI Components UI 4.3.0.CR1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
org.richfaces.component.AbstractFileUpload
org.richfaces.component.UIFileUpload
@Generated(value={"RichFaces CDK","4.3.0.CR1"})
public class UIFileUpload
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.
| Nested Class Summary | |
|---|---|
protected static class |
UIFileUpload.Properties
|
| Field Summary | |
|---|---|
static String |
COMPONENT_FAMILY
|
static String |
COMPONENT_TYPE
|
| Fields inherited from class javax.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 |
| Constructor Summary | |
|---|---|
UIFileUpload()
|
|
| Method Summary | |
|---|---|
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()
|
String |
getDefaultEventName()
|
String |
getDeleteLabel()
The label displayed for the Delete link |
String |
getDir()
|
String |
getDoneLabel()
The label displayed when a file is successfully uploaded. |
Collection<String> |
getEventNames()
|
Object |
getExecute()
|
String |
getFamily()
|
javax.el.MethodExpression |
getFileUploadListener()
|
String |
getLang()
|
String |
getListHeight()
Defines height of file list. |
String |
getMaxFilesQuantity()
Defines maximum number of files allowed to be uploaded. |
String |
getOnbeforedomupdate()
|
String |
getOnbegin()
|
String |
getOnclear()
Javascript code executed when a file is cleared |
String |
getOnclick()
|
String |
getOncomplete()
|
String |
getOndblclick()
|
String |
getOnfileselect()
Javascript code executed when a file is selected |
String |
getOnfilesubmit()
Javascript code executed when a file is submitted |
String |
getOnkeydown()
|
String |
getOnkeypress()
|
String |
getOnkeyup()
|
String |
getOnmousedown()
|
String |
getOnmousemove()
|
String |
getOnmouseout()
|
String |
getOnmouseover()
|
String |
getOnmouseup()
|
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()
|
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()
|
String |
getStyle()
|
String |
getStyleClass()
|
String |
getTitle()
|
String |
getUploadLabel()
The label for the Add button. |
boolean |
isDisabled()
If "true", this component is disabled |
boolean |
isImmediateUpload()
If "true" upload stats immediately after file selection |
boolean |
isLimitRender()
|
boolean |
isNoDuplicate()
If "true" duplicate file uploads are prevented |
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(String 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 |
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)
|
| Methods inherited from class org.richfaces.component.AbstractFileUpload |
|---|
addFileUploadListener, getFileUploadListeners, processEvent, removeFileUploadListener |
| Methods inherited from class javax.faces.component.UIComponentBase |
|---|
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, 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 javax.faces.component.UIComponent |
|---|
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree |
| 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 |
| Field Detail |
|---|
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
| Constructor Detail |
|---|
public UIFileUpload()
| Method Detail |
|---|
public String getFamily()
getFamily in class javax.faces.component.UIComponentpublic Collection<String> getEventNames()
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHoldergetEventNames in class javax.faces.component.UIComponentBasepublic String getDefaultEventName()
getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHoldergetDefaultEventName in class javax.faces.component.UIComponentBasepublic String getAcceptedTypes()
AbstractFileUpload
getAcceptedTypes in class AbstractFileUploadpublic void setAcceptedTypes(String acceptedTypes)
public String getAddLabel()
AbstractFileUpload
getAddLabel in class AbstractFileUploadpublic void setAddLabel(String addLabel)
public String getClearAllLabel()
AbstractFileUpload
getClearAllLabel in class AbstractFileUploadpublic void setClearAllLabel(String clearAllLabel)
public String getClearLabel()
AbstractFileUpload
getClearLabel in class AbstractFileUploadpublic void setClearLabel(String clearLabel)
public Object getData()
public void setData(Object data)
public String getDeleteLabel()
AbstractFileUpload
getDeleteLabel in class AbstractFileUploadpublic void setDeleteLabel(String deleteLabel)
public String getDir()
public void setDir(String dir)
public boolean isDisabled()
AbstractFileUpload
isDisabled in class AbstractFileUploadpublic void setDisabled(boolean disabled)
public String getDoneLabel()
AbstractFileUpload
getDoneLabel in class AbstractFileUploadpublic void setDoneLabel(String doneLabel)
public Object getExecute()
public void setExecute(Object execute)
public javax.el.MethodExpression getFileUploadListener()
public void setFileUploadListener(javax.el.MethodExpression fileUploadListener)
public boolean isImmediateUpload()
AbstractFileUploadIf "true" upload stats immediately after file selection
Default is "false"
isImmediateUpload in class AbstractFileUploadpublic void setImmediateUpload(boolean immediateUpload)
public String getLang()
public void setLang(String lang)
public boolean isLimitRender()
public void setLimitRender(boolean limitRender)
public String getListHeight()
AbstractFileUploadDefines height of file list.
Default value is "210px".
getListHeight in class AbstractFileUploadpublic void setListHeight(String listHeight)
public String getMaxFilesQuantity()
AbstractFileUpload
getMaxFilesQuantity in class AbstractFileUploadpublic void setMaxFilesQuantity(String maxFilesQuantity)
public boolean isNoDuplicate()
AbstractFileUploadIf "true" duplicate file uploads are prevented
Default is "false"
isNoDuplicate in class AbstractFileUploadpublic void setNoDuplicate(boolean noDuplicate)
public String getOnbeforedomupdate()
public void setOnbeforedomupdate(String onbeforedomupdate)
public String getOnbegin()
public void setOnbegin(String onbegin)
public String getOnclear()
AbstractFileUpload
getOnclear in class AbstractFileUploadpublic void setOnclear(String onclear)
public String getOnclick()
public void setOnclick(String onclick)
public String getOncomplete()
public void setOncomplete(String oncomplete)
public String getOndblclick()
public void setOndblclick(String ondblclick)
public String getOnfileselect()
AbstractFileUpload
getOnfileselect in class AbstractFileUploadpublic void setOnfileselect(String onfileselect)
public String getOnfilesubmit()
AbstractFileUpload
getOnfilesubmit in class AbstractFileUploadpublic void setOnfilesubmit(String onfilesubmit)
public String getOnkeydown()
public void setOnkeydown(String onkeydown)
public String getOnkeypress()
public void setOnkeypress(String onkeypress)
public String getOnkeyup()
public void setOnkeyup(String onkeyup)
public String getOnmousedown()
public void setOnmousedown(String onmousedown)
public String getOnmousemove()
public void setOnmousemove(String onmousemove)
public String getOnmouseout()
public void setOnmouseout(String onmouseout)
public String getOnmouseover()
public void setOnmouseover(String onmouseover)
public String getOnmouseup()
public void setOnmouseup(String onmouseup)
public String getOntyperejected()
AbstractFileUpload
getOntyperejected in class AbstractFileUploadpublic void setOntyperejected(String ontyperejected)
public String getOnuploadcomplete()
AbstractFileUpload
getOnuploadcomplete in class AbstractFileUploadpublic void setOnuploadcomplete(String onuploadcomplete)
public Object getRender()
public void setRender(Object render)
public String getServerErrorLabel()
AbstractFileUpload
getServerErrorLabel in class AbstractFileUploadpublic void setServerErrorLabel(String serverErrorLabel)
public String getSizeExceededLabel()
AbstractFileUpload
getSizeExceededLabel in class AbstractFileUploadpublic void setSizeExceededLabel(String sizeExceededLabel)
public String getStatus()
public void setStatus(String status)
public String getStyle()
public void setStyle(String style)
public String getStyleClass()
public void setStyleClass(String styleClass)
public String getTitle()
public void setTitle(String title)
public String getUploadLabel()
AbstractFileUpload
getUploadLabel in class AbstractFileUploadpublic void setUploadLabel(String uploadLabel)
|
RichFaces UI Components UI 4.3.0.CR1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||