Options
All
  • Public
  • Public/Protected
  • All
Menu

The configuration for the Spinner widget. You can access this configuration via BaseWidget.cfg. Please note that this configuration is usually meant to be read-only and should not be modified.

Hierarchy

Index

Properties

behaviors

behaviors: Record<string, Behavior>

A map with all behaviors that were defined for this widget. The key is the name of the behavior, the value is the callback function that is invoked when the behavior is called.

decimalPlaces

decimalPlaces: string

Number of decimal places.

decimalSeparator

decimalSeparator: string

The character separating the integral and fractional parts of the number.

Optional formId

formId?: string

ID of the form to use for AJAX requests.

id

id: string | string[]

The client-side ID of the widget, with all parent naming containers, such as myForm:myWidget. This is also the ID of the container HTML element for this widget. In case the widget needs multiple container elements (such as Paginator), this may also be an array if IDs.

max

max: number

Minimum allowed value for this spinner.

maxlength

maxlength: number

Maximum number of characters that may be entered in this field.

min

min: number

Minimum allowed value for this spinner.

postConstruct

postConstruct: PostConstructCallback

An optional callback that is invoked after this widget was created successfully, at the end of the init method. This is usually specified via the widgetPostConstruct attribute on the JSF component. Note that this is also called during a refresh (AJAX update).

postRefresh

postRefresh: PostRefreshCallback

An optional callback that is invoked after this widget was refreshed after an AJAX update, at the end of the refresh method. This is usually specified via the widgetPostRefresh attribute on the JSF component.

preDestroy

preDestroy: PreDestroyCallback

An optional callback that is invoked before this widget is about to be destroyed, e.g. when the component was removed at the end of an AJAX update. This is called at the beginning of the destroy method. This is usually specified via the widgetPreDestroy attribute on the JSF component.

precision

precision: number

The number of digits to appear after the decimal point.

prefix

prefix: string

Prefix added to the displayed value.

required

required: boolean

Whether this spinner is a required field.

rotate

rotate: boolean

Rotate to the minimum value when maximum value is reached and vice versa.

step

step: number

Stepping factor for each increment and decrement

suffix

suffix: string

Suffix added to the displayed value.

thousandSeparator

thousandSeparator: string

Character for the integral part of the number that separates each group of three digits.

widgetVar

widgetVar: string

The name of the widget variables of this widget. The widget variable can be used to access a widget instance by calling PF("myWidgetVar").

Generated using TypeDoc