shortkey-docu

Principles of Short-Key Implementation

Short-Keys are keyboard pressed keys which can trigger actions related to database entries, like opening the entry in an editor. Each available key can be related to a single entry. The definition of such a relation is set up in the entry editor. The data element in the files is a Password Safe standard; ability to interchange the settings with other applications is possible but not guaranteed due to different policies relating to the set of available keys and other bottle-necks. Minimum implemented format version has to be 3.13.

The following rules apply to program version 0-7-0.

1. Loading: We load any short-keys as long as their given data render a valid stroke definition. Key defintions which are faulty in the understanding of the Java environment are ignored and, when the database is saved, overwritten by a null value.

2. Modification: Loaded keys (as embedded in record data) are not modified other than through active user modification, i.e. deletion or setup of a new value in the context of the record editor.

3. Display: Loaded keys are displayed in the record editor according to the text rendering given by the Java environment. This rendering is modified by JPasswords with part deletion and normalisation to upper case.

4. Usage: Usability of loaded keys is restricted by two sets of exclusive keys. A) The first is a "universal" set of unusable keys of terminal practice, like ENTER, arrow keys, etc. B) The second is the set of accelerator keys of the program menu, visible in the main program frame. While set A is always applied, set B is optional. The option can be set in program preferences. Entered keys which fall under restriction are not usable for shortcut reference, even when they are defined and shown in a database entry.

5. Definition (setup): All keys can be set up in the record editor that are rendered by the Java environment with meaningful data and do not fall under the functional restriction set of keys (Set A, see "Usage"). There is no "political" restriction active for setting up shortcut keys, but if restriction set B is active in the program, entered keys may actually not be operative.

6. Conflicts: If a key is set up in the editor which is already in use by another record, a warning is displayed. Conflicting setup is not suppressed but only one of the records is mapped to the key. A warning is also given if the key falls under restriction set B (see "Usage") independent of whether this set is active in the program.

7. Situative Restriction: The program may be unable to receive keyboard keys in some situations. Make sure the display of list or tree has the editing focus before applying shortcut keys.

8. Compatibility: Despite all efforts for interchange, there is no guarantee that keys set up in JPasswords will be usable in another application, and vise versa, due to different policies applied! As to our understanding, JPasswords has the widest possible tolerance for shortcut keys, so taking over of data sets from other applications is not expected to cause problems.

9. Key Modifiers: The following modifier keys can be used in combination with another key to define a shortcut in JPasswords: SHIFT, CONTROL, ALT, ALT_GRAPH, META.