Java Doc for KeySequence.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 .KeySequence

KeySequence

final public class KeySequence implements Comparable(Code)

A KeySequence is defined as a list of zero or more KeyStrokes, with the stipulation that all KeyStroke objects must be complete, save for the last one, whose completeness is optional. A KeySequence is said to be complete if all of its KeyStroke objects are complete.

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

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

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

since:
3.0

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

Method Summary
public int	compareTo(Object object)
public boolean	endsWith(KeySequence keySequence, boolean equals) Returns whether or not this key sequence ends with the given key sequence. Parameters: keySequence - a key sequence.
public boolean	equals(Object object)
public String	format() Formats this key sequence into the current default look.
public static KeySequence	getInstance() Gets an instance of `KeySequence`. a key sequence.
public static KeySequence	getInstance(KeySequence keySequence, KeyStroke keyStroke) Gets an instance of `KeySequence` given a key sequence and a key stroke. Parameters: keySequence - a key sequence.
public static KeySequence	getInstance(KeyStroke keyStroke) Gets an instance of `KeySequence` given a single key stroke. Parameters: keyStroke - a single key stroke.
public static KeySequence	getInstance(KeyStroke[] keyStrokes) Gets an instance of `KeySequence` given an array of key strokes. Parameters: keyStrokes - the array of key strokes.
public static KeySequence	getInstance(List keyStrokes) Gets an instance of `KeySequence` given a list of key strokes. Parameters: keyStrokes - the list of key strokes.
final public static KeySequence	getInstance(org.eclipse.jface.bindings.keys.KeySequence newKeySequence) Gets an instance of `KeySequence` given a new-style key sequence. Parameters: newKeySequence - The new-style key sequence to convert into a legacy keysequence; must not be `null`.
public static KeySequence	getInstance(String string) Gets an instance of `KeySequence` by parsing a given a formal string representation. Parameters: string - the formal string representation to parse.
public List	getKeyStrokes() Returns the list of key strokes for this key sequence. the list of key strokes keys.
public int	hashCode()
public boolean	isComplete() Returns whether or not this key sequence is complete.
public boolean	isEmpty() Returns whether or not this key sequence is empty.
public boolean	startsWith(KeySequence keySequence, boolean equals) Returns whether or not this key sequence starts with the given key sequence. Parameters: keySequence - a key sequence.
public String	toString() Returns the formal string representation for this key sequence.

Field Detail

KEY_STROKE_DELIMITER
final public static String KEY_STROKE_DELIMITER(Code)
	The delimiter between multiple key strokes in a single key sequence -- 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_STROKE_DELIMITERS
final public static String KEY_STROKE_DELIMITERS(Code)
	The set of delimiters for `KeyStroke` objects allowed during parsing of the formal string representation.

Method Detail

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

endsWith
public boolean endsWith(KeySequence keySequence, boolean equals)(Code)
	Returns whether or not this key sequence ends with the given key sequence. Parameters: keySequence - a key sequence. Must not be `null`. Parameters: equals - whether or not an identical key sequence should be consideredas a possible match. `true`, iff the given key sequence ends with thiskey sequence.

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

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

getInstance
public static KeySequence getInstance()(Code)
	Gets an instance of `KeySequence`. a key sequence. This key sequence will have no key strokes.Guaranteed not to be `null`.

getInstance
public static KeySequence getInstance(KeySequence keySequence, KeyStroke keyStroke)(Code)
	Gets an instance of `KeySequence` given a key sequence and a key stroke. Parameters: keySequence - a key sequence. Must not be `null`. Parameters: keyStroke - a key stroke. Must not be `null`. a key sequence that is equal to the given key sequence with thegiven key stroke appended to the end. Guaranteed not to be`null`.

getInstance
public static KeySequence getInstance(KeyStroke keyStroke)(Code)
	Gets an instance of `KeySequence` given a single key stroke. Parameters: keyStroke - a single key stroke. Must not be `null`. a key sequence. Guaranteed not to be `null`.

getInstance
public static KeySequence getInstance(KeyStroke[] keyStrokes)(Code)
	Gets an instance of `KeySequence` given an array of key strokes. Parameters: keyStrokes - the array of key strokes. This array may be empty, but itmust not be `null`. This array must not contain`null` elements. a key sequence. Guaranteed not to be `null`.

getInstance
public static KeySequence getInstance(List keyStrokes)(Code)
	Gets an instance of `KeySequence` given a list of key strokes. Parameters: keyStrokes - the list of key strokes. This list may be empty, but it mustnot be `null`. If this list is not empty, itmust only contain instances of `KeyStroke`. a key sequence. Guaranteed not to be `null`.

getInstance
final public static KeySequence getInstance(org.eclipse.jface.bindings.keys.KeySequence newKeySequence)(Code)
	Gets an instance of `KeySequence` given a new-style key sequence. Parameters: newKeySequence - The new-style key sequence to convert into a legacy keysequence; must not be `null`. a key sequence; never `null`.

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

getKeyStrokes
public List getKeyStrokes()(Code)
	Returns the list of key strokes for this key sequence. the list of key strokes keys. This list may be empty, but isguaranteed not to be `null`. If this list is notempty, it is guaranteed to only contain instances of `KeyStroke`.

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

isComplete
public boolean isComplete()(Code)
	Returns whether or not this key sequence is complete. Key sequences are complete iff all of their key strokes are complete. `true`, iff the key sequence is complete.

isEmpty
public boolean isEmpty()(Code)
	Returns whether or not this key sequence is empty. Key sequences are complete iff they have no key strokes. `true`, iff the key sequence is empty.

startsWith
public boolean startsWith(KeySequence keySequence, boolean equals)(Code)
	Returns whether or not this key sequence starts with the given key sequence. Parameters: keySequence - a key sequence. Must not be `null`. Parameters: equals - whether or not an identical key sequence should be consideredas a possible match. `true`, iff the given key sequence starts withthis key sequence.

toString
public String toString()(Code)
	Returns the formal string representation for this key sequence. The formal string representation for this key sequence.Guaranteed not 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.