Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.jface.bindings.keys.formatting
Interface IKeyFormatter

All Known Implementing Classes:
AbstractKeyFormatter, EmacsKeyFormatter, FormalKeyFormatter, NativeKeyFormatter

public interface IKeyFormatter

Any formatter capable of taking a key sequence or a key stroke and converting it into a string. These formatters are used to produce the strings that the user sees in the keys preference page and the menus, as well as the strings that are used for persistent storage.

Since:
3.1

Method Summary
  String format (int key)
          Formats an individual key into a human readable format.
  String format ( KeySequence keySequence)
          Format the given key sequence into a string.
  String format ( KeyStroke keyStroke)
          Format the given key strokes into a string.
 

Method Detail

format

String format(int key)
Formats an individual key into a human readable format. This uses an internationalization resource bundle to look up the key. This does not do any platform-specific formatting (e.g., Carbon's command character).

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

format

String format(
KeySequence keySequence)
Format the given key sequence into a string. The manner of the conversion is dependent on the formatter. It is required that unequal key sequences return unequal strings.

Parameters:
keySequence - The key sequence to convert; must not be null.
Returns:
A string representation of the key sequence; must not be null.

format

String format(
KeyStroke keyStroke)
Format the given key strokes into a string. The manner of the conversion is dependent on the formatter. It is required that unequal key strokes return unequal strings.

Parameters:
keyStroke - The key stroke to convert; must not be null.
Returns:
A string representation of the key stroke; must not be null

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire