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

Interface JSFBlobUploader

All Known Implementing Classes:

BoxBlobUploader, DropboxBlobUploader, GoogleDriveBlobUploader, HTMLBlobUploader, OneDriveBlobUploader

public interface JSFBlobUploader

Interface for a Blob Uploader, a JSF helper that knows how to encode and validate a component to provide blob input in the JSF UI.

Since:

7.2

Method Summary

Modifier and Type	Method and Description
void	encodeBeginUpload(javax.faces.component.UIInput parent, javax.faces.context.FacesContext context, String onChange) Generates the HTML for an upload choice.
String	getChoice() Gets the choice key associated to this uploader.
void	hookSubComponent(javax.faces.component.UIInput parent) Constructs the needed subcomponent.
boolean	isEnabled() Checks if the uploader is enabled.
void	validateUpload(javax.faces.component.UIInput parent, javax.faces.context.FacesContext context, InputFileInfo submitted) Transforms input into a blob.

Method Detail

getChoice

String getChoice()

Gets the choice key associated to this uploader. This MUST start with "upload" for the display logic to work correctly.

hookSubComponent

void hookSubComponent(javax.faces.component.UIInput parent)

Constructs the needed subcomponent.

encodeBeginUpload

void encodeBeginUpload(javax.faces.component.UIInput parent,
                       javax.faces.context.FacesContext context,
                       String onChange)
                throws IOException

Generates the HTML for an upload choice.

Throws:

IOException

validateUpload

void validateUpload(javax.faces.component.UIInput parent,
                    javax.faces.context.FacesContext context,
                    InputFileInfo submitted)

Transforms input into a blob.

Parameters:

submitted - the value into which the input is stored

isEnabled

boolean isEnabled()

Checks if the uploader is enabled. Only enabled uploaders are added to the UI.

Since:

7.4