Class MenuController<ML, MT>

[jp] メニュー管理クラス

メニューコンポーネントは三つの段階に分かれる

  • Controller: 複数のMenuを切替・管理する（本クラス）
  • Menu：メニュー本体
  • Item：項目。Menuの子に当たる概念

Example

// TODO

Type Parameters

  • ML = any

  • MT extends Menu = Menu

Hierarchy

  • MenuController

Constructors

constructor

Properties

_currentMenu? _menuMap _prevMenuStack

Accessors

currentMenu previousMenu

Methods

_setActiveMenu addMenu backToPrevMenu clearHistory getMenu runOption selectNextOption selectPrevOption setActiveMenu

Constructors

constructor

Properties

Private Optional _currentMenu

_currentMenu?: MT

Private _menuMap

_menuMap: Map<ML, MT> = ...

Private _prevMenuStack

_prevMenuStack: MT[] = []

Accessors

currentMenu

previousMenu

Methods

Private _setActiveMenu

  • _setActiveMenu(menu: MT): void

  • メニュー切替 Deactivate current menu -> Set (activated) specified menu

    Parameters

    • menu: MT

      menu to activate

    Returns void

addMenu

  • メニュー追加

    Parameters

    • label: ML

      Menu label

    • menu: MT

    Returns void

backToPrevMenu

  • [jp] 直前のメニューに戻る

    Returns

    前メニューの有無をBooleanで返す

    Parameters

    • resetCurrent: boolean = false

      Whether to reset current menu item selection

    Returns boolean

clearHistory

getMenu

  • ラベルでメニューを取得

    Returns

    Parameters

    • label: ML

      Menu label

    Returns undefined | MT

runOption

  • [jp] 選択中の項目を実行. (currentMenuのrunOptionを実行 -> 選択中Itemのexecuteメソッドを実行)

    currentMenuが存在しない、 選択中Itemのexecuteが定義されてない場合は何もしない

    Returns

    実行結果を返す 実行結果がラベル文字列を返した場合、対応するメニューをアクティブ化

    Parameters

    • Rest ...args: any

    Returns any

selectNextOption

  • [jp] 現在のメニューの一つ後の項目を選択 ＆その参照を返す（存在すれば）

    Returns undefined | boolean

selectPrevOption

  • [jp] 現在のメニューの一つ前の項目を選択 ＆その参照を返す（存在すれば）

    Returns undefined | boolean

setActiveMenu

  • アクティブにしたいメニューをlabel指定

    Parameters

    • label: ML
    • resetState: boolean = false

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc