Interface QMenuItemInterface

All Superinterfaces:
Cloneable, QMetaDataObject, Serializable
All Known Implementing Classes:
QMenuDefaultViewScreenActionsMenu.FooterSubList, QMenuDefaultViewScreenActionsMenu.HeaderSubList, QMenuItemBase, QMenuItemBuiltIn, QMenuItemDivider, QMenuItemDownloadFile, QMenuItemRunProcess, QMenuItemSubList, QMenuItemSubMenu
public interface QMenuItemInterface extends QMetaDataObject, Cloneable
interface for different types of menu items.

  • Method Summary

    Modifier and Type
    Method
    Description
    QMenuItemInterface
    clone()
     
    QIcon
    getIcon()
    Optional icon to display with this menu item.
    String
    getItemType()
    Specify the "type" of menu item - e.g., what sub-class it is, but more accurately, instructions to the frontend on how to handle the item.
    String
    getLabel()
    returns user-facing text to display as the label for this menu item.
    default Map<String,Serializable>
    getValues()
    get the values associated with this specific menu item.
    default void
    validate(QInstanceValidator validator, QInstance qInstance, QMetaDataObject parentObject)
    As part of QInstanceValidation, verify that the meta-data in this object is all fully valid.

  • Method Details

    • getLabel

      String getLabel()
      returns user-facing text to display as the label for this menu item. e.g., "New", "Copy", or "Process Orders".

    • getIcon

      QIcon getIcon()
      Optional icon to display with this menu item. Frontends may choose to use a default if no icon is given.

    • getItemType

      String getItemType()
      Specify the "type" of menu item - e.g., what sub-class it is, but more accurately, instructions to the frontend on how to handle the item.

    • getValues

      default Map<String,Serializable> getValues()
      get the values associated with this specific menu item.

      For example, for a run-process item, the name of the process.

    • validate

      default void validate(QInstanceValidator validator, QInstance qInstance, QMetaDataObject parentObject)
      As part of QInstanceValidation, verify that the meta-data in this object is all fully valid.

      Subclasses should generally include a call to super.validate

    • clone

      QMenuItemInterface clone()