Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MenuItemModel

MenuItemModel provides a general purpose, loosely coupled model for an individual menu item contained in a menu.

Hierarchy

  • MenuItemModel

Index

Constructors

Properties

Methods

Constructors

constructor

  • Initializes a new instance of the MenuItemModel class.

    Parameters

    • menuModel: MenuModel

      The {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.menus.MenuModel} that this MenuItemModel is a member of.

    • config: MenuItemConfig

      The {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.menus.MenuItemConfig} configuration for this MenuItemModel.

    Returns MenuItemModel

Properties

app

app: ViewerApplication

The ViewerApplication that this menu item instance belongs to.

batchItems

batchItems: BatchItemModel[]

An array of BatchItemModel's constituting a batch (if applicable).

command

command: TypedCommand<any>

The executable command object associated with this menu item.

commandParameter

commandParameter: any

The command Parameter associated with the menu item. This could be a string or a complex object.

description

description: string

Short Description of this menu item.

hideOnDisable

hideOnDisable: boolean

Visibility status of menu item when disabled.

iconUri

iconUri: string

URI of the icon associated with this menu item (if any).

id

id: string

The id of this menu item ( optional )

menuModel

menuModel: MenuModel

The {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.menus.MenuModel} that this MenuItemModel is a member of.

Optional onFocusCommand

onFocusCommand: TypedCommand<any>

The executable command object associated when this menu item gets focussed.

Optional onFocusCommandParameter

onFocusCommandParameter: any

The command Parameter associated when this menu item gets focussed. This could be a string or a complex object.

text

text: string

The name of this menu item.

Methods

Protected _setBatchItems

  • Sets the batch items for the menu item.

    Parameters

    • batch: BatchItemConfig[]

      A {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.menus.BatchItemConfig} object to provide configuration details for the batch commands (if any) associated with this menu item.

    Returns void