Eclipse Plug-in Developer Guide (Galileo) - EmacsKeyFormatter (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.jface.bindings.keys.formatting
Class EmacsKeyFormatter


java.lang.Object
  

org.eclipse.jface.bindings.keys.formatting.AbstractKeyFormatter
      
org.eclipse.jface.bindings.keys.formatting.EmacsKeyFormatter

All Implemented Interfaces:: IKeyFormatter

public final class EmacsKeyFormatter
extends AbstractKeyFormatter
extends AbstractKeyFormatter

A key formatter providing the Emacs-style accelerators using single letters to represent the modifier keys.

Since:: 3.1

Field Summary

Fields inherited from class org.eclipse.jface.bindings.keys.formatting. AbstractKeyFormatter

KEY_DELIMITER_KEY, KEY_STROKE_DELIMITER_KEY, NO_MODIFIER_KEYS

Constructor Summary

EmacsKeyFormatter ()


Method Summary

String format (int key)
          Formats an individual key into a human readable format.

protected String getKeyDelimiter ()
          An accessor for the delimiter you wish to use between keys.

protected String getKeyStrokeDelimiter ()
          An accessor for the delimiter you wish to use between key strokes.

protected int[] sortModifierKeys (int modifierKeys)
          Separates the modifier keys from each other, and then places them in an array in some sorted order.

Methods inherited from class org.eclipse.jface.bindings.keys.formatting. AbstractKeyFormatter

format, format

Methods inherited from class java.lang. Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EmacsKeyFormatter

public EmacsKeyFormatter()

Method Detail

format

public 
String format(int key)

Formats an individual key into a human readable format. This converts the key into a format similar to Xemacs.

Specified by:: format in interface IKeyFormatter
Overrides:: format in class AbstractKeyFormatter

Parameters:: key - The key to format; must not be null.
Returns:: The key formatted as a string; should not be null.

getKeyDelimiter

protected 
String getKeyDelimiter()

Description copied from class: AbstractKeyFormatter

An accessor for the delimiter you wish to use between keys. This is used by the default format implementations to determine the key delimiter.

Specified by:: getKeyDelimiter in class AbstractKeyFormatter

Returns:: The delimiter to use between keys; should not be null.

getKeyStrokeDelimiter

protected 
String getKeyStrokeDelimiter()

Description copied from class: AbstractKeyFormatter

An accessor for the delimiter you wish to use between key strokes. This used by the default format implementations to determine the key stroke delimiter.

Specified by:: getKeyStrokeDelimiter in class AbstractKeyFormatter

Returns:: The delimiter to use between key strokes; should not be null.

sortModifierKeys

protected int[] sortModifierKeys(int modifierKeys)

Description copied from class: AbstractKeyFormatter

Separates the modifier keys from each other, and then places them in an array in some sorted order. The sort order is dependent on the type of formatter.

Specified by:: sortModifierKeys in class AbstractKeyFormatter

Parameters:: modifierKeys - The modifier keys from the key stroke.
Returns:: An array of modifier key values -- separated and sorted in some order. Any values in this array that are KeyStroke.NO_KEY should be ignored.