Class: StepperFormCellProxy¶
StepperFormCellProxy is a developer-facing interface that provides access to a Stepper control and allows customizations. In addition it provides access to the IFormCellProxy interface.
Hierarchy¶
-
StepperFormCellProxy
Implements¶
Summary¶
Constructors¶
Properties¶
Class Properties¶
Currently none in this class.
Inherited Properties¶
Accessors¶
Class Accessors¶
Currently none in this class.
Inherited Accessors¶
Methods¶
Class Methods¶
- clearValidation
- getDecimalPlacesSupported
- getDecrementIcon
- getDecrementIconIsCircular
- getEditable
- getIncrementIcon
- getIncrementIconIsCircular
- getMaxValue
- getMinValue
- getStepValue
- getStyle
- getValidation
- getValue
- getVisible
- setDecimalPlacesSupported
- setDecrementIcon
- setDecrementIconIsCircular
- setEditable
- setIncrementIcon
- setIncrementIconIsCircular
- setMaxValue
- setMinValue
- setStepValue
- setStyle
- setVisible
Inherited Methods¶
- _clientAPIProps
- _getExecuteSource
- applyValidation
- base64StringToBinary
- binaryToBase64String
- callFunction
- clearFocus
- clearValidation
- clearValidationOnValueChange
- convertFilterCriteriaArrayToJSONString
- convertJSONStringToFilterCriteriaArray
- count
- create
- createAttachmentEntry
- createFilterCriteria
- createFilterSelection
- createLinkSpecifierProxy
- createSorterSelection
- dataQueryBuilder
- deleteODataCacheImages
- dismissActivityIndicator
- downloadInProgressForPage
- downloadInProgressForReadLink
- evaluateTargetPath
- evaluateTargetPathForAPI
- executeAction
- formatBase64String
- formatCurrency
- formatDate
- formatDatetime
- formatNumber
- formatPercentage
- formatScientific
- formatTime
- getActionResult
- getAppClientData
- getAppearanceMode
- getAppEventData
- getAppName
- getAvailableThemes
- getBindingObject
- getCaption
- getCircularImage
- getClientData
- getCollection
- getDefinitionValue
- getEditable
- getEnable
- getEnabled
- getEventData
- getGlobalDefinition
- getGlobalSideDrawerControlProxy
- getHelperText
- getIconTextImage
- getLanguage
- getLogger
- getMobileServiceAppId
- getMobileServiceEndpointUrl
- getName
- getODataCacheImagePath
- getODataProvider
- getPageDefinition
- getPageProxy
- getParent
- getPasscodeSource
- getPendingDownload
- getReadLink
- getRegion
- getRegions
- getRequiredIndicator
- getRequiredIndicatorStyle
- getSAPPassportHeaderValue
- getSupportedLanguages
- getTargetSpecifier
- getTheme
- getType
- getUseInAppCamera
- getValidation
- getValue
- getVersionInfo
- getVisible
- initializeLogger
- isAppInMultiUserMode
- isContainer
- isCurrentPage
- isDemoMode
- isDeviceCompliant
- isMediaLocal
- localizeText
- read
- redraw
- reset
- sendMobileServiceRequest
- sendRequest
- setApplicationIconBadgeNumber
- setCaption
- setDebugSettings
- setEditable
- setEnable
- setEnabled
- setFocus
- setHelperText
- setLanguage
- setMdkWindows
- setRegion
- setRequiredIndicator
- setRequiredIndicatorStyle
- setStyle
- setTargetSpecifier
- setTheme
- setUseInAppCamera
- setValidationProperty
- setValue
- setVisible
- showActivityIndicator
- updateProgressBanner
Constructors¶
Constructor¶
+ new StepperFormCellProxy(context: IContext): StepperFormCellProxy
Inherited from FormCellControlProxy.constructor
Parameters:
| Name | Type |
|---|---|
| context | IContext |
Returns: StepperFormCellProxy
Methods¶
clearValidation¶
▸ clearValidation(): void
Clears the validation message and hides the validation view of the Stepper FormCell.
Implementation of IStepperFormCellProxy.clearValidation Overrides FormCellControlProxy.clearValidation
Returns: void
getDecimalPlacesSupported¶
▸ getDecimalPlacesSupported(): number
Returns the decimalPlacesSupported property value of the Stepper FormCell.
Implementation of IStepperFormCellProxy.getDecimalPlacesSupported
Returns: number
getDecrementIcon¶
▸ getDecrementIcon(): string
Returns the decrementIcon property value of the Stepper FormCell.
Returns: string
getDecrementIconIsCircular¶
▸ getDecrementIconIsCircular(): boolean
Returns the decrementIconIsCircular property value of the Stepper FormCell.
Returns: boolean
getEditable¶
▸ getEditable(): boolean
Returns the editable property value of the Stepper FormCell.
Implementation of IStepperFormCellProxy.getEditable Overrides FormCellControlProxy.getEditable
Returns: boolean
getIncrementIcon¶
▸ getIncrementIcon(): string
Returns the incrementIcon property value of the Stepper FormCell.
Implementation of IStepperFormCellProxy.getIncrementIcon
Returns: string
getIncrementIconIsCircular¶
▸ getIncrementIconIsCircular(): boolean
Returns the incrementIconIsCircular property value of the Stepper FormCell.
Returns: boolean
getMaxValue¶
▸ getMaxValue(): number
Returns the maximum property value of the Stepper FormCell.
Implementation of IStepperFormCellProxy.getMaxValue
Returns: number
getMinValue¶
▸ getMinValue(): number
Returns the minimum property value of the Stepper FormCell.
Implementation of IStepperFormCellProxy.getMinValue
Returns: number
getStepValue¶
▸ getStepValue(): number
Returns the step property value of the Stepper FormCell.
Implementation of IStepperFormCellProxy.getStepValue
Returns: number
getStyle¶
▸ getStyle(): string
Returns the style class value of the Stepper FormCell.
Implementation of IStepperFormCellProxy.getStyle
Returns: string
getValidation¶
▸ getValidation(): IFormCellValidationProxy
Returns the FormCellValidationProxy of the Stepper FormCell. This proxy allows getting and setting validation properties such as message, visibility, separator visibility, and styles.
Implementation of IStepperFormCellProxy.getValidation Overrides FormCellControlProxy.getValidation
Returns: IFormCellValidationProxy
getValue¶
▸ getValue(): number
Returns the numeric value of the Stepper FormCell.
Implementation of IStepperFormCellProxy.getValue Overrides FormCellControlProxy.getValue
Returns: number
getVisible¶
▸ getVisible(): boolean
Returns the visible property value of the Stepper FormCell.
Implementation of IStepperFormCellProxy.getVisible Overrides FormCellControlProxy.getVisible
Returns: boolean
setDecimalPlacesSupported¶
▸ setDecimalPlacesSupported(decimalPlaces: number): Promise<any>
Sets the decimalPlacesSupported property of the Stepper FormCell.
Implementation of IStepperFormCellProxy.setDecimalPlacesSupported
Parameters:
| Name | Type | Description |
|---|---|---|
| decimalPlaces | number | value to set. |
Returns: Promise<any>
setDecrementIcon¶
▸ setDecrementIcon(icon: string): Promise<any>
Sets the decrementIcon property of the Stepper FormCell.
Parameters:
| Name | Type | Description |
|---|---|---|
| icon | string | value to set. |
Returns: Promise<any>
setDecrementIconIsCircular¶
▸ setDecrementIconIsCircular(isCircular: boolean): Promise<any>
Sets the decrementIconIsCircular property of the Stepper FormCell.
Parameters:
| Name | Type | Description |
|---|---|---|
| isCircular | boolean | value to set. |
Returns: Promise<any>
setEditable¶
▸ setEditable(editable: boolean): Promise<any>
Sets the editable property of the Stepper FormCell.
Implementation of IStepperFormCellProxy.setEditable Overrides FormCellControlProxy.setEditable
Parameters:
| Name | Type | Description |
|---|---|---|
| editable | boolean | value to set. |
Returns: Promise<any>
setIncrementIcon¶
▸ setIncrementIcon(icon: string): Promise<any>
Sets the incrementIcon property of the Stepper FormCell.
Implementation of IStepperFormCellProxy.setIncrementIcon
Parameters:
| Name | Type | Description |
|---|---|---|
| icon | string | value to set. |
Returns: Promise<any>
setIncrementIconIsCircular¶
▸ setIncrementIconIsCircular(isCircular: boolean): Promise<any>
Sets the incrementIconIsCircular property of the Stepper FormCell.
Parameters:
| Name | Type | Description |
|---|---|---|
| isCircular | boolean | value to set. |
Returns: Promise<any>
setMaxValue¶
▸ setMaxValue(maxValue: number): Promise<any>
Sets the maxValue property of the Stepper FormCell.
Implementation of IStepperFormCellProxy.setMaxValue
Parameters:
| Name | Type | Description |
|---|---|---|
| maxValue | number | value to set. |
Returns: Promise<any>
setMinValue¶
▸ setMinValue(minValue: number): Promise<any>
Sets the minValue property of the Stepper FormCell.
Implementation of IStepperFormCellProxy.setMinValue
Parameters:
| Name | Type | Description |
|---|---|---|
| minValue | number | value to set. |
Returns: Promise<any>
setStepValue¶
▸ setStepValue(step: number): Promise<any>
Sets the step property of the Stepper FormCell.
Implementation of IStepperFormCellProxy.setStepValue
Parameters:
| Name | Type | Description |
|---|---|---|
| step | number | value to set. |
Returns: Promise<any>
setStyle¶
▸ setStyle(styleClass: string, target?: string): any
Sets the style class of the Stepper FormCell.
Implementation of IStepperFormCellProxy.setStyle Overrides FormCellControlProxy.setStyle
Parameters:
| Name | Type | Description |
|---|---|---|
| styleClass | string | value to set. |
| target? | string | value to set. Possible target values are 'Background', 'Stepper', 'StepperTextField', 'IncrementIcon', 'DecrementIcon', 'Caption', 'HelperText'. |
Returns: any
setVisible¶
▸ setVisible(isVisible: boolean): any
Sets the visible property of the Stepper FormCell.
Implementation of IStepperFormCellProxy.setVisible Overrides FormCellControlProxy.setVisible
Parameters:
| Name | Type | Description |
|---|---|---|
| isVisible | boolean | value to set. |
Returns: any