|
ICEfaces ACE Components 3.3.0 Java API Documentation |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Objectjava.lang.Enum<FileEntryStatuses>
org.icefaces.ace.component.fileentry.FileEntryStatuses
public enum FileEntryStatuses
FileEntryStatuses are the built-in statuses which correspond to the localised messages defined in the org.icefaces.ace.resources.messages ResourceBundle. These can be overriden by specifing corresponding entries in the application ResourceBundle. Refer to the getParameters(-) javadoc for the MessageFormat parameters that are available to applications which override these messages. Note: PROBLEM_READING_MULTIPART does not have access to these parameters.
getParameters(javax.faces.context.FacesContext, javax.faces.component.UIComponent, org.icefaces.ace.component.fileentry.FileEntryResults.FileInfo)
,
PROBLEM_READING_MULTIPART
Enum Constant Summary | |
---|---|
INVALID
|
|
INVALID_CONTENT_TYPE
|
|
MAX_FILE_COUNT_EXCEEDED
|
|
MAX_FILE_SIZE_EXCEEDED
|
|
MAX_TOTAL_SIZE_EXCEEDED
|
|
PROBLEM_READING_MULTIPART
This one message is for when we have problems reading the multipart form submit, and so do not know which file or other form field has caused the postback to fail. |
|
PROBLEM_WITH_CALLBACK
If there's a RuntimeException thrown by the FileEntryCallback, this will be the status. |
|
REQUIRED
This one message is for when users have not uploaded a file, so there is no FileInfo to make use of, limiting the useful parameters to just the fileEntry label. |
|
SUCCESS
|
|
UNKNOWN_SIZE
|
|
UNSPECIFIED_NAME
|
|
UPLOADING
|
Method Summary | |
---|---|
javax.faces.application.FacesMessage |
getFacesMessage(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent fileEntry,
FileEntryResults.FileInfo fi)
|
protected javax.faces.application.FacesMessage |
getFacesMessage(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent fileEntry,
FileEntryResults.FileInfo fi,
java.lang.String pattern)
Some of the status messages can be overridden by attributes on the component, which specify the MessageFormat pattern themselves. |
protected java.lang.Object[] |
getParameters(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent fileEntry,
FileEntryResults.FileInfo fi)
When formatting the MessageFormat patterns that comes from the ResourceBundles, the following parameters are provided: param[0] : label (Identifies the fileEntry component) param[1] : fileName (The original file name, on user's computer) param[2] : contentType (MIME type of uploaded file) param[3] : file (Stored file, on server) param[4] : size (Size of the uploaded file) param[5] : maxTotalSize (Maximum sum of all uploaded file sizes) param[6] : maxFileSize (Maximum size of each uploaded file) param[7] : maxFileCount (Maximum number of uploaded files) |
protected java.lang.Object[] |
getParametersForRequired(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent fileEntry)
When formatting the MessageFormat patterns that comes from the ResourceBundles, for the required status, the following parameters are provided: param[0] : label (Identifies the fileEntry component) |
protected javax.faces.application.FacesMessage.Severity |
getSeverity()
|
boolean |
isSuccess()
|
static FileEntryStatuses |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. |
static FileEntryStatuses[] |
values()
Returns an array containing the constants of this enum type, in the order they're declared. |
Methods inherited from class java.lang.Enum |
---|
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Enum Constant Detail |
---|
public static final FileEntryStatuses UPLOADING
public static final FileEntryStatuses SUCCESS
public static final FileEntryStatuses INVALID
public static final FileEntryStatuses MAX_TOTAL_SIZE_EXCEEDED
public static final FileEntryStatuses MAX_FILE_SIZE_EXCEEDED
public static final FileEntryStatuses MAX_FILE_COUNT_EXCEEDED
public static final FileEntryStatuses REQUIRED
public static final FileEntryStatuses UNKNOWN_SIZE
public static final FileEntryStatuses UNSPECIFIED_NAME
public static final FileEntryStatuses INVALID_CONTENT_TYPE
public static final FileEntryStatuses PROBLEM_WITH_CALLBACK
public static final FileEntryStatuses PROBLEM_READING_MULTIPART
Method Detail |
---|
public static final FileEntryStatuses[] values()
for(FileEntryStatuses c : FileEntryStatuses.values()) System.out.println(c);
public static FileEntryStatuses valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.
java.lang.IllegalArgumentException
- if this enum type has no constant
with the specified namepublic boolean isSuccess()
isSuccess
in interface FileEntryStatus
public javax.faces.application.FacesMessage getFacesMessage(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent fileEntry, FileEntryResults.FileInfo fi)
getFacesMessage
in interface FileEntryStatus
facesContext
- FacesContextfileEntry
- FileEntryfi
- FileEntryResults.FileInfo
protected javax.faces.application.FacesMessage.Severity getSeverity()
protected java.lang.Object[] getParameters(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent fileEntry, FileEntryResults.FileInfo fi)
protected java.lang.Object[] getParametersForRequired(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent fileEntry)
protected javax.faces.application.FacesMessage getFacesMessage(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent fileEntry, FileEntryResults.FileInfo fi, java.lang.String pattern)
|
ICEfaces ACE Components 3.3.0 Java API Documentation |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |