Class SKeyShortcut

Object
   |
   +--SKeyShortcut

class SKeyShortcut

Defined in SKeyShortcut.js

Version: 1.0

Author: deltapositive (deltapositive@yahoo.fr)

Field Detail

ALT_KEY_MODIFIER

<static> string ALT_KEY_MODIFIER

This constant defines the ALT key prefix in a key sequence.

CTRL_KEY_MODIFIER

<static> string CTRL_KEY_MODIFIER

This constant defines the CTRL key prefix in a key sequence.

ESCAPE_KEY

<static> string ESCAPE_KEY

This constant defines the ESCAPE key code in a key sequence.

FUNCTION_PREFIX_KEY

<static> string FUNCTION_PREFIX_KEY

This constant defines the prefix of the functions key (F1 to F12) code in a key sequence.

RETURN_KEY

<static> string RETURN_KEY

This constant defines the RETURN key code in a key sequence.

SHIFT_KEY_MODIFIER

<static> string SHIFT_KEY_MODIFIER

This constant defines the SHIFT key prefix in a key sequence.

SKeyShortcut

SKeyShortcut()

SKeyShortcut is part of the STools.

Copyright 2005 STools

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.


SKeyShortcut is a class that creates an association between a key (or an association of key) and a javascript function.

Basic usage :
This class is usefull to get the user pressed 'Return' to close a dialog box.
This class is used in a menu to associate a shortcut to an item.

Version: 1.0

Author: deltapositive (deltapositive@yahoo.fr)

getParameter

Object getParameter(<string> name)

Get a parameter's value

Parameters:
name - The name of the parameter to get.

Returns:
The value of the parameter

setEventListener

void setEventListener(<string> event, <function> listener)

Set a listener for an event.

Parameters:
event - The name of the event to listen among:
• "onkeydown" boolean function (skeyshortcut, event),
• "onkeyup" boolean function (skeyshortcut, event),
All of the three functions may return false to stop event propagation.
listener - The function to call if corresponding event is fired.

setKeySequence

void setKeySequence(<string> sequence)

Set the key sequence for the shortcut
For example: SKeyShortcut.FUNCTION_PREFIX_KEY + '3' assign a shortcut for the F3 key
A sequence is defined by zero, one or more modifier (from Ctrl, Alt and Shift) and a key.

Parameters:
sequence - The sequence to bind.

setParameter

void setParameter(<string> name, <Object> value)

Set a parameter

Parameters:
name - The name of the parameter to set.
value - The value of the parameter.