Package com.hybris.cockpitng.keyboard

Interface KeyboardSupportService

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static char ALT_PREFIX  
      static java.lang.String BACKSPACE  
      static char CTRL_PREFIX  
      static java.lang.String DELETE  
      static java.lang.String DOWN  
      static java.lang.String END  
      static java.lang.String F1  
      static java.lang.String F10  
      static java.lang.String F11  
      static java.lang.String F12  
      static java.lang.String F2  
      static java.lang.String F3  
      static java.lang.String F4  
      static java.lang.String F5  
      static java.lang.String F6  
      static java.lang.String F7  
      static java.lang.String F8  
      static java.lang.String F9  
      static java.lang.String HOME  
      static java.lang.String INSERT  
      static java.lang.String LEFT  
      static java.lang.String PAGE_DOWN  
      static java.lang.String PAGE_UP  
      static java.lang.String RIGHT  
      static char SHIFT_PREFIX  
      static java.lang.String UP  

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean containsKeyEvent​(java.lang.String ctrlKeys, org.zkoss.zk.ui.event.KeyEvent keyEvent)
      Checks if given ctrlKeys contains given keyEvent
      java.lang.String convertToKeyEventCode​(org.zkoss.zk.ui.event.KeyEvent keyEvent)
      Converts given keyEvent to string representation.
      java.lang.String getToolTip​(java.lang.String ctrlKeys)
      Returns a tool tip text for given ctrl keys
      java.lang.String mergeCtrlKeys​(java.lang.String... ctrlKeysArg)
      Merges given control keys into one string with no duplicates.
      boolean validateCtrlKeys​(java.lang.String ctrlKeys)
      Checks if all ctrl keys are valid

    • Method Detail

      • containsKeyEvent

        boolean containsKeyEvent​(java.lang.String ctrlKeys,
                         org.zkoss.zk.ui.event.KeyEvent keyEvent)
        Checks if given ctrlKeys contains given keyEvent
        Parameters:
        ctrlKeys - ctrl keys
        keyEvent - key event
        Returns:
        true if ctrlKeys contains keyEventCode convertToKeyEventCode(KeyEvent)

      • mergeCtrlKeys

        java.lang.String mergeCtrlKeys​(java.lang.String... ctrlKeysArg)
        Merges given control keys into one string with no duplicates. All ctrl keys are transformed to lowercase
        Parameters:
        ctrlKeysArg - list of triggerOnKeys e.g. @0@b@#ins and @1@c@#ins
        Returns:
        merged control keys e.g. @0@b@#ins@1@c

      • validateCtrlKeys

        boolean validateCtrlKeys​(java.lang.String ctrlKeys)
        Checks if all ctrl keys are valid
        Parameters:
        ctrlKeys - ctrl keys valid.
        Returns:
        true if ctrl keys are valid.

      • convertToKeyEventCode

        java.lang.String convertToKeyEventCode​(org.zkoss.zk.ui.event.KeyEvent keyEvent)
        Converts given keyEvent to string representation. It will contain one of prefixes SHIFT_PREFIX, ALT_PREFIX or CTRL_PREFIX depending on modifiers in KeyEvent.isShiftKey(), KeyEvent.isAltKey(), KeyEvent.isCtrlKey()

        e.g. KeyEvent.DELETE which is represented by 46 and SHIFT pressed it should return $#del

        Parameters:
        keyEvent - key event
        Returns:
        string representation with modifier

      • getToolTip

        java.lang.String getToolTip​(java.lang.String ctrlKeys)
        Returns a tool tip text for given ctrl keys
        Parameters:
        ctrlKeys - control keys
        Returns:
        tool tip text