Options
All
  • Public
  • Public/Protected
  • All
Menu

PrimeFaces FileUpload Widget

FileUpload goes beyond the browser input type="file" functionality and features an HTML5 powered rich solution with graceful degradation for legacy browsers.

Type Parameters

Hierarchy

Index

Constructors

  • Creates a new instance of this widget. Please note that you should NOT override this constructor. Instead, override the init method, which is called at the end of the constructor once the instance is created.

    Type Parameters

    Parameters

    • cfg: PartialWidgetCfg<TCfg>

      The widget configuration to be used for this widget instance. This widget configuration is usually created on the server by the javax.faces.render.Renderer for this component.

    Returns PrimeFaces.widget.FileUpload<TCfg>

Properties

IMAGE_TYPES: RegExp

Regular expression that matches image files for which a preview can be shown.

buttonBar: JQuery<HTMLElement>

The DOM element for the bar with the buttons of this widget.

cancelButton: JQuery<HTMLElement>

The DOM element for the button for canceling a file upload.

cfg: PartialWidgetCfg<TCfg>

The configuration of this widget instance. Please note that no property is guaranteed to be present, you should always check for undefined before accessing a property. This is partly because the value of a property is not transmitted from the server to the client when it equals the default.

chooseButton: JQuery<HTMLElement>

The DOM element for the button for selecting a file.

clearMessageLink: JQuery<HTMLElement>

The DOM element for the button to clear the file upload messages (which inform the user about whether a file was uploaded).

content: JQuery<HTMLElement>

The DOM element for the content of this widget.

customDropZone: string

Custom drop zone to use for drag and drop.

Array of registered listeners invoked when this widget is destroyed. You should normally not use modify this directly, use addDestroyListener instead.

dragoverCount: number

Amount of dragover on drop zone and its children.

dropZone: string

Drop zone to use for drag and drop.

fileAddIndex: number

Current index where to add files.

fileId: string

ID of the current file.

files: File[]

List of currently selected files.

filesTbody: JQuery<HTMLElement>

The DOM element for the table tbody with the files.

form: JQuery<HTMLElement>

The DOM element for the form containing this upload widget.

id: string | string[]

The client-side ID of this widget, with all parent naming containers, such as myForm:myWidget. This is also the ID of the container HTML element for this widget. In case the widget needs multiple container elements (such as Paginator), this may also be an array if IDs.

jq: JQuery<HTMLElement>

The jQuery instance of the container element of this widget. In case id is an array, it will contain multiple elements. Please note that some widgets have got not DOM elements at all, in this case this will be an empty jQuery instance.

jqId: string

A CSS selector for the container element (or elements, in case id is an array) of this widget, This is usually an ID selector (that is properly escaped). You can select the container element or elements like this: $(widget.jqId).

messageContainer: JQuery<HTMLElement>

The DOM element of the container with the file upload messages which inform the user about whether a file was uploaded.

messageList: JQuery<HTMLElement>

The DOM element of the UL list element with the file upload messages which inform the user about whether a file was uploaded.

Array of registered listeners invoked when this widget is refreshed. You should normally not use modify this directly, use addRefreshListener instead.

rowCancelActionSelector: string

Selector for the button for canceling a file upload.

Options for the BlueImp jQuery file upload plugin.

uploadButton: JQuery<HTMLElement>

The DOM element for the button for starting the file upload.

uploadedFileCount: number

Number of currently uploaded files.

widgetVar: string

The name of the widget variables of this widget. The widget variable can be used to access a widget instance by calling PF('myWidgetVar').

Methods

  • Lets you register a listener that is called before the component is destroyed.

    When an AJAX call is made and this component is updated, the DOM element is replaced with the newly rendered content. When the element is removed from the DOM by the update, the DOM element is detached from the DOM and all destroy listeners are called. This makes it possible to add listeners from outside the widget code.

    If you call this method twice with the same listener, it will be registered twice and later also called twice.

    Note that for this to work, you must not override the destroy method; or if you do, call super.

    Also, after this widget was detached is done, all destroy listeners will be unregistered.

    since

    7.0

    Parameters

    Returns void

  • Adds a file selected by the user to this upload widget.

    Parameters

    • file: File

      A file to add.

    • data: AddCallbackData

      The data from the selected file.

    Returns void

  • When an AJAX call is made and this component is updated, the DOM element is replaced with the newly rendered content. However, no new instance of the widget is created. Instead, after the DOM element was replaced, all refresh listeners are called. This makes it possible to add listeners from outside the widget code.

    If you call this method twice with the same listener, it will be registered twice and later also called twice.

    Note that for this to work, you must not override the refresh method; or if you do, call super.

    Also, after the refresh is done, all refresh listeners will be deregistered. If you added the listeners from within this widget, consider adding the refresh listeners not only in the init method, but also again in the refresh method after calling super.

    since

    7.0.0

    Parameters

    Returns void

  • bindEvents(): void
  • Sets up all events listeners for this file upload widget.

    Returns void

  • Each widget may have one or several behaviors attached to it. This method calls all attached behaviors for the given event name. In case no such behavior exists, this method does nothing and returns immediately.

    A behavior is a way for associating client-side scripts with UI components that opens all sorts of possibilities, including client-side validation, DOM and style manipulation, keyboard handling, and more. When the behavior is triggered, the configured JavaScript gets executed.

    Behaviors are often, but not necessarily, AJAX behavior. When triggered, it initiates a request the server and processes the response once it is received. This enables several features such as updating or replacing elements dynamically. You can add an AJAX behavior via <p:ajax event="name" actionListener="#{...}" onstart="..." />.

    since

    7.0

    Parameters

    • event: string

      The name of an event to call.

    • Optional ext: Partial<ConfigurationExtender>

      Additional configuration that is passed to the AJAX request for the server-side callback.

    Returns void

  • clear(): void
  • Clears this file upload field, i.e. removes all uploaded files.

    Returns void

  • clearMessages(): void
  • Removes all error messages that are shown for this widget.

    Returns void

  • Creates the HTML post data for uploading the selected files.

    Returns RequestParameter<string, unknown>

    Parameters to post when upload the files.

  • createXFileId(file: File): string
  • Creates a unique identifier (file key) for a given file. That identifier consists e.g. of the name of the uploaded file, its last modified-attribute etc. This is used by the server to identify uploaded files.

    Parameters

    • file: File

      A file for which to create an identifier.

    Returns string

    An identifier for the given file.

  • destroy(): void
  • Will be called after an AJAX request if the widget container will be detached.

    When an AJAX call is made and this component is updated, the DOM element is replaced with the newly rendered content. When the element is removed from the DOM by the update, the DOM element is detached from the DOM and this method gets called.

    Please note that instead of overriding this method, you should consider adding a destroy listener instead via addDestroyListener. This has the advantage of letting you add multiple listeners, and makes it possible to add additional listeners from code outside this widget.

    By default, this method just calls all destroy listeners.

    Returns void

  • disableButton(btn: JQuery<HTMLElement>): void
  • Disabled the given file upload button.

    Parameters

    • btn: JQuery<HTMLElement>

      Button to disabled.

    Returns void

  • enableButton(btn: JQuery<HTMLElement>): void
  • Enables the given file upload button.

    Parameters

    • btn: JQuery<HTMLElement>

      Button to enable.

    Returns void

  • getBehavior(name: string): null | Behavior
  • Each widget may have one or several behaviors attached to it. This method returns the callback function for the given event.

    Note: Do not call the method directly, the recommended way to invoke a behavior is via callBehavior.

    A behavior is a way for associating client-side scripts with UI components that opens all sorts of possibilities, including client-side validation, DOM and style manipulation, keyboard handling, and more. When the behavior is triggered, the configured JavaScript gets executed.

    Behaviors are often, but not necessarily, AJAX behavior. When triggered, it initiates a request the server and processes the response once it is received. This enables several features such as updating or replacing elements dynamically. You can add an AJAX behavior via <p:ajax event="name" actionListener="#{...}" onstart="..." />.

    Parameters

    • name: string

      The name of an event for which to retrieve the behavior.

    Returns null | Behavior

    The behavior with the given name, or null if no such behavior exists.

  • Each widget has got a container element, this method returns that container. This container element is usually also the element whose ID is the client-side ID of the JSF component.

    Returns JQuery<HTMLElement>

    The jQuery instance representing the main HTML container element of this widget.

  • getParentForm(): JQuery<HTMLElement>
  • Gets the closest parent form for this widget.

    since

    10.0.0

    Returns JQuery<HTMLElement>

    A JQuery instance that either contains the form when found, or an empty JQuery instance when the form could not be found.

  • getParentFormId(): undefined | string
  • Gets the closest parent form ID for this widget lazily so it can be used in AJAX requests.

    since

    10.0.0

    Returns undefined | string

    Either the form ID or undefined if no form can be found.

  • hasBehavior(event: string): boolean
  • Each widget may have one or several behaviors attached to it. This method checks whether this widget has got at least one behavior associated with given event name.

    A behavior is a way for associating client-side scripts with UI components that opens all sorts of possibilities, including client-side validation, DOM and style manipulation, keyboard handling, and more. When the behavior is triggered, the configured JavaScript gets executed.

    Behaviors are often, but not necessarily, AJAX behavior. When triggered, it initiates a request the server and processes the response once it is received. This enables several features such as updating or replacing elements dynamically. You can add an AJAX behavior via <p:ajax event="name" actionListener="#{...}" onstart="..." />.

    Parameters

    • event: string

      The name of an event to check.

    Returns boolean

    true if this widget has the given behavior, false otherwise.

  • A widget class should not declare an explicit constructor, the default constructor provided by this base widget should be used. Instead, override this initialize method which is called after the widget instance was constructed. You can use this method to perform any initialization that is required. For widgets that need to create custom HTML on the client-side this is also the place where you should call your render method.

    Please make sure to call the super method first before adding your own custom logic to the init method:

    PrimeFaces.widget.MyWidget = PrimeFaces.widget.BaseWidget.extend({
    init: function(cfg) {
    this._super(cfg);
    // custom initialization
    }
    });
    override

    Parameters

    • cfg: PartialWidgetCfg<TCfg>

      The widget configuration to be used for this widget instance. This widget configuration is usually created on the server by the javax.faces.render.Renderer for this component.

    Returns void

  • isDetached(): boolean
  • Checks if this widget is detached, ie whether the HTML element of this widget is currently contained within the DOM (the HTML body element). A widget may become detached during an AJAX update, and it may remain detached in case the update removed this component from the component tree.

    Returns boolean

    true if this widget is currently detached, or false otherwise.

  • Called after a file was added to this upload widget. Takes care of the UI buttons.

    Parameters

    Returns void

  • Used in ajax updates, reloads the widget configuration.

    When an AJAX call is made and this component is updated, the DOM element is replaced with the newly rendered content. However, no new instance of the widget is created. Instead, after the DOM element was replaced, this method is called with the new widget configuration from the server. This makes it possible to persist client-side state during an update, such as the currently selected tab.

    Please note that instead of overriding this method, you should consider adding a refresh listener instead via addRefreshListener. This has the advantage of letting you add multiple listeners, and makes it possible to add additional listeners from code outside this widget.

    By default, this method calls all refresh listeners, then reinitializes the widget by calling the init method.

    Parameters

    Returns unknown

    The value as returned by the init method, which is often undefined.

  • Removes the given uploaded file from this upload widget.

    Parameters

    • file: UploadFile

      File to remove from this widget.

    Returns void

  • removeFileRow(row: JQuery<HTMLElement>): void
  • Removes a row with an uploaded file form this upload widget.

    Parameters

    • row: JQuery<HTMLElement>

      Row of an uploaded file to remove.

    Returns void

  • Removes the given uploaded file from this upload widget.

    Parameters

    • files: UploadFile[]

      Files to remove from this widget.

    Returns void

  • removeScriptElement(clientId: string | string[]): void
  • Removes the widget's script block from the DOM. Currently, the ID of this script block consists of the client-side ID of this widget with the prefix _s, but this is subject to change.

    Parameters

    • clientId: string | string[]

      The client-side ID of the widget.

    Returns void

  • renderMessages(): void
  • Displays the current error messages on this widget.

    Returns void

  • show(): void
  • Brings up the native file selection dialog.

    Returns void

  • Shows the given error message

    Parameters

    Returns void

  • upload(): void
  • Uploads the selected files to the server.

    Returns void

Generated using TypeDoc