Class CustomisationController

Hierarchy

CustomisationController

Implements

IUIController<ICustomisationScreenData>

Constructors

constructor

new CustomisationController(delegate: IAppControllerDelegate, isGlobal?: boolean): CustomisationController
Parameters
- delegate: IAppControllerDelegate
- isGlobal: boolean = false
Returns CustomisationController
- Defined in js/modularconfig/controllers/CustomisationController.ts:78

Properties

`Protected` _breadcrumbStack

_breadcrumbStack: MxtStack<IStackable>

`Protected` _configFilterController

_configFilterController: MxtConfiguratorFilterController

`Protected` _currentProducts

_currentProducts: {
id: string;
product: Product;
}[] = []

`Protected` _currentStep

_currentStep: ICustomisationStepData

`Protected` _isGlobal

_isGlobal: boolean

currentNotification

currentNotification: any

delegate

delegate: IAppControllerDelegate

permanentId

permanentId: string = null

`Protected` titledPageController

titledPageController: TitledPageController

ui

ui: CustomisationUI

Accessors

isGlobal

get isGlobal(): boolean
Returns boolean
- Defined in js/modularconfig/controllers/CustomisationController.ts:74

shouldShowBackButton

get shouldShowBackButton(): boolean
Returns boolean
- Defined in js/modularconfig/controllers/CustomisationController.ts:120

Methods

`Protected` _handleSearch

_handleSearch(query: string, screenData: CustomisationOptionScreenData): SearchResult
Parameters
- query: string
- screenData: CustomisationOptionScreenData
Returns SearchResult
- Defined in js/modularconfig/controllers/CustomisationController.ts:339

buildInitialHtml

buildInitialHtml(): HTMLElement
Returns HTMLElement
- Defined in js/modularconfig/controllers/CustomisationController.ts:100

clearAllFilters

clearAllFilters(): void
Returns void
- Defined in js/modularconfig/controllers/CustomisationController.ts:124

customise

customise(notificationData: any): Promise<void>
Parameters
- notificationData: any
Returns Promise<void>
- Defined in js/modularconfig/controllers/CustomisationController.ts:128

destroy

destroy(): void
Destroy means kill everything, does not make anything re-usable, this is purely for memory purposes

Returns void
Implementation of IUIController.destroy
- Defined in js/modularconfig/controllers/CustomisationController.ts:110

`Protected` generateAssemblyCustomisationStepData

generateAssemblyCustomisationStepData(data: StyleProductAssembly): Promise<AssemblyCustomisationStepData>
Parameters
- data: StyleProductAssembly
Returns Promise<AssemblyCustomisationStepData>
- Defined in js/modularconfig/controllers/CustomisationController.ts:438

`Protected` generateKongCustomisationStepData

generateKongCustomisationStepData(permanentId: string, data: MxtConfiguratorStep, controller: MxtConfiguratorController): Promise<KongCustomisationStepData>
Parameters
- permanentId: string
- data: MxtConfiguratorStep
- controller: MxtConfiguratorController
Returns Promise<KongCustomisationStepData>
- Defined in js/modularconfig/controllers/CustomisationController.ts:451

`Private` getBreadcrumbTrails

getBreadcrumbTrails(): string[]
Returns string[]
- Defined in js/modularconfig/controllers/CustomisationController.ts:307

handleSearch

handleSearch(query: string, screenData: ICustomisationScreenData): Promise<SearchResult>
Parameters
- query: string
- screenData: ICustomisationScreenData
Returns Promise<SearchResult>
- Defined in js/modularconfig/controllers/CustomisationController.ts:328

hide

hide(): void
Returns void
- Defined in js/modularconfig/controllers/CustomisationController.ts:324

`Protected` onAssemblyCustomisationOptionClicked

onAssemblyCustomisationOptionClicked(step: AssemblyCustomisationStepData, optionData: ProductInfo): Promise<void>
Parameters
- step: AssemblyCustomisationStepData
- optionData: ProductInfo
Returns Promise<void>
- Defined in js/modularconfig/controllers/CustomisationController.ts:292

onBackButtonClick

onBackButtonClick(): void
Returns void
- Defined in js/modularconfig/controllers/CustomisationController.ts:316

onExitCustomisation

onExitCustomisation(): void
Returns void
- Defined in js/modularconfig/controllers/CustomisationController.ts:269

`Protected` onKongCustomisationOptionClicked

onKongCustomisationOptionClicked(step: KongCustomisationStepData, optionData: {}): Promise<void>
Parameters
- step: KongCustomisationStepData
- optionData: {}
Returns Promise<void>
- Defined in js/modularconfig/controllers/CustomisationController.ts:273

onNewProject

onNewProject(): Promise<void>
Returns Promise<void>
Implementation of IUIController.onNewProject
- Defined in js/modularconfig/controllers/CustomisationController.ts:505

onOptionClicked

onOptionClicked(step: ICustomisationStepData, option: ICustomisationOptionData, screen: CustomisationOptionScreen): Promise<void>
Parameters
- step: ICustomisationStepData
- option: ICustomisationOptionData
- screen: CustomisationOptionScreen
Returns Promise<void>
- Defined in js/modularconfig/controllers/CustomisationController.ts:247

onSizeUpdate

onSizeUpdate(data: ResponsivenessData): void
Called every time size updates, should generally call onSizeUpdate on its UI components
Parameters
- data: ResponsivenessData
Returns void
Implementation of IUIController.onSizeUpdate
- Defined in js/modularconfig/controllers/CustomisationController.ts:106

`Protected` refreshCustomisation

refreshCustomisation(keepOptionsScreen?: boolean): Promise<void>
Parameters
- keepOptionsScreen: boolean = false
Returns Promise<void>
- Defined in js/modularconfig/controllers/CustomisationController.ts:507

reset

reset(): Promise<void>
Reset for re-use

Returns Promise<void>
Implementation of IUIController.reset
- Defined in js/modularconfig/controllers/CustomisationController.ts:114

setupFilters

setupFilters(options: ICustomisationOptionData[], stepData: ICustomisationStepData): Promise<void>
Parameters
- options: ICustomisationOptionData[]
- stepData: ICustomisationStepData
Returns Promise<void>
- Defined in js/modularconfig/controllers/CustomisationController.ts:243

show

show(): void
Returns void
- Defined in js/modularconfig/controllers/CustomisationController.ts:320

showNoCustomisation

showNoCustomisation(): void
Returns void
- Defined in js/modularconfig/controllers/CustomisationController.ts:212

`Protected` updateKongCustomisationStepData

updateKongCustomisationStepData(data: KongCustomisationStepData): void
Parameters
- data: KongCustomisationStepData
Returns void
- Defined in js/modularconfig/controllers/CustomisationController.ts:486

updateSelectedStep

updateSelectedStep(stepData: ICustomisationStepData, refreshScreen?: boolean, screenData?: CustomisationOptionScreenData): Promise<void>
Parameters
- stepData: ICustomisationStepData
- refreshScreen: boolean = true
- screenData: CustomisationOptionScreenData = null
Returns Promise<void>
- Defined in js/modularconfig/controllers/CustomisationController.ts:216

Generated using TypeDoc