Class default

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

Hierarchy (view full)

FormModalUiHandler
- default

Constructors

constructor

new default(scene, mode?): default
Parameters
- scene: default
- Optionalmode: Mode
Returns default
Inherited from FormModalUiHandler.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
Inherited from FormModalUiHandler.clear
- Defined in src/ui/form-modal-ui-handler.ts:139

getButtonLabels

getButtonLabels(config?): string[]
Parameters
- Optionalconfig: ModalConfig
Returns string[]
Overrides FormModalUiHandler.getButtonLabels
- Defined in src/ui/rename-form-ui-handler.ts:23

getButtonTopMargin

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

getCursor

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

getFields

getFields(config?): string[]
Parameters
- Optionalconfig: ModalConfig
Returns string[]
Overrides FormModalUiHandler.getFields
- Defined in src/ui/rename-form-ui-handler.ts:11

getHeight

getHeight(config?): number
Parameters
- Optionalconfig: ModalConfig
Returns number
Inherited from FormModalUiHandler.getHeight
- Defined in src/ui/form-modal-ui-handler.ts:33

getMargin

getMargin(config?): [number, number, number, number]
Parameters
- Optionalconfig: ModalConfig
Returns [number, number, number, number]
Overrides FormModalUiHandler.getMargin
- Defined in src/ui/rename-form-ui-handler.ts:19

getModalTitle

getModalTitle(config?): string
Parameters
- Optionalconfig: ModalConfig
Returns string
Overrides FormModalUiHandler.getModalTitle
- Defined in src/ui/rename-form-ui-handler.ts:7

getReadableErrorMessage

getReadableErrorMessage(error): string
Parameters
- error: string
Returns string
Overrides FormModalUiHandler.getReadableErrorMessage
- Defined in src/ui/rename-form-ui-handler.ts:27

getTextColor

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

getUi

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

getWidth

getWidth(config?): number
Parameters
- Optionalconfig: ModalConfig
Returns number
Overrides FormModalUiHandler.getWidth
- Defined in src/ui/rename-form-ui-handler.ts:15

processInput

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

sanitizeInputs

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

setCursor

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

setup

setup(): void
Returns void
Inherited from FormModalUiHandler.setup
- Defined in src/ui/form-modal-ui-handler.ts:45

show

show(args): boolean
Parameters
- args: any[]
Returns boolean
Overrides FormModalUiHandler.show
- Defined in src/ui/rename-form-ui-handler.ts:36

updateContainer

updateContainer(config?): void
Parameters
- Optionalconfig: ModalConfig
Returns void
Inherited from FormModalUiHandler.updateContainer
- Defined in src/ui/form-modal-ui-handler.ts:132