Class CustomisationDataScreen`Abstract`

Hierarchy

CustomisationDataScreen
- CustomisationOptionScreen
- CustomisationStepScreen

Implements

Constructors

constructor

new CustomisationDataScreen(rootClass: string, controller: CustomisationController, usesSearchAndFilter: boolean): CustomisationDataScreen
Parameters
- rootClass: string
- controller: CustomisationController
- usesSearchAndFilter: boolean
Returns CustomisationDataScreen
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:43

Properties

`Protected` _content

_content: HTMLElement

`Protected` _controller

_controller: CustomisationController

`Protected` _data

_data: ICustomisationScreenData

`Protected` _root

_root: HTMLElement

`Protected` _rootClass

_rootClass: string

`Protected` _searchAndFilter

_searchAndFilter: SearchAndFilter

`Protected` _usesSearchAndFilter

_usesSearchAndFilter: boolean

Accessors

description

get description(): string
Returns string
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:35

element

get element(): HTMLElement
Returns HTMLElement
Implementation of IUIElement.element
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:62

rootClass

get rootClass(): string
Returns string
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:39

searchAndFilter

get searchAndFilter(): SearchAndFilter
Returns SearchAndFilter
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:27

title

get title(): string
Returns string
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:31

Methods

buildInitialHtml

buildInitialHtml(): HTMLElement
Returns HTMLElement
Implementation of IUIElement.buildInitialHtml
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:78

clearAllFilters

clearAllFilters(): void
Returns void
Implementation of ISearchAndFilterOwner.clearAllFilters
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:113

clearFiltersElement

clearFiltersElement(): void
Returns void
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:118

clearUsedFiltersElement

clearUsedFiltersElement(): void
Returns void
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:121

destroy

destroy(): void
Destroy the UI entirely and eliminate all memory

Returns void
Implementation of IUIElement.destroy
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:105

getCurrentSearchTerm

getCurrentSearchTerm(): string
Returns string
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:74

hideFilters

hideFilters(): void
Returns void
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:124

onBackButtonClick

onBackButtonClick(): void
Returns void
Implementation of ISearchAndFilterOwner.onBackButtonClick
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:70

onExitCustomisation

onExitCustomisation(): void
Returns void
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:66

onSizeUpdate

onSizeUpdate(data: ResponsivenessData): void
Automatically called whenever the size updates
Parameters
- data: ResponsivenessData
Returns void
Implementation of IUIElement.onSizeUpdate
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:101

reset

reset(): void
Reset the UI to be re-used

Returns void
Implementation of IUIElement.reset
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:109

`Abstract` resetOptions

resetOptions(): void
Returns void
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:116

searchCallback

searchCallback(query: string): Promise<SearchResult>
Parameters
- query: string
Returns Promise<SearchResult>
Implementation of ISearchAndFilterOwner.searchCallback
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:49

`Abstract` setCurrentOptions

setCurrentOptions(options: ICustomisationOptionData[]): void
Parameters
- options: ICustomisationOptionData[]
Returns void
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:115

setData

setData(data: ICustomisationScreenData): void
Parameters
- data: ICustomisationScreenData
Returns void
Implementation of IUIElement.setData
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:97

showFilters

showFilters(): void
Returns void
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:127

toggleClearFiltersButton

toggleClearFiltersButton(show: boolean): void
Parameters
- show: boolean
Returns void
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:130

toggleNoResultsElement

toggleNoResultsElement(show: boolean): void
Parameters
- show: boolean
Returns void
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:133

Generated using TypeDoc