JsDoc Reference - jsf (original) (raw)

Namespace jsf

The top level global namespace for JavaServer Faces functionality.
Defined in: jsf.js.

Namespace Summary

Field Summary

Method Summary

Namespace Detail

jsf

The top level global namespace for JavaServer Faces functionality.

Field Detail

jsf.implversion

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

jsf.separatorchar

The result of callingUINamingContainer.getNamingContainerSeparatorChar().

jsf.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.

Method Detail

jsf.getClientWindow()

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

Parameters:

{optional String|DomNode} node.

Determine the nature of the argument. If not present, search for the windowId withindocument.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.

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.

jsf.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) {
 ...
}

Returns:

String String representing the current state of the running application in a typical product development lifecycle. Refer to javax.faces.application.Application.getProjectStage andjavax.faces.application.ProjectStage.

jsf.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:

form

The form element whose containedinput 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.

Returns:

String The encoded state for the specified form's input controls.

Documentation generated by JsDoc Toolkit 2.0.2 on Tue Sep 05 2017 18:26:11 GMT-0400 (EDT)