Class FormModalUiHandler`Abstract`

A basic abstract class to act as a holder and processor for UI elements.

Hierarchy (view full)

ModalUiHandler
- FormModalUiHandler
  - default
  - default

Constructors

constructor

new FormModalUiHandler(scene, mode?): FormModalUiHandler
Parameters
- scene: default
- Optional mode: Mode
Returns FormModalUiHandler
Overrides ModalUiHandler.constructor
- Defined in src/ui/form-modal-ui-handler.ts:23

Properties

active

active: boolean = false

`Protected` buttonBgs

buttonBgs: NineSlice[]

`Protected` buttonContainers

buttonContainers: Container[]

`Protected` cursor

cursor: number = 0

`Protected` editing

editing: boolean

`Protected` errorMessage

errorMessage: Text

`Protected` inputContainers

inputContainers: Container[]

`Protected` inputs

inputs: InputText[]

`Protected` modalBg

modalBg: NineSlice

`Protected` modalContainer

modalContainer: Container

`Protected` mode

mode: number

`Protected` scene

scene: default

`Protected` submitAction

submitAction: Function

`Protected` titleText

titleText: Text

`Protected` tween

tween: Tween

Methods

clear

clear(): void
Returns void
Overrides ModalUiHandler.clear
- Defined in src/ui/form-modal-ui-handler.ts:139

`Abstract` getButtonLabels

getButtonLabels(config?): string[]
Parameters
- Optional config: ModalConfig
Returns string[]
Inherited from ModalUiHandler.getButtonLabels
- Defined in src/ui/modal-ui-handler.ts:34

getButtonTopMargin

getButtonTopMargin(): number
Returns number
Inherited from ModalUiHandler.getButtonTopMargin
- Defined in src/ui/modal-ui-handler.ts:36

getCursor

getCursor(): number
Returns number
Inherited from ModalUiHandler.getCursor
- Defined in src/ui/ui-handler.ts:42

`Abstract` getFields

getFields(): string[]
Returns string[]
- Defined in src/ui/form-modal-ui-handler.ts:31

getHeight

getHeight(config?): number
Parameters
- Optional config: ModalConfig
Returns number
Overrides ModalUiHandler.getHeight
- Defined in src/ui/form-modal-ui-handler.ts:33

`Abstract` getMargin

getMargin(config?): [number, number, number, number]
Parameters
- Optional config: ModalConfig
Returns [number, number, number, number]
Inherited from ModalUiHandler.getMargin
- Defined in src/ui/modal-ui-handler.ts:32

`Abstract` getModalTitle

getModalTitle(config?): string
Parameters
- Optional config: ModalConfig
Returns string
Inherited from ModalUiHandler.getModalTitle
- Defined in src/ui/modal-ui-handler.ts:26

getReadableErrorMessage

getReadableErrorMessage(error): string
Parameters
- error: string
Returns string
- Defined in src/ui/form-modal-ui-handler.ts:37

getTextColor

getTextColor(style, shadow?): string
Parameters
- style: TextStyle
- shadow: boolean = false
Returns string
Inherited from ModalUiHandler.getTextColor
- Defined in src/ui/ui-handler.ts:38

getUi

getUi(): default
Returns default
Inherited from ModalUiHandler.getUi
- Defined in src/ui/ui-handler.ts:34

`Abstract` getWidth

getWidth(config?): number
Parameters
- Optional config: ModalConfig
Returns number
Inherited from ModalUiHandler.getWidth
- Defined in src/ui/modal-ui-handler.ts:28

processInput

processInput(button): boolean
Parameters
- button: Button
Returns boolean
Overrides ModalUiHandler.processInput
- Defined in src/ui/form-modal-ui-handler.ts:117

sanitizeInputs

sanitizeInputs(): void
Returns void
- Defined in src/ui/form-modal-ui-handler.ts:126

setCursor

setCursor(cursor): boolean
Parameters
- cursor: number
Returns boolean
Inherited from ModalUiHandler.setCursor
- Defined in src/ui/ui-handler.ts:46

setup

setup(): void
Returns void
Overrides ModalUiHandler.setup
- Defined in src/ui/form-modal-ui-handler.ts:45

show

show(args): boolean
Parameters
- args: any[]
Returns boolean
Overrides ModalUiHandler.show
- Defined in src/ui/form-modal-ui-handler.ts:81

updateContainer

updateContainer(config?): void
Parameters
- Optional config: ModalConfig
Returns void
Overrides ModalUiHandler.updateContainer
- Defined in src/ui/form-modal-ui-handler.ts:132