General Interface is an open source project hosted by the Dojo Foundation

Hot Keys Registration and Deployment

When hot keys are assigned, they are registered with the closest ancestor DOM node that is a jsx3.gui.Window, jsx3.gui.Dialog, or root block of a server (JSXROOT).

Therefore, hot keys are global as there are no "protected" spaces. It is an error for two or more controls within the same scope to register the same hot key.

There are two choices for deploying applications with hot keys:

  • Body Hot Keys option checked
  • Body Hot Keys option unchecked

To set the Body Hot Keys option, choose Project > Project Settings > Deployment. The default setting for this option is unchecked.

The first deployment choice, Body Hot Keys option checked, is typically used for full-window applications. In this deployment scenario, if the hot key event bubbles up to the HTML body element, it is then sent to the application. So even if the focus is in the browser window and not in the General Interface application, the application receives the hot key and executes it.

The second choice, Body Hot Keys option unchecked, is recommend for General Interface applications deployed in a page with other General Interface applications. In this case, the hot keys only function if the focus is within the General Interface portlet application. This deployment prevents your application from responding to hot keys initiated in other General Interface portlet applications on the page.

Contents

Searching General Interface Docs

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.