All
  • Public
  • Public/Protected
  • All

Class RVMenuItem

Class representing an object that is used to show an icon, title text, and click action of a menu item.

Hierarchy

Index

Constructors

Accessors

Constructors

constructor

  • new RVMenuItem(title: string, icon: object): RVMenuItem
  • new RVMenuItem(title: string, icon: object, action: function): RVMenuItem

  • Parameters

    • title: string
    • icon: object

    Returns RVMenuItem

  • Parameters

    • title: string
    • icon: object
    • action: function
        • (): void

        • Returns void

    Returns RVMenuItem

Accessors

action

  • get action(): null | function
  • set action(value: null | function): void

  • Retrieve the block of code to execute after the menu item is clicked.

    Returns null | function

  • Assign a block of code to execute after the menu item is clicked.

    Parameters

    • value: null | function

    Returns void

appSuppliedItem

  • get appSuppliedItem(): null | object
  • set appSuppliedItem(value: null | object): void

  • Retrieve the internal application supplied item used to represent the menu item.

    Returns null | object

  • Assign the internal application supplied item used to represent the menu item.

    Parameters

    • value: null | object

    Returns void

icon

  • get icon(): null | object
  • set icon(value: null | object): void

  • Retrieve the icon shown to the left of the menu label.

    Returns null | object

  • Icon shown to the left of the menu label.

    Parameters

    • value: null | object

    Returns void

isAppSupplied

  • get isAppSupplied(): boolean
  • set isAppSupplied(value: boolean): void

  • Retrieve the property that determines if a menu item was internally supplied.

    Returns boolean

  • A set-once property to determine if a menu item was internally supplied.

    Parameters

    • value: boolean

    Returns void

isHidden

  • get isHidden(): boolean
  • set isHidden(value: boolean): void

  • Retrieve property used to determine if the menu item will be hidden from view.

    Returns boolean

  • Property used to determine if the menu item should be hidden from view.

    Parameters

    • value: boolean

    Returns void

revealElement

  • get revealElement(): object

  • Retrieve the internal intermediate element used to represent the menu item.

    Returns object

title

  • get title(): string
  • set title(value: string): void

  • Retrieve the string used as the label for the menu item.

    Returns string

  • A string used as the label for the menu item.

    Parameters

    • value: string

    Returns void