Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Highlighter

When an element is invalid due to a validation error, the user needs to be informed. This highlighter is responsible for changing the visual state of an element so that the user notices the invalid element.

Hierarchy

  • Highlighter

Index

Properties

Methods

Properties

types

types: Record<string, PrimeFaces.validation.Highlighter>

A map between a widget type and the corresponding highlight handler for that type.

Methods

applyStateCssClasses

  • applyStateCssClasses(element: JQuery<HTMLElement>, valid: boolean): void

  • Applies ui-state-XXX - css-classes to an element (component).

    Parameters

    • element: JQuery<HTMLElement>

      Element to which apply the css-classes.

    • valid: boolean

      Is the input of the element valid?

    Returns void

highlightLabel

  • highlightLabel(forElement: JQuery<HTMLElement>): void

  • When an element is invalid due to a validation error, the user needs to be informed. This method highlights the label for the given element by adding an appropriate CSS class.

    Parameters

    • forElement: JQuery<HTMLElement>

      Element with a label to highlight.

    Returns void

unhighlightLabel

  • unhighlightLabel(forElement: JQuery<HTMLElement>): void

  • When an element is invalid due to a validation error, the user needs to be informed. This method removes the highlighting on a label for the given element by removing the appropriate CSS class.

    Parameters

    • forElement: JQuery<HTMLElement>

      Element with a label to unhighlight.

    Returns void

Generated using TypeDoc