projects/dwt-addons: dwtx/jface/bindings/keys/KeySequence.d annotate

author	Frank Benoit <benoit@tionex.de>
date	Tue, 01 Apr 2008 08:00:31 +0200
parents
children	e10d9c2648be

rev	line source
16 e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	1 /*******************************************************************************
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	2 * Copyright (c) 2004, 2006 IBM Corporation and others.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	3 * All rights reserved. This program and the accompanying materials
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	4 * are made available under the terms of the Eclipse Public License v1.0
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	5 * which accompanies this distribution, and is available at
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	6 * http://www.eclipse.org/legal/epl-v10.html
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	7 *
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	8 * Contributors:
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	9 * IBM Corporation - initial API and implementation
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	10 * Port to the D programming language:
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	11 * Frank Benoit <benoit@tionex.de>
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	12 *******************************************************************************/
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	13
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	14 module dwtx.jface.bindings.keys.KeySequence;
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	15
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	16 import dwtx.jface.bindings.keys.KeyStroke;
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	17
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	18 import tango.util.collection.ArraySeq;
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	19 import tango.util.collection.model.Seq;
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	20 import tango.util.collection.model.SeqView;
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	21
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	22 import dwtx.jface.bindings.TriggerSequence;
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	23 import dwtx.jface.bindings.keys.formatting.KeyFormatterFactory;
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	24
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	25 import dwtx.jface.util.Util;
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	26
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	27 import dwt.dwthelper.utils;
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	28 static import tango.text.Util;
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	29 /**
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	30 * <p>
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	31 * A <code>KeySequence</code> is defined as a list of zero or more
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	32 * <code>KeyStrokes</code>, with the stipulation that all
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	33 * <code>KeyStroke</code> objects must be complete, save for the last one,
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	34 * whose completeness is optional. A <code>KeySequence</code> is said to be
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	35 * complete if all of its <code>KeyStroke</code> objects are complete.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	36 * </p>
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	37 * <p>
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	38 * All <code>KeySequence</code> objects have a formal string representation
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	39 * available via the <code>toString()</code> method. There are a number of
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	40 * methods to get instances of <code>KeySequence</code> objects, including one
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	41 * which can parse this formal string representation.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	42 * </p>
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	43 * <p>
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	44 * All <code>KeySequence</code> objects, via the <code>format()</code>
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	45 * method, provide a version of their formal string representation translated by
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	46 * platform and locale, suitable for display to a user.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	47 * </p>
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	48 * <p>
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	49 * <code>KeySequence</code> objects are immutable. Clients are not permitted
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	50 * to extend this class.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	51 * </p>
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	52 *
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	53 * @since 3.1
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	54 */
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	55 public final class KeySequence : TriggerSequence, Comparable {
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	56
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	57 /**
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	58 * An empty key sequence instance for use by everyone.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	59 */
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	60 private const static KeySequence EMPTY_KEY_SEQUENCE;
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	61
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	62 static this(){
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	63 EMPTY_KEY_SEQUENCE = new KeySequence(null);
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	64 }
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	65
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	66 /**
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	67 * The delimiter between multiple key strokes in a single key sequence --
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	68 * expressed in the formal key stroke grammar. This is not to be displayed
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	69 * to the user. It is only intended as an internal representation.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	70 */
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	71 public const static String KEY_STROKE_DELIMITER = "\u0020"; //$NON-NLS-1$
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	72
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	73 /**
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	74 * The set of delimiters for <code>KeyStroke</code> objects allowed during
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	75 * parsing of the formal string representation.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	76 */
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	77 public const static String KEY_STROKE_DELIMITERS = KEY_STROKE_DELIMITER
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	78 ~ "\b\r\u007F\u001B\f\n\0\t\u000B"; //$NON-NLS-1$
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	79
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	80 /**
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	81 * Gets an instance of <code>KeySequence</code>.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	82 *
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	83 * @return a key sequence. This key sequence will have no key strokes.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	84 * Guaranteed not to be <code>null</code>.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	85 */
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	86 public static final KeySequence getInstance() {
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	87 return EMPTY_KEY_SEQUENCE;
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	88 }
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	89
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	90 /**
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	91 * Creates an instance of <code>KeySequence</code> given a key sequence
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	92 * and a key stroke.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	93 *
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	94 * @param keySequence
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	95 * a key sequence. Must not be <code>null</code>.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	96 * @param keyStroke
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	97 * a key stroke. Must not be <code>null</code>.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	98 * @return a key sequence that is equal to the given key sequence with the
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	99 * given key stroke appended to the end. Guaranteed not to be
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	100 * <code>null</code>.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	101 */
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	102 public static final KeySequence getInstance(KeySequence keySequence,
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	103 KeyStroke keyStroke) {
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	104 if (keySequence is null \|\| keyStroke is null) {
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	105 throw new NullPointerException();
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	106 }
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	107
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	108 KeyStroke[] oldKeyStrokes = keySequence.getKeyStrokes();
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	109 int oldKeyStrokeLength = oldKeyStrokes.length;
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	110 KeyStroke[] newKeyStrokes = new KeyStroke[oldKeyStrokeLength + 1];
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	111 System.arraycopy(oldKeyStrokes, 0, newKeyStrokes, 0,
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	112 oldKeyStrokeLength);
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	113 newKeyStrokes[oldKeyStrokeLength] = keyStroke;
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	114 return new KeySequence(newKeyStrokes);
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	115 }
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	116
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	117 /**
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	118 * Creates an instance of <code>KeySequence</code> given a single key
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	119 * stroke.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	120 *
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	121 * @param keyStroke
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	122 * a single key stroke. Must not be <code>null</code>.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	123 * @return a key sequence. Guaranteed not to be <code>null</code>.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	124 */
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	125 public static final KeySequence getInstance(KeyStroke keyStroke) {
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	126 return new KeySequence([ keyStroke ]);
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	127 }
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	128
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	129 /**
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	130 * Creates an instance of <code>KeySequence</code> given an array of key
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	131 * strokes.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	132 *
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	133 * @param keyStrokes
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	134 * the array of key strokes. This array may be empty, but it must
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	135 * not be <code>null</code>. This array must not contain
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	136 * <code>null</code> elements.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	137 * @return a key sequence. Guaranteed not to be <code>null</code>.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	138 */
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	139 public static final KeySequence getInstance(KeyStroke[] keyStrokes) {
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	140 return new KeySequence(keyStrokes);
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	141 }
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	142
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	143 /**
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	144 * Creates an instance of <code>KeySequence</code> given a list of key
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	145 * strokes.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	146 *
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	147 * @param keyStrokes
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	148 * the list of key strokes. This list may be empty, but it must
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	149 * not be <code>null</code>. If this list is not empty, it
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	150 * must only contain instances of <code>KeyStroke</code>.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	151 * @return a key sequence. Guaranteed not to be <code>null</code>.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	152 */
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	153 public static final KeySequence getInstance(SeqView!(KeyStroke) keyStrokes) {
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	154 return new KeySequence(keyStrokes.toArray());
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	155 }
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	156
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	157 /**
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	158 * Creates an instance of <code>KeySequence</code> by parsing a given
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	159 * formal string representation.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	160 *
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	161 * @param string
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	162 * the formal string representation to parse.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	163 * @return a key sequence. Guaranteed not to be <code>null</code>.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	164 * @throws ParseException
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	165 * if the given formal string representation could not be parsed
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	166 * to a valid key sequence.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	167 */
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	168 public static final KeySequence getInstance(String string) {
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	169 if (string is null) {
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	170 throw new NullPointerException();
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	171 }
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	172
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	173 auto keyStrokes = new ArraySeq!(KeyStroke);
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	174
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	175 try {
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	176 auto tokens = tango.text.Util.delimit( string, KEY_STROKE_DELIMITERS );
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	177 KeyStroke[] keyStrokeArray = new KeyStroke[ tokens.length ];
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	178 foreach( idx, tok; tokens ){
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	179 keyStrokeArray[idx] = KeyStroke.getInstance(tok);
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	180 }
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	181 return new KeySequence(keyStrokeArray);
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	182 } catch (IllegalArgumentException e) {
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	183 throw new ParseException(
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	184 "Could not construct key sequence with these key strokes: " //$NON-NLS-1$
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	185 /+~ keyStrokes+/);
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	186 } catch (NullPointerException e) {
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	187 throw new ParseException(
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	188 "Could not construct key sequence with these key strokes: " //$NON-NLS-1$
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	189 /+~ keyStrokes+/);
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	190 }
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	191 }
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	192
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	193 /**
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	194 * Constructs an instance of <code>KeySequence</code> given a list of key
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	195 * strokes.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	196 *
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	197 * @param keyStrokes
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	198 * the list of key strokes. This list may be empty, but it must
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	199 * not be <code>null</code>. If this list is not empty, it
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	200 * must only contain instances of <code>KeyStroke</code>.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	201 */
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	202 protected this(KeyStroke[] keyStrokes) {
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	203 super(keyStrokes);
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	204
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	205 for (int i = 0; i < triggers.length - 1; i++) {
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	206 KeyStroke keyStroke = cast(KeyStroke) triggers[i];
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	207
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	208 if (!keyStroke.isComplete()) {
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	209 throw new IllegalArgumentException(null);
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	210 }
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	211 }
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	212 }
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	213
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	214 /*
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	215 * (non-Javadoc)
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	216 *
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	217 * @see java.lang.Object#compareTo(java.lang.Object)
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	218 */
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	219 public final int compareTo(Object object) {
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	220 KeySequence castedObject = cast(KeySequence) object;
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	221 return Util.compare( arraycast!(Comparable)(triggers), arraycast!(Comparable)(castedObject.triggers));
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	222 }
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	223
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	224 /**
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	225 * Formats this key sequence into the current default look.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	226 *
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	227 * @return A string representation for this key sequence using the default
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	228 * look; never <code>null</code>.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	229 */
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	230 public final String format() {
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	231 return KeyFormatterFactory.getDefault().format(this);
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	232 }
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	233
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	234 /**
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	235 * Returns the list of key strokes for this key sequence.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	236 *
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	237 * @return the list of key strokes keys. This list may be empty, but is
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	238 * guaranteed not to be <code>null</code>. If this list is not
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	239 * empty, it is guaranteed to only contain instances of
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	240 * <code>KeyStroke</code>.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	241 */
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	242 public final KeyStroke[] getKeyStrokes() {
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	243 int triggerLength = triggers.length;
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	244 KeyStroke[] keyStrokes = new KeyStroke[triggerLength];
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	245 System.arraycopy(triggers, 0, keyStrokes, 0, triggerLength);
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	246 return keyStrokes;
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	247 }
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	248
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	249 /*
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	250 * (non-Javadoc)
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	251 *
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	252 * @see dwtx.jface.bindings.TriggerSequence#getPrefixes()
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	253 */
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	254 public final TriggerSequence[] getPrefixes() {
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	255 int numberOfPrefixes = triggers.length;
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	256 TriggerSequence[] prefixes = new TriggerSequence[numberOfPrefixes];
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	257 prefixes[0] = KeySequence.getInstance();
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	258 for (int i = 0; i < numberOfPrefixes - 1; i++) {
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	259 final KeyStroke[] prefixKeyStrokes = new KeyStroke[i + 1];
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	260 System.arraycopy(triggers, 0, prefixKeyStrokes, 0, i + 1);
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	261 prefixes[i + 1] = KeySequence.getInstance(prefixKeyStrokes);
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	262 }
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	263
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	264 return prefixes;
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	265 }
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	266
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	267 /**
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	268 * Returns whether or not this key sequence is complete. Key sequences are
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	269 * complete iff all of their key strokes are complete.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	270 *
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	271 * @return <code>true</code>, iff the key sequence is complete.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	272 */
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	273 public final bool isComplete() {
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	274 int triggersLength = triggers.length;
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	275 for (int i = 0; i < triggersLength; i++) {
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	276 if (!(cast(KeyStroke) triggers[i]).isComplete()) {
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	277 return false;
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	278 }
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	279 }
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	280
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	281 return true;
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	282 }
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	283
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	284 /**
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	285 * Returns the formal string representation for this key sequence.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	286 *
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	287 * @return The formal string representation for this key sequence.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	288 * Guaranteed not to be <code>null</code>.
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	289 * @see java.lang.Object#toString()
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	290 */
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	291 public final String toString() {
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	292 return KeyFormatterFactory.getFormalKeyFormatter().format(this);
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	293 }
e0f0aaf75edd PopupDialog, bindings and actions Frank Benoit <benoit@tionex.de> parents: diff changeset	294 }

16

e0f0aaf75edd PopupDialog, bindings and actions