Class CustomisationOptionScreen

Hierarchy

CustomisationDataScreen
- CustomisationOptionScreen

Implements

IUIElement<CustomisationOptionScreenData>

Constructors

constructor

new CustomisationOptionScreen(controller: CustomisationController): CustomisationOptionScreen
Parameters
- controller: CustomisationController
Returns CustomisationOptionScreen
Overrides CustomisationDataScreen.constructor
- Defined in js/modularconfig/ui/customisation/CustomisationOptionScreen.tsx:27

Properties

`Protected` _content

_content: HTMLElement

`Protected` _controller

_controller: CustomisationController

`Protected` _currentOptions

_currentOptions: ICustomisationOptionData[] = []

`Protected` _data

_data: CustomisationOptionScreenData

`Protected` _gridContainer

_gridContainer: HTMLElement

`Protected` _grids

_grids: MarxentGrid<ICustomisationOptionData>[] = []

`Protected` _lastResponsivenessData

_lastResponsivenessData: ResponsivenessData

`Protected` _root

_root: HTMLElement

`Protected` _rootClass

_rootClass: string

`Protected` _searchAndFilter

_searchAndFilter: SearchAndFilter

`Protected` _usesSearchAndFilter

_usesSearchAndFilter: boolean

Accessors

description

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

element

get element(): HTMLElement
Returns HTMLElement
Implementation of IUIElement.element

Inherited from CustomisationDataScreen.element
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:62

rootClass

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

searchAndFilter

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

title

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

Methods

`Protected` addBlockedIcon

addBlockedIcon(div: HTMLDivElement): void
Parameters
- div: HTMLDivElement
Returns void
- Defined in js/modularconfig/ui/customisation/CustomisationOptionScreen.tsx:188

buildInitialHtml

buildInitialHtml(): HTMLElement
Returns HTMLElement
Implementation of IUIElement.buildInitialHtml

Overrides CustomisationDataScreen.buildInitialHtml
- Defined in js/modularconfig/ui/customisation/CustomisationOptionScreen.tsx:43

clearAllFilters

clearAllFilters(): void
Returns void
Overrides CustomisationDataScreen.clearAllFilters
- Defined in js/modularconfig/ui/customisation/CustomisationOptionScreen.tsx:155

clearFiltersElement

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

clearUsedFiltersElement

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

`Protected` createGrids

createGrids(): void
Returns void
- Defined in js/modularconfig/ui/customisation/CustomisationOptionScreen.tsx:195

decorateGridItem

decorateGridItem(div: HTMLDivElement, option: ICustomisationOptionData): void
Parameters
- div: HTMLDivElement
- option: ICustomisationOptionData
Returns void
- Defined in js/modularconfig/ui/customisation/CustomisationOptionScreen.tsx:123

destroy

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

Returns void
Implementation of IUIElement.destroy

Overrides CustomisationDataScreen.destroy
- Defined in js/modularconfig/ui/customisation/CustomisationOptionScreen.tsx:116

getAllOptions

getAllOptions(): ICustomisationOptionData[]
Returns ICustomisationOptionData[]
- Defined in js/modularconfig/ui/customisation/CustomisationOptionScreen.tsx:74

getCurrentOptions

getCurrentOptions(): ICustomisationOptionData[]
Returns ICustomisationOptionData[]
- Defined in js/modularconfig/ui/customisation/CustomisationOptionScreen.tsx:70

getCurrentSearchTerm

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

getGridForItem

getGridForItem(id: string): MarxentGrid<ICustomisationOptionData>
Parameters
- id: string
Returns MarxentGrid<ICustomisationOptionData>
- Defined in js/modularconfig/ui/customisation/CustomisationOptionScreen.tsx:96

`Private` getGridOptions

getGridOptions(): MarxentGridOptions<ICustomisationOptionData>
Returns MarxentGridOptions<ICustomisationOptionData>
- Defined in js/modularconfig/ui/customisation/CustomisationOptionScreen.tsx:292

`Protected` getNumColumnsGrid

getNumColumnsGrid(g: MarxentGrid<ICustomisationOptionData>, items: ICustomisationOptionData[]): number
Parameters
- g: MarxentGrid<ICustomisationOptionData>
- items: ICustomisationOptionData[]
Returns number
- Defined in js/modularconfig/ui/customisation/CustomisationOptionScreen.tsx:265

`Protected` getPriceString

getPriceString(option: ICustomisationOptionData, currentIds: string[]): string
Parameters
- option: ICustomisationOptionData
- currentIds: string[]
Returns string
- Defined in js/modularconfig/ui/customisation/CustomisationOptionScreen.tsx:163

hideFilters

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

onBackButtonClick

onBackButtonClick(): void
Returns void
Inherited from CustomisationDataScreen.onBackButtonClick
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:70

onExitCustomisation

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

onPageChange

onPageChange(page: number, marxentGrid: MarxentGrid<ICustomisationOptionData>): void
Parameters
- page: number
- marxentGrid: MarxentGrid<ICustomisationOptionData>
Returns void
- Defined in js/modularconfig/ui/customisation/CustomisationOptionScreen.tsx:230

onSizeUpdate

onSizeUpdate(data: ResponsivenessData): void
Automatically called whenever the size updates
Parameters
- data: ResponsivenessData
Returns void
Implementation of IUIElement.onSizeUpdate

Overrides CustomisationDataScreen.onSizeUpdate
- Defined in js/modularconfig/ui/customisation/CustomisationOptionScreen.tsx:259

`Protected` refreshCurrent

refreshCurrent(): void
Returns void
- Defined in js/modularconfig/ui/customisation/CustomisationOptionScreen.tsx:303

refreshData

refreshData(text: string): void
Parameters
- text: string
Returns void
- Defined in js/modularconfig/ui/customisation/CustomisationOptionScreen.tsx:159

reset

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

Returns void
Implementation of IUIElement.reset

Inherited from CustomisationDataScreen.reset
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:109

resetOptions

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

searchCallback

searchCallback(query: string): Promise<SearchResult>
Parameters
- query: string
Returns Promise<SearchResult>
Overrides CustomisationDataScreen.searchCallback
- Defined in js/modularconfig/ui/customisation/CustomisationOptionScreen.tsx:35

setCurrentOptions

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

setData

setData(data: CustomisationOptionScreenData, resetScreen?: boolean): void
Parameters
- data: CustomisationOptionScreenData
- resetScreen: boolean = true
Returns void
Implementation of IUIElement.setData

Overrides CustomisationDataScreen.setData
- Defined in js/modularconfig/ui/customisation/CustomisationOptionScreen.tsx:52

`Protected` setItems

setItems(items: ICustomisationOptionData[]): void
Parameters
- items: ICustomisationOptionData[]
Returns void
- Defined in js/modularconfig/ui/customisation/CustomisationOptionScreen.tsx:234

showFilters

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

toggleClearFiltersButton

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

toggleNoResultsElement

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

`Protected` updateGridSize

updateGridSize(): void
Returns void
- Defined in js/modularconfig/ui/customisation/CustomisationOptionScreen.tsx:285

Generated using TypeDoc