org.nuxeo.ecm.platform.ui.web.component.file

Class UIInputFile

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIOutput

javax.faces.component.UIInput

org.nuxeo.ecm.platform.ui.web.component.file.UIInputFile

All Implemented Interfaces:

EventListener, javax.faces.component.EditableValueHolder, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class UIInputFile
extends javax.faces.component.UIInput
implements javax.faces.component.NamingContainer

UIInput file that handles complex validation.

Attribute value is the file to be uploaded. Its submitted value as well as filename are handled by sub components. Rendering and validation of subcomponents are handled here.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CHOICE_FACET_NAME
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
protected static String	DEFAULT_DOWNLOAD_FACET_NAME
protected static String	DOWNLOAD_FACET_NAME
protected static String	EDIT_FILENAME_FACET_NAME
protected Boolean	editFilename
protected String	filename
protected static org.apache.commons.logging.Log	log
protected String	onchange
protected String	onclick
protected String	onselect
protected static String	UPLOAD_FACET_NAME
protected JSFBlobUploaderService	uploaderService

Fields inherited from class javax.faces.component.UIInput

CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME

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

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor and Description
UIInputFile()

Method Summary

Modifier and Type	Method and Description
void	decode(javax.faces.context.FacesContext context)
void	encodeBegin(javax.faces.context.FacesContext context)
protected List<String>	getAvailableChoices(Blob blob, boolean temp)
Blob	getCurrentBlob()
String	getCurrentFilename()
Boolean	getEditFilename()
InputFileInfo	getFileInfoLocalValue()
InputFileInfo	getFileInfoSubmittedValue()
InputFileInfo	getFileInfoValue()
String	getFilename()
String	getOnchange()
String	getOnclick()
String	getOnselect()
String	getRendererType()
protected String	getStringValue(String name, String defaultValue)
Object	getValue() Override value so that an InputFileInfo structure is given instead of the "value" attribute resolution.
void	restoreState(javax.faces.context.FacesContext context, Object state)
Object	saveState(javax.faces.context.FacesContext context)
void	setEditFilename(Boolean editFilename)
void	setFilename(String filename)
void	setOnchange(String onchange)
void	setOnclick(String onclick)
void	setOnselect(String onselect)
void	updateFilename(javax.faces.context.FacesContext context, String newFilename)
void	updateModel(javax.faces.context.FacesContext context)
void	validate(javax.faces.context.FacesContext context) Process validation.
void	validateFilename(javax.faces.context.FacesContext context, InputFileInfo submitted)

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, clearInitialState, compareValues, getConvertedValue, getConverterMessage, getFamily, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, validateValue

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, 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.ValueHolder

getConverter, getLocalValue, setConverter

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

CHOICE_FACET_NAME

protected static final String CHOICE_FACET_NAME

See Also:

Constant Field Values

UPLOAD_FACET_NAME

protected static final String UPLOAD_FACET_NAME

See Also:

Constant Field Values

DEFAULT_DOWNLOAD_FACET_NAME

protected static final String DEFAULT_DOWNLOAD_FACET_NAME

See Also:

Constant Field Values

DOWNLOAD_FACET_NAME

protected static final String DOWNLOAD_FACET_NAME

See Also:

Constant Field Values

EDIT_FILENAME_FACET_NAME

protected static final String EDIT_FILENAME_FACET_NAME

See Also:

Constant Field Values

log

protected static final org.apache.commons.logging.Log log

uploaderService

protected final JSFBlobUploaderService uploaderService

filename

protected String filename

editFilename

protected Boolean editFilename

onchange

protected String onchange

onclick

protected String onclick

onselect

protected String onselect

Constructor Detail

UIInputFile

public UIInputFile()

Method Detail

getRendererType

public String getRendererType()

Overrides:

getRendererType in class javax.faces.component.UIComponentBase

getValue

public Object getValue()

Override value so that an InputFileInfo structure is given instead of the "value" attribute resolution.

Specified by:

getValue in interface javax.faces.component.ValueHolder

Overrides:

getValue in class javax.faces.component.UIInput

getFilename

public String getFilename()

setFilename

public void setFilename(String filename)

getEditFilename

public Boolean getEditFilename()

setEditFilename

public void setEditFilename(Boolean editFilename)

getFileInfoValue

public InputFileInfo getFileInfoValue()

getFileInfoLocalValue

public InputFileInfo getFileInfoLocalValue()

getFileInfoSubmittedValue

public InputFileInfo getFileInfoSubmittedValue()

getStringValue

protected String getStringValue(String name,
                                String defaultValue)

getOnchange

public String getOnchange()

setOnchange

public void setOnchange(String onchange)

getOnclick

public String getOnclick()

setOnclick

public void setOnclick(String onclick)

getOnselect

public String getOnselect()

setOnselect

public void setOnselect(String onselect)

decode

public void decode(javax.faces.context.FacesContext context)

Overrides:

decode in class javax.faces.component.UIInput

validate

public void validate(javax.faces.context.FacesContext context)

Process validation. Sub components are already validated.

Overrides:

validate in class javax.faces.component.UIInput

validateFilename

public void validateFilename(javax.faces.context.FacesContext context,
                             InputFileInfo submitted)

updateFilename

public void updateFilename(javax.faces.context.FacesContext context,
                           String newFilename)

updateModel

public void updateModel(javax.faces.context.FacesContext context)

Overrides:

updateModel in class javax.faces.component.UIInput

getAvailableChoices

protected List<String> getAvailableChoices(Blob blob,
                                           boolean temp)

getCurrentBlob

public Blob getCurrentBlob()

getCurrentFilename

public String getCurrentFilename()

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext context)
                 throws IOException

Overrides:

encodeBegin in class javax.faces.component.UIComponentBase

Throws:

IOException

saveState

public Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIInput

restoreState

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

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIInput