Class MenuController

Hierarchy

MenuController

Implements

IUIController<Menu>

Index

Constructors

Properties

_enableRedo _enableUndo _undoRedoDisabled actionMap cssClassActive cssClassDisabled cssClassHidden desktopTopBar menuBars menuDelegate menuRouter mobileBottomBar mobileTopBar productSelectBar rootMenu

Accessors

disabledCssClass ui

Constructors

constructor

new MenuController(delegate: IMenusDelegate): MenuController
Parameters
- delegate: IMenusDelegate
Returns MenuController
- Defined in js/modularconfig/controllers/MenuController.tsx:47

Properties

`Protected` _enableRedo

_enableRedo: boolean = false

`Protected` _enableUndo

_enableUndo: boolean = false

`Protected` _undoRedoDisabled

_undoRedoDisabled: boolean = false

`Protected` actionMap

actionMap: Map<string, MenuAction> = ...

For mapping ToolBeltActions to MenuActions

`Protected` cssClassActive

cssClassActive: string = '-active'

`Protected` cssClassDisabled

cssClassDisabled: string = 'mxt-btn-disabled'

`Protected` cssClassHidden

cssClassHidden: string = 'mxt-hidden'

desktopTopBar

desktopTopBar: DesktopTopBar

menuBars

menuBars: IMenuUIElement[] = []

`Protected` menuDelegate

menuDelegate: IMenusDelegate

`Protected` menuRouter

menuRouter: MenuRouter = ...

mobileBottomBar

mobileBottomBar: MobileBottomBar

mobileTopBar

mobileTopBar: MobileTopBar

productSelectBar

productSelectBar: ProductSelectBar

`Protected` rootMenu

rootMenu: Menu

Accessors

disabledCssClass

get disabledCssClass(): string
Returns string
- Defined in js/modularconfig/controllers/MenuController.tsx:309

ui

get ui(): IUIElement<{}>
Returns IUIElement<{}>
Implementation of IUIController.ui
- Defined in js/modularconfig/controllers/MenuController.tsx:233

Methods

activateByMenuAction

activateByMenuAction(action: MenuAction, active: boolean): void
Activate/Deactivate a button with matching menu action
Parameters
- action: MenuAction
  
  menu data entry
- active: boolean
  
  true=active, false=inactive
Returns void
- Defined in js/modularconfig/controllers/MenuController.tsx:359

activateByMenuType

activateByMenuType(type: MenuType, active: boolean): void
Activate/Deactivate a button with matching menu type
Parameters
- type: MenuType
  
  menu data entry
- active: boolean
  
  true=active, false=inactive
Returns void
- Defined in js/modularconfig/controllers/MenuController.tsx:404

buildInitialHtml

buildInitialHtml(): void
Returns void
- Defined in js/modularconfig/controllers/MenuController.tsx:107

`Protected` createDesktopTopBar

createDesktopTopBar(): DesktopTopBar
Returns DesktopTopBar
- Defined in js/modularconfig/controllers/MenuController.tsx:228

`Protected` createMobileBottomBar

createMobileBottomBar(): MobileBottomBar
Returns MobileBottomBar
- Defined in js/modularconfig/controllers/MenuController.tsx:224

`Protected` createMobileTopBar

createMobileTopBar(): MobileTopBar
Returns MobileTopBar
- Defined in js/modularconfig/controllers/MenuController.tsx:220

`Protected` createProductSelectBar

createProductSelectBar(): ProductSelectBar
Returns ProductSelectBar
- Defined in js/modularconfig/controllers/MenuController.tsx:216

destroy

destroy(): void
Returns void
Implementation of IUIController.destroy
- Defined in js/modularconfig/controllers/MenuController.tsx:249

disableActionWhile

disableActionWhile<T>(menu: Menu, asyncFunc: (() => Promise<T>)): Promise<T>
Disable a button with matching menu action, while the defined async function is pending, and enable it once settled

Returns
the result of the async func
Type Parameters
- T
Parameters
- menu: Menu
  
  menu data entry
- asyncFunc: (() => Promise<T>)
  
  the asynchronous method to perform
  - - (): Promise<T>
    - Returns Promise<T>
Returns Promise<T>
- Defined in js/modularconfig/controllers/MenuController.tsx:371

disableTypeWhile

disableTypeWhile<T>(menu: Menu, asyncFunc: (() => Promise<T>)): Promise<T>
Disable a button with matching menu type, while the defined async function is pending, and enable it once settled

Returns
the result of the async func
Type Parameters
- T
Parameters
- menu: Menu
  
  menu data entry
- asyncFunc: (() => Promise<T>)
  
  the asynchronous method to perform
  - - (): Promise<T>
    - Returns Promise<T>
Returns Promise<T>
- Defined in js/modularconfig/controllers/MenuController.tsx:455

enableAction

enableAction(action: MenuAction, enable: boolean): void
Enable/Disable a button with matching menu action
Parameters
- action: MenuAction
- enable: boolean
  
  true=enable, false=disable
Returns void
- Defined in js/modularconfig/controllers/MenuController.tsx:339

enableType

enableType(menu: Menu, enable: boolean): void
Enable/Disable a button with matching menu type
Parameters
- menu: Menu
  
  menu data entry
- enable: boolean
  
  true=enable, false=disable
Returns void
- Defined in js/modularconfig/controllers/MenuController.tsx:394

`Protected` getActionButtons

getActionButtons(menuAction: MenuAction): HTMLElement[]
Parameters
- menuAction: MenuAction
Returns HTMLElement[]
- Defined in js/modularconfig/controllers/MenuController.tsx:294

getAllActionButtons

getAllActionButtons(): HTMLElement[]
Returns HTMLElement[]
- Defined in js/modularconfig/controllers/MenuController.tsx:313

`Protected` getTypeButtons

getTypeButtons(menuType: MenuType): HTMLElement[]
Parameters
- menuType: MenuType
Returns HTMLElement[]
- Defined in js/modularconfig/controllers/MenuController.tsx:297

hasDrawer

hasDrawer(menuType: MenuType): boolean
Parameters
- menuType: MenuType
Returns boolean
- Defined in js/modularconfig/controllers/MenuController.tsx:111

hideActionButton

hideActionButton(button: HTMLElement): void
Parameters
- button: HTMLElement
Returns void
- Defined in js/modularconfig/controllers/MenuController.tsx:317

isEnabledAction

isEnabledAction(action: MenuAction): boolean
Parameters
- action: MenuAction
Returns boolean
- Defined in js/modularconfig/controllers/MenuController.tsx:344

isMenuActionActive

isMenuActionActive(action: MenuAction): boolean
Parameters
- action: MenuAction
Returns boolean
- Defined in js/modularconfig/controllers/MenuController.tsx:438

isMenuTypeActive

isMenuTypeActive(type: MenuType): boolean
Parameters
- type: MenuType
Returns boolean
- Defined in js/modularconfig/controllers/MenuController.tsx:427

loadInitialData

loadInitialData(): Promise<void>
Returns Promise<void>
- Defined in js/modularconfig/controllers/MenuController.tsx:190

loadRootMenu

loadRootMenu(): Promise<Menu>
Returns Promise<Menu>
- Defined in js/modularconfig/controllers/MenuController.tsx:120

onNewProject

onNewProject(): Promise<void>
Returns Promise<void>
Implementation of IUIController.onNewProject
- Defined in js/modularconfig/controllers/MenuController.tsx:478

onSizeUpdate

onSizeUpdate(data: ResponsivenessData): void
Parameters
- data: ResponsivenessData
Returns void
Implementation of IUIController.onSizeUpdate
- Defined in js/modularconfig/controllers/MenuController.tsx:238

onUpdateToolbeltActions

onUpdateToolbeltActions(data: any): void
Parameters
- data: any
Returns void
- Defined in js/modularconfig/controllers/MenuController.tsx:285

onUpdateToolbeltOff

onUpdateToolbeltOff(data: any): void
Parameters
- data: any
Returns void
- Defined in js/modularconfig/controllers/MenuController.tsx:282

onUpdateToolbeltOn

onUpdateToolbeltOn(data: any): void
Parameters
- data: any
Returns void
- Defined in js/modularconfig/controllers/MenuController.tsx:278

reset

reset(): Promise<void>
Returns Promise<void>
Implementation of IUIController.reset
- Defined in js/modularconfig/controllers/MenuController.tsx:243

showAction

showAction(menu: Menu, show: boolean): void
Show/Hide a button with matching menu action
Parameters
- menu: Menu
  
  menu data entry
- show: boolean
  
  true=show, false=hide
Returns void
- Defined in js/modularconfig/controllers/MenuController.tsx:329

showActionButton

showActionButton(button: HTMLElement): void
Parameters
- button: HTMLElement
Returns void
- Defined in js/modularconfig/controllers/MenuController.tsx:320

showType

showType(menu: Menu, show: boolean): void
Show/Hide a button with matching menu type
Parameters
- menu: Menu
  
  menu data entry
- show: boolean
  
  true=show, false=hide
Returns void
- Defined in js/modularconfig/controllers/MenuController.tsx:384

`Protected` toggleActiveImages

toggleActiveImages(buttons: HTMLElement[], active: boolean): void
Parameters
- buttons: HTMLElement[]
- active: boolean
Returns void
- Defined in js/modularconfig/controllers/MenuController.tsx:463

`Protected` toggleClasses

toggleClasses(elements: HTMLElement[], klass: string, toggle: boolean): void
Parameters
- elements: HTMLElement[]
- klass: string
- toggle: boolean
Returns void
- Defined in js/modularconfig/controllers/MenuController.tsx:301

`Protected` transformActionsToShow

transformActionsToShow(actionsToShow: ToolbeltActionItem[]): void
This method consumes the Toolbelt's Renderer_UpdateActions event and tries to map the toolbelt action to a menu action Going forward, Toolbelt action plugins should be registered with the MenuAction they are associated with, but we have to support legacy, and manually map their ComposToolBeltActions to MenuActions

Returns
new array of ToolbeltActionItem[] with the action replaced with a mapped match to MenuAction
Parameters
- actionsToShow: ToolbeltActionItem[]
  
  array of ToolbeltActionItem that specify action type buttons to show and their enabled state
Returns void
- Defined in js/modularconfig/controllers/MenuController.tsx:270

Generated using TypeDoc