Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Type aliases

ShorthandConfiguration

ShorthandConfiguration: RenameKeys<Configuration, { ajax: "a"; focus: "f"; highlight: "h"; process: "p"; renderMessages: "r"; source: "s"; update: "u"; validateInvisibleElements: "v" }>

Options passed to PrimeFaces.vb as shortcut. This is the same as Configuration, but with shorter option names and is used mainly by the method PrimeFaces.vb. See Configuration for a detailed description of these options.

Variables

CFG_SHORTCUTS

CFG_SHORTCUTS: Record<string, string>

Parameter shortcut mapping for the method PrimeFaces.vb.

Functions

validate

  • Triggers client-side-validation of single or multiple containers (complex validation or simple inputs).

    Parameters

    • process: string | HTMLElement | JQuery<HTMLElement>

      The elements to be processed.

    • update: string | HTMLElement | JQuery<HTMLElement>

      The elements to be updated.

    • highlight: boolean

      If invalid elements should be highlighted.

    • focus: boolean

      If the first invalid element should be focused.

    • renderMessages: boolean

      If messages should be rendered.

    • validateInvisibleElements: boolean

      If invisible elements should be validated.

    Returns boolean

    true if the request would not result in validation errors, or false otherwise.

validateComplex

  • NOTE: This is a internal method and should only by used by PrimeFaces.validation.validate.

    Performs a client-side validation of (the value of) the given container element. If the element is valid, removes old messages from the element. If the value of the element is invalid, adds the appropriate validation failure messages.

    internal

    Parameters

    • element: JQuery<HTMLElement>

      A JQuery instance with a single input element to validate.

    • highlight: boolean

      If the invalid element should be highlighted.

    Returns boolean

    true if the value of the element is valid, false otherwise.

validateInput

  • NOTE: This is a internal method and should only by used by PrimeFaces.validation.validate.

    Performs a client-side validation of (the value of) the given input element. If the element is valid, removes old messages from the element. If the value of the element is invalid, adds the appropriate validation failure messages.

    internal

    Parameters

    • element: JQuery<HTMLElement>

      A JQuery instance with a single input element to validate.

    • highlight: boolean

      If the invalid element should be highlighted.

    Returns void

validateInstant

  • Performs a client-side validation of the given element. The context of this validation is a single field only. If the element is valid, removes old messages from the element. If the value of the element is invalid, adds the appropriate validation failure messages. This is used by p:clientValidator.

    Parameters

    Returns boolean

    true if the element is valid, or false otherwise.

Generated using TypeDoc