Package com.onenetwork.platform.common.menu

Interface MenuAction

All Superinterfaces:
MenuElement
public interface MenuAction
extends MenuElement
MenuAction is a MenuElement which will open a tab (or execute some other action) when clicked. It includes a name and either a URL (for opening a webpage directly) or MenuPanelOptions (for instantiating and opening a javascript component).

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getIconCls()
    Returns action's icon css class - should be 16x16 for regular actions and 32x32 for quick launch.
    java.lang.String getName()
    Returns action's name
    MenuPanelOptions getPanelOptions()
    Gets panel options for the menu.
    java.lang.String getURL()
    Returns action's url.
    boolean isSingleton()
    Returns true if there can only be one instance of the panel from this menu action.
    void setIconCls​(java.lang.String cls)
    Sets action's css class for the icon - should be 16x16 for regular actions and 32x32 for quick launch.
    void setName​(java.lang.String name)
    Sets action's name
    void setPanelOptions​(MenuPanelOptions panelOptions)
    Sets panel options for the action.
    void setSingleton​(boolean singleton)
    Sets whether the action is singleton or not
    void setURL​(java.lang.String url)
    Sets action's url.

  • Method Details

    • getName

      java.lang.String getName()
      Returns action's name

    • setName

      void setName​(java.lang.String name)
      Sets action's name
      Parameters:
      name - - action's name

    • getURL

      java.lang.String getURL()
      Returns action's url. The client should set the URL, or the PanelOptions, but not both.

    • setURL

      void setURL​(java.lang.String url)
      Sets action's url. The client should set the URL, or the PanelOptions, but not both.
      Parameters:
      url - action's url

    • getIconCls

      java.lang.String getIconCls()
      Returns action's icon css class - should be 16x16 for regular actions and 32x32 for quick launch.

    • setIconCls

      void setIconCls​(java.lang.String cls)
      Sets action's css class for the icon - should be 16x16 for regular actions and 32x32 for quick launch.
      Parameters:
      cls - action's icon css class

    • isSingleton

      boolean isSingleton()
      Returns true if there can only be one instance of the panel from this menu action.

    • setSingleton

      void setSingleton​(boolean singleton)
      Sets whether the action is singleton or not
      Parameters:
      singleton - true if you want to have only one instance of this panel, otherwise false.

    • getPanelOptions

      MenuPanelOptions getPanelOptions()
      Gets panel options for the menu. The client should set the URL, or the PanelOptions, but not both.
      See Also:
      Returns action's panel options, null if does not exist.

    • setPanelOptions

      void setPanelOptions​(MenuPanelOptions panelOptions)
      Sets panel options for the action. The client should set the URL, or the PanelOptions, but not both.
      Parameters:
      panelOptions -