Options
All
  • Public
  • Public/Protected
  • All
Menu

The configuration for the InputNumber 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

Optional allowDecimalPadding

allowDecimalPadding?: boolean | "floats"

Allow padding the decimal places with zeros.

default

true

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.

Optional caretPositionOnFocus

caretPositionOnFocus?: CaretPositionOption

Determine where should be positioned the caret on focus

default

null

Optional createLocalList

createLocalList?: boolean

Determine if a local list of AutoNumeric objects must be kept when initializing the elements and others

default

true

Optional currencySymbol

currencySymbol?: string

Currency symbol

default

''

Optional currencySymbolPlacement

currencySymbolPlacement?: CurrencySymbolPlacementOption

Placement of the currency sign, relative to the number (as a prefix or a suffix)

default

'p'

Optional decimalCharacter

decimalCharacter?: string

Decimal separator character

default

'.'

Optional decimalCharacterAlternative

decimalCharacterAlternative?: null | string

Allow to declare alternative decimal separator which is automatically replaced by the real decimal character

default

null

Optional decimalPlaces

decimalPlaces?: number

Defines the default number of decimal places to show on the formatted value, and to keep as the precision for the rawValue 0 or positive integer

default

2

Optional decimalPlacesRawValue

decimalPlacesRawValue?: null | number

Defines how many decimal places should be kept for the raw value.

default

null

Optional decimalPlacesShownOnBlur

decimalPlacesShownOnBlur?: null | number

The number of decimal places to show when unfocused

default

null

Optional decimalPlacesShownOnFocus

decimalPlacesShownOnFocus?: null | number

The number of decimal places to show when focused

default

null

Optional defaultValueOverride

defaultValueOverride?: string | { doNotOverride: null }

Helper option for ASP.NET postback This should be set as the value of the unformatted default value examples: no default value="" {defaultValueOverride: ""} value=1234.56 {defaultValueOverride: '1234.56'}

default

null

Optional digitGroupSeparator

digitGroupSeparator?: string

Thousand separator character

default

','

Optional digitalGroupSpacing

digitalGroupSpacing?: string

Digital grouping for the thousand separator

default

'3'

disabled

disabled: boolean

Whether this widget is initially disabled.

Optional divisorWhenUnfocused

divisorWhenUnfocused?: null | number

Define the number that will divide the current value shown when unfocused

default

null

Optional emptyInputBehavior

emptyInputBehavior?: EmptyInputBehaviorOption

Optional failOnUnknownOption

failOnUnknownOption?: boolean

Optional formId

formId?: string

ID of the form to use for AJAX requests.

Optional formatOnPageLoad

formatOnPageLoad?: boolean

Optional historySize

historySize?: number

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.

Optional isCancellable

isCancellable?: boolean

Optional leadingZero

leadingZero?: LeadingZeroOption

Optional maximumValue

maximumValue?: string

Optional minimumValue

minimumValue?: string

Optional modifyValueOnWheel

modifyValueOnWheel?: boolean

Determine if the element value can be incremented / decremented with the mouse wheel.

Optional negativeBracketsTypeOnBlur

negativeBracketsTypeOnBlur?: null | string

Optional negativePositiveSignPlacement

negativePositiveSignPlacement?: NegativePositiveSignPlacementOption

Placement of negative/positive sign relative to the currency symbol (possible options are l (left), r (right), p (prefix) and s (suffix))

default

null

Optional noEventListeners

noEventListeners?: boolean

Optional onInvalidPaste

onInvalidPaste?: OnInvalidPasteOption

Optional outputFormat

outputFormat?: OutputFormatOption

Optional overrideMinMaxLimits

overrideMinMaxLimits?: OverrideMinMaxLimitsOption

pluginOptions

pluginOptions: undefined

Always undefined.

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.

Optional rawValueDivisor

rawValueDivisor?: null | number

Optional readOnly

readOnly?: boolean

Optional roundingMethod

roundingMethod?: RoundingMethodOption

Optional saveValueToSessionStorage

saveValueToSessionStorage?: boolean

Optional selectNumberOnly

selectNumberOnly?: boolean

Optional selectOnFocus

selectOnFocus?: boolean

Optional serializeSpaces

serializeSpaces?: SerializeSpacesOption

Optional showOnlyNumbersOnFocus

showOnlyNumbersOnFocus?: boolean

Optional showPositiveSign

showPositiveSign?: boolean

Optional showWarnings

showWarnings?: boolean

Optional styleRules

styleRules?: null | { negative?: string; positive?: null | string; ranges?: { class: string; max: number; min: number }[]; userDefined?: ({ classes: [string, string] | [string]; callback: any } | { classes: string[]; callback: any } | { callback: any })[] }

Optional suffixText

suffixText?: string

Optional symbolWhenUnfocused

symbolWhenUnfocused?: null | string

Optional unformatOnHover

unformatOnHover?: boolean

Optional unformatOnSubmit

unformatOnSubmit?: boolean

valueToRender

valueToRender: string

The initial, numerical value that is displayed, such as 0.0 or 5.3.

Optional wheelStep

wheelStep?: number | "progressive"

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