Class FormModalUiHandler`Abstract`

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

Hierarchy (view full)

ModalUiHandler
- FormModalUiHandler

Constructors

constructor

new FormModalUiHandler(scene, mode?): FormModalUiHandler
Parameters
- scene: default
- mode: null | Mode = null
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`buttonLabels

buttonLabels: Text[]

`Protected`cursor

cursor: number = 0

`Protected`editing

editing: boolean

`Protected`errorMessage

errorMessage: Text

`Protected`formLabels

formLabels: Text[]

`Protected`inputContainers

inputContainers: Container[]

`Protected`inputs

inputs: InputText[]

`Protected`modalBg

modalBg: NineSlice

`Protected`modalContainer

modalContainer: Container

`Protected`mode

mode: null | number

`Protected`scene

scene: default

`Protected`submitAction

submitAction: null | Function

`Protected`titleText

titleText: Text

`Protected`tween

tween: Tween

Methods

`Protected`addInteractionHoverEffect

addInteractionHoverEffect(gameObject): void
Adds a hover effect to a game object which changes the cursor to a pointer and tints it slighly
Parameters
- gameObject: Sprite | Image | NineSlice
  the game object to add hover events/effects to
Returns void
Inherited from ModalUiHandler.addInteractionHoverEffect
- Defined in src/ui/modal-ui-handler.ts:171

clear

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

`Abstract`getButtonLabels

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

getButtonTopMargin

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

getCursor

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

getHeight

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

`Abstract`getInputFieldConfigs

getInputFieldConfigs(): InputFieldConfig[]
Get configuration for all fields that should be part of the modal Gets used by updateFields to add the proper text inputs and labels to the view

Returns InputFieldConfig[]
array of InputFieldConfig
- Defined in src/ui/form-modal-ui-handler.ts:37

`Abstract`getMargin

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

`Abstract`getModalTitle

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

getReadableErrorMessage

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

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
- Optionalconfig: ModalConfig
Returns number
Inherited from ModalUiHandler.getWidth
- Defined in src/ui/modal-ui-handler.ts:30

processInput

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

sanitizeInputs

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

setCursor

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

`Protected`setMouseCursorStyle

setMouseCursorStyle(cursorStyle): void
Changes the style of the mouse cursor.
Parameters
- cursorStyle: "default" | "pointer"
  cursor style to apply
Returns void
See
https://developer.mozilla.org/en-US/docs/Web/CSS/cursor
Inherited from ModalUiHandler.setMouseCursorStyle
- Defined in src/ui/ui-handler.ts:60

setup

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

show

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

updateContainer

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

`Protected`updateFields

updateFields(fieldsConfig, hasTitle): void
Parameters
- fieldsConfig: InputFieldConfig[]
- hasTitle: boolean
Returns void
- Defined in src/ui/form-modal-ui-handler.ts:69

Class FormModalUiHandlerAbstract

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FormModalUiHandler

Properties

active

ProtectedbuttonBgs

ProtectedbuttonContainers

ProtectedbuttonLabels

Protectedcursor

Protectedediting

ProtectederrorMessage

ProtectedformLabels

ProtectedinputContainers

Protectedinputs

ProtectedmodalBg

ProtectedmodalContainer

Protectedmode

Protectedscene

ProtectedsubmitAction

ProtectedtitleText

Protectedtween

Methods

ProtectedaddInteractionHoverEffect

Parameters

Returns void

clear

Returns void

AbstractgetButtonLabels

Parameters

Returns string[]

getButtonTopMargin

Returns number

getCursor

Returns number

getHeight

Parameters

Returns number

AbstractgetInputFieldConfigs

Returns InputFieldConfig[]

AbstractgetMargin

Parameters

Returns [number, number, number, number]

AbstractgetModalTitle

Parameters

Returns string

getReadableErrorMessage

Parameters

Returns string

getTextColor

Parameters

Returns string

getUi

Returns default

AbstractgetWidth

Parameters

Returns number

processInput

Parameters

Returns boolean

sanitizeInputs

Returns void

setCursor

Parameters

Returns boolean

ProtectedsetMouseCursorStyle

Parameters

Returns void

See

setup

Returns void

show

Parameters

Returns boolean

Class FormModalUiHandler`Abstract`

`Protected`buttonBgs

`Protected`buttonContainers

`Protected`buttonLabels

`Protected`cursor

`Protected`editing

`Protected`errorMessage

`Protected`formLabels

`Protected`inputContainers

`Protected`inputs

`Protected`modalBg

`Protected`modalContainer

`Protected`mode

`Protected`scene

`Protected`submitAction

`Protected`titleText

`Protected`tween

`Protected`addInteractionHoverEffect

`Abstract`getButtonLabels

`Abstract`getInputFieldConfigs

`Abstract`getMargin

`Abstract`getModalTitle

`Abstract`getWidth

`Protected`setMouseCursorStyle

`Protected`updateFields