Java Doc for KeyStroke.java in » IDE-Eclipse » ui-workbench » org » eclipse » ui » keys » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » IDE Eclipse » ui workbench » org.eclipse.ui.keys

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

org.eclipse.ui.keys .KeyStroke

KeyStroke

final public class KeyStroke implements Comparable(Code)

A KeyStroke is defined as an optional set of modifier keys followed optionally by a natural key. A KeyStroke is said to be complete if it contains a natural key. A natural key is any Unicode character (e.g., "backspace", etc.), any character belonging to a natural language (e.g., "A", "1", "[", etc.), or any special control character specific to computers (e.g., "F10", "PageUp", etc.).

All KeyStroke objects have a formal string representation available via the toString() method. There are a number of methods to get instances of KeyStroke objects, including one which can parse this formal string representation.

All KeyStroke objects, via the format() method, provide a version of their formal string representation translated by platform and locale, suitable for display to a user.

KeyStroke objects are immutable. Clients are not permitted to extend this class.

since:
   3.0
See Also:   org.eclipse.ui.keys.ModifierKey
See Also:   org.eclipse.ui.keys.NaturalKey

Field Summary
final public static String	KEY_DELIMITER The delimiter between multiple keys in a single key strokes -- expressed in the formal key stroke grammar.
final public static String	KEY_DELIMITERS The set of delimiters for `Key` objects allowed during parsing of the formal string representation.

Method Summary
public int	compareTo(Object object)
public boolean	equals(Object object)
public String	format() Formats this key stroke into the current default look.
public static KeyStroke	getInstance(ModifierKey modifierKey, NaturalKey naturalKey) Gets an instance of `KeyStroke` given a single modifier key and a natural key. Parameters: modifierKey - a modifier key.
public static KeyStroke	getInstance(ModifierKey[] modifierKeys, NaturalKey naturalKey) Gets an instance of `KeyStroke` given an array of modifier keys and a natural key. Parameters: modifierKeys - the array of modifier keys.
public static KeyStroke	getInstance(NaturalKey naturalKey) Gets an instance of `KeyStroke` given a natural key. Parameters: naturalKey - the natural key.
public static KeyStroke	getInstance(SortedSet modifierKeys, NaturalKey naturalKey) Gets an instance of `KeyStroke` given a set of modifier keys and a natural key. Parameters: modifierKeys - the set of modifier keys.
public static KeyStroke	getInstance(String string) Gets an instance of `KeyStroke` by parsing a given a formal string representation. Parameters: string - the formal string representation to parse.
public Set	getModifierKeys() Returns the set of modifier keys for this key stroke. the set of modifier keys.
public NaturalKey	getNaturalKey() Returns the natural key for this key stroke. the natural key.
public int	hashCode()
public boolean	isComplete() Returns whether or not this key stroke is complete.
public String	toString() Returns the formal string representation for this key stroke. The formal string representation for this key stroke.

Field Detail

KEY_DELIMITER
final public static String KEY_DELIMITER(Code)
	The delimiter between multiple keys in a single key strokes -- expressed in the formal key stroke grammar. This is not to be displayed to the user. It is only intended as an internal representation.

KEY_DELIMITERS
final public static String KEY_DELIMITERS(Code)
	The set of delimiters for `Key` objects allowed during parsing of the formal string representation.

Method Detail

compareTo
public int compareTo(Object object)(Code)
	See Also: java.lang.Comparable.compareTo(java.lang.Object)

equals
public boolean equals(Object object)(Code)
	See Also: java.lang.Object.equals(java.lang.Object)

format
public String format()(Code)
	Formats this key stroke into the current default look. A string representation for this key stroke using the defaultlook; never `null`.

getInstance
public static KeyStroke getInstance(ModifierKey modifierKey, NaturalKey naturalKey)(Code)
	Gets an instance of `KeyStroke` given a single modifier key and a natural key. Parameters: modifierKey - a modifier key. Must not be `null`. Parameters: naturalKey - the natural key. May be `null`. a key stroke. Guaranteed not to be `null`.

getInstance
public static KeyStroke getInstance(ModifierKey[] modifierKeys, NaturalKey naturalKey)(Code)
	Gets an instance of `KeyStroke` given an array of modifier keys and a natural key. Parameters: modifierKeys - the array of modifier keys. This array may be empty, but itmust not be `null`. If this array is not empty,it must not contain `null` elements. Parameters: naturalKey - the natural key. May be `null`. a key stroke. Guaranteed not to be `null`.

getInstance
public static KeyStroke getInstance(NaturalKey naturalKey)(Code)
	Gets an instance of `KeyStroke` given a natural key. Parameters: naturalKey - the natural key. May be `null`. a key stroke. This key stroke will have no modifier keys.Guaranteed not to be `null`.

getInstance
public static KeyStroke getInstance(SortedSet modifierKeys, NaturalKey naturalKey)(Code)
	Gets an instance of `KeyStroke` given a set of modifier keys and a natural key. Parameters: modifierKeys - the set of modifier keys. This set may be empty, but it mustnot be `null`. If this set is not empty, itmust only contain instances of `ModifierKey`. Parameters: naturalKey - the natural key. May be `null`. a key stroke. Guaranteed not to be `null`.

getInstance
public static KeyStroke getInstance(String string) throws ParseException(Code)
	Gets an instance of `KeyStroke` by parsing a given a formal string representation. Parameters: string - the formal string representation to parse. a key stroke. Guaranteed not to be `null`. throws: ParseException - if the given formal string representation could not beparsed to a valid key stroke.

getModifierKeys
public Set getModifierKeys()(Code)
	Returns the set of modifier keys for this key stroke. the set of modifier keys. This set may be empty, but isguaranteed not to be `null`. If this set is notempty, it is guaranteed to only contain instances of `ModifierKey`.

getNaturalKey
public NaturalKey getNaturalKey()(Code)
	Returns the natural key for this key stroke. the natural key. May be `null`.

hashCode
public int hashCode()(Code)
	See Also: java.lang.Object.hashCode

isComplete
public boolean isComplete()(Code)
	Returns whether or not this key stroke is complete. Key strokes are complete iff they have a natural key which is not `null`. `true`, iff the key stroke is complete.

toString
public String toString()(Code)
	Returns the formal string representation for this key stroke. The formal string representation for this key stroke. Guaranteednot to be `null`. See Also: java.lang.Object.toString

Methods inherited from java.lang.Object

native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.