topic open a widget with keyboard shortcut in ArcGIS API for Flex Questions

open a widget with keyboard shortcut

RobertAndren — Wed, 23 Mar 2011 14:29:33 GMT

I am just starting out with flex using the ArcGIS Viewer for Flex and was wondering how to open a widget (ex. Bookmarks) with a keyboard event.

Re: open a widget with keyboard shortcut

JohnGarvey — Wed, 23 Mar 2011 16:12:28 GMT

Good idea.

I would register a keyboard event and then have a listener that looksa for a particular character code and dispatches an appEvent to openWidget when the character matches the shortcut.

You could add the keyboard event listener to the widget manager.

Re: open a widget with keyboard shortcut

RobertScheitlin__GISP — Wed, 23 Mar 2011 16:39:18 GMT

Actually I think you would have to have the KeyboardEvent listener added to the stage in the main application (i.e. index.mxml).

Something like this added to the index.mxml on application complete event:

stage.addEventListener(KeyboardEvent.KEY_DOWN, handleKeyDown);

and then use a dispatch event like this to launch the widget:

ViewerContainer.dispatchEvent(new AppEvent(AppEvent.WIDGET_RUN, id));

Where id is the number of the widget (each widget as it is loaded is given a sequential number starting at 0).

Re: open a widget with keyboard shortcut

RobertAndren — Wed, 23 Mar 2011 18:42:27 GMT

I added the KeyboardEvent listener to the stage in the main application like Robert suggested but the user has to click inside the map before the keyboard shortcut works. Would it be possible enable the shortcut without first clicking in the map?

Re: open a widget with keyboard shortcut

RobertScheitlin__GISP — Sun, 12 Dec 2021 00:52:04 GMT

Robert,

The Flex Viewer application does not have focus when the app is launched so you have to add some code in the index.mxml to force it to have focus immediately.

Add this script block to the index.mxml:

<fx:Script>
  <![CDATA[   
   protected function init():void
   {
    navigateToURL(new URLRequest("javascript: document.getElementById('index').focus();"), "_self");
   }
  ]]>
 </fx:Script>

Re: open a widget with keyboard shortcut

RobertAndren — Thu, 24 Mar 2011 12:56:51 GMT

That did the trick. Thanks for all your help.

Re: open a widget with keyboard shortcut

MarkHoyland — Sun, 12 Dec 2021 00:52:06 GMT

Or if you wish to try, here is an xml configurable keyboard shortcut widget.

The widget config file lets you put in the widget label (as defined in the viewers main config xml),
the key and optional boolean values for ctrl, alt and shift keys. The default for these is false.

eg key=s and ctrl=true is CTRL+s
key=s and ctrl=false is s

Add to your main config file in the UI Elements part

<!-- UI elements -->
    <widget config="widgets/KeyboardShortcuts/KeyboardShortcutsWidget.xml"
            url="widgets/KeyboardShortcuts/KeyboardShortcutsWidget.swf"/>

Let me know if you think this is useful, and I can upload to the code gallery with compiled version.