Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BaseWidget<TConf>

The base class of all PrimeFaces widgets from which they are derive.

Type parameters

  • TConf = BaseWidgetCfg

Hierarchy

Index

Properties

Methods

Properties

cfg

cfg: TConf

The widget-specific configuration of this widget instance.

id

id: string

jq

jq: JQuery

A reference to the base (container) element of this widget.

jqEl

jqEl: HTMLElement

A reference to the base (container) element of this widget.

jqId

jqId: string

widgetVar

widgetVar: string

The widget variable of this widget instance.

Methods

callBehavior

  • callBehavior(name: string, ...args: unknown[]): void

  • If it exists, calls the behavior with the given name.

    Parameters

    • name: string

      Name of the behavior.

    • Rest ...args: unknown[]

      Additional arguments for the behavior.

    Returns void

destroy

  • destroy(): void

  • Destroys this widget. Called by the PrimeFaces framework.

    Returns void

getJQ

  • getJQ(): JQuery

  • Returns JQuery

    A reference to the base (container) element of this widget.

hasBehavior

  • hasBehavior(name: string): boolean

  • Parameters

    • name: string

      Name of the behavior to check.

    Returns boolean

    Whether any handlers are registered for the given behavior.

init

  • init(configuration: {}): void

  • Initializes this widget. Called by the PrimeFaces framework.

    Parameters

    • configuration: {}

      Configuration as set on the server-side.

      • [key: string]: any

    Returns void

isDetached

  • isDetached(): boolean

  • Whether this widget is attached to the DOM currently.

    Returns boolean

refresh

  • refresh(configuration: {}): void

  • Refreshes this widget with the given configuration.

    Parameters

    • configuration: {}

      New configuration for this widget.

      • [key: string]: any

    Returns void

removeScriptElement

  • removeScriptElement(clientId: string): void

  • Parameters

    • clientId: string

      Client ID of the script element to remove.

    Returns void

Generated using TypeDoc