Class Shortcut

  • All Implemented Interfaces:
    java.io.Serializable

    public class Shortcut
    extends java.lang.Object
    implements java.io.Serializable
    Shortcut definition
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      Shortcut()
      Constructor
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDisplay​(java.lang.String lang)
      Get display label
      java.lang.String getIcon()
      Get small icon
      java.lang.String getKeys()
      Get shorthand keys
      java.lang.String getLabel​(java.lang.String lang)
      Get display label (alias to getDisplay)
      java.lang.String getName()
      Get name
      static java.lang.String getName​(java.lang.String rowId)
      Get shortcut name from rowId
      int getOrder()
      Get order
      java.lang.String getTarget()
      Get target
      java.lang.String getTooltip​(java.lang.String lang)
      Get tooltip
      java.lang.String getURL()
      Get URL
      java.lang.String getURL​(Grant g)
      Get URL applying expression
      boolean hasHeaderButton()
      Display as plain button in UI header?
      boolean hasHomeButton()
      Display as plain button in shortcuts home page?
      boolean isPlus()
      Is in header plus menu?
      boolean isVisible()
      Is visible?
      void setDisplay​(java.lang.String lang, java.lang.String disp)
      Set display label
      void setDisplay​(java.util.HashMap<java.lang.String,​java.lang.String> d)
      Set display labels map
      void setHeaderButton​(boolean b)
      Display as plain button in UI header
      void setHomeButton​(boolean b)
      Display as plain button in UI home
      void setIcon​(java.lang.String icon)
      Set small icon
      void setKeys​(java.lang.String keys)
      Set shorthand keys
      void setLabel​(java.util.HashMap<java.lang.String,​java.lang.String> d)
      Set display labels map (alias to setDisplay)
      void setName​(java.lang.String name)
      Set name
      void setOrder​(int o)
      Set order
      void setPlus​(boolean p)
      Display in plus menu
      void setTarget​(java.lang.String target)
      Set target
      void setTooltip​(java.lang.String lang, java.lang.String tip)
      Set display label
      void setURL​(java.lang.String url)
      Set URL
      void setVisible()
      Set visible if display on header, plus menu or home page
      void setVisible​(boolean vis)
      Set visible
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • Shortcut

        public Shortcut()
        Constructor
    • Method Detail

      • getName

        public java.lang.String getName()
        Get name
        Returns:
        Name
      • getName

        public static java.lang.String getName​(java.lang.String rowId)
        Get shortcut name from rowId
        Parameters:
        rowId - Row Id
        Returns:
        Shortcut name if exists
      • setName

        public void setName​(java.lang.String name)
        Set name
        Parameters:
        name - Name
      • getDisplay

        public java.lang.String getDisplay​(java.lang.String lang)
        Get display label
        Parameters:
        lang - Language
        Returns:
        Display label
      • getLabel

        public java.lang.String getLabel​(java.lang.String lang)
        Get display label (alias to getDisplay)
        Parameters:
        lang - Language
        Returns:
        Display label
      • setDisplay

        public void setDisplay​(java.util.HashMap<java.lang.String,​java.lang.String> d)
        Set display labels map
        Parameters:
        d - Display labels map
      • setLabel

        public void setLabel​(java.util.HashMap<java.lang.String,​java.lang.String> d)
        Set display labels map (alias to setDisplay)
        Parameters:
        d - Display label
      • setDisplay

        public void setDisplay​(java.lang.String lang,
                               java.lang.String disp)
        Set display label
        Parameters:
        lang - language
        disp - Display label
      • setTooltip

        public void setTooltip​(java.lang.String lang,
                               java.lang.String tip)
        Set display label
        Parameters:
        lang - language
        tip - tip message
      • getTooltip

        public java.lang.String getTooltip​(java.lang.String lang)
        Get tooltip
        Parameters:
        lang - Language
        Returns:
        tip or null if not exists
      • getOrder

        public int getOrder()
        Get order
        Returns:
        Order
      • setOrder

        public void setOrder​(int o)
        Set order
        Parameters:
        o - Order
      • getIcon

        public java.lang.String getIcon()
        Get small icon
        Returns:
        Small icon
      • setIcon

        public void setIcon​(java.lang.String icon)
        Set small icon
        Parameters:
        icon - Small icon
      • getKeys

        public java.lang.String getKeys()
        Get shorthand keys
        Returns:
        Shorthand keys
      • setKeys

        public void setKeys​(java.lang.String keys)
        Set shorthand keys
        Parameters:
        keys - Shorthand keys
      • isVisible

        public boolean isVisible()
        Is visible?
        Returns:
        True if visible
      • setVisible

        public void setVisible​(boolean vis)
        Set visible
        Parameters:
        vis - Visible?
      • setVisible

        public void setVisible()
        Set visible if display on header, plus menu or home page
      • isPlus

        public boolean isPlus()
        Is in header plus menu?
        Returns:
        True if in plus menu
      • setPlus

        public void setPlus​(boolean p)
        Display in plus menu
        Parameters:
        p - In plus menu?
      • hasHeaderButton

        public boolean hasHeaderButton()
        Display as plain button in UI header?
      • setHeaderButton

        public void setHeaderButton​(boolean b)
        Display as plain button in UI header
        Parameters:
        b - button visible?
      • hasHomeButton

        public boolean hasHomeButton()
        Display as plain button in shortcuts home page?
      • setHomeButton

        public void setHomeButton​(boolean b)
        Display as plain button in UI home
        Parameters:
        b - button visible?
      • getURL

        public java.lang.String getURL()
        Get URL
        Returns:
        URL
      • setURL

        public void setURL​(java.lang.String url)
        Set URL
        Parameters:
        url - URL
      • getURL

        public java.lang.String getURL​(Grant g)
        Get URL applying expression
        Parameters:
        g - Grant
        Returns:
        URL
      • getTarget

        public java.lang.String getTarget()
        Get target
        Returns:
        Target
      • setTarget

        public void setTarget​(java.lang.String target)
        Set target
        Parameters:
        target - Target