Namespace: jsf

jsf

The top level global namespace for JavaServer Faces functionality.
Source:

Namespaces

ajax
push
util

Members

(static) ajax

Register a callback for error handling.

Usage:


jsf.ajax.addOnError(handleError);
...
var handleError = function handleError(data) {
...
}

Implementation Requirements:

This function must accept a reference to an existing JavaScript function. The JavaScript function reference must be added to a list of callbacks, making it possible to register more than one callback by invoking jsf.ajax.addOnError more than once. This function must throw an error if the callback argument is not a function.
Source:

(static) ajax

Register a callback for event handling.

Usage:


jsf.ajax.addOnEvent(statusUpdate);
...
var statusUpdate = function statusUpdate(data) {
...
}

Implementation Requirements:

This function must accept a reference to an existing JavaScript function. The JavaScript function reference must be added to a list of callbacks, making it possible to register more than one callback by invoking jsf.ajax.addOnEvent more than once. This function must throw an error if the callback argument is not a function.
Source:

(static) contextpath

The result of calling ExternalContext.getRequestContextPath().

Source:

(static) implversion

An integer specifying the implementation version that this file implements. It's a monotonically increasing number, reset with every increment of jsf.specversion This number is implementation dependent.

Source:

(static) separatorchar

The result of calling UINamingContainer.getNamingContainerSeparatorChar().

Source:

(static) specversion

An integer specifying the specification version that this file implements. Its format is: rightmost two digits, bug release number, next two digits, minor release number, leftmost digits, major release number. This number may only be incremented by a new release of the specification.

Source:

Methods

(static) getClientWindow(node)

Return the windowId of the window in which the argument form is rendered.

Parameters:
Name Type Description
node DomNode Determine the nature of the argument. If not present, search for the windowId within document.forms. If present and the value is a string, assume the string is a DOM id and get the element with that id and start the search from there. If present and the value is a DOM element, start the search from there.
Source:
Throws:
an error if more than one unique WindowId is found.
Returns:
String The windowId of the current window, or null if the windowId cannot be determined.

(static) getProjectStage()

Return the value of Application.getProjectStage() for the currently running application instance. Calling this method must not cause any network transaction to happen to the server.

Usage:


var stage = jsf.getProjectStage();
if (stage === ProjectStage.Development) {
 ...
} else if stage === ProjectStage.Production) {
 ...
}
Source:
Returns:
String String representing the current state of the running application in a typical product development lifecycle. Refer to jakarta.faces.application.Application.getProjectStage and jakarta.faces.application.ProjectStage.

(static) getViewState(form)

Collect and encode state for input controls associated with the specified form element. This will include all input controls of type hidden.

Usage:


var state = jsf.getViewState(form);
Parameters:
Name Type Description
form The form element whose contained input controls will be collected and encoded. Only successful controls will be collected and encoded in accordance with: Section 17.13.2 of the HTML Specification.
Source:
Returns:
String The encoded state for the specified form's input controls.