projects/dwt2: org.eclipse.core.commands/src/org/eclipse/core/commands/Command.d annotate

author	Frank Benoit <benoit@tionex.de>
date	Sat, 14 Mar 2009 18:23:29 +0100
parents
children	735224fcc45f

rev	line source
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	1 /*******************************************************************************
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	2 * Copyright (c) 2004, 2008 IBM Corporation and others.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	3 * All rights reserved. This program and the accompanying materials
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	4 * are made available under the terms of the Eclipse Public License v1.0
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	5 * which accompanies this distribution, and is available at
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	6 * http://www.eclipse.org/legal/epl-v10.html
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	7 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	8 * Contributors:
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	9 * IBM Corporation - initial API and implementation
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	10 * Port to the D programming language:
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	11 * Frank Benoit <benoit@tionex.de>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	12 *******************************************************************************/
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	13 module org.eclipse.core.commands.Command;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	14
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	15 // import java.io.BufferedWriter;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	16 // import java.io.IOException;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	17 // import java.io.StringWriter;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	18
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	19 import org.eclipse.core.commands.common.NotDefinedException;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	20 import org.eclipse.core.commands.util.Tracing;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	21 import org.eclipse.core.internal.commands.util.Util;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	22 import org.eclipse.core.runtime.ISafeRunnable;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	23 import org.eclipse.core.runtime.ListenerList;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	24 import org.eclipse.core.runtime.SafeRunner;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	25
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	26 import org.eclipse.core.commands.IParameter;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	27 import org.eclipse.core.commands.IHandlerListener;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	28 import org.eclipse.core.commands.NotEnabledException;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	29 import org.eclipse.core.commands.NotHandledException;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	30 import org.eclipse.core.commands.ExecutionException;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	31 import org.eclipse.core.commands.CommandEvent;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	32 import org.eclipse.core.commands.State;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	33 import org.eclipse.core.commands.Category;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	34 import org.eclipse.core.commands.NamedHandleObjectWithState;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	35 import org.eclipse.core.commands.ExecutionEvent;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	36 import org.eclipse.core.commands.ParameterType;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	37 import org.eclipse.core.commands.IExecutionListener;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	38 import org.eclipse.core.commands.ICommandListener;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	39 import org.eclipse.core.commands.IHandler;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	40 import org.eclipse.core.commands.IHandler2;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	41 import org.eclipse.core.commands.IObjectWithState;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	42 import org.eclipse.core.commands.IExecutionListenerWithChecks;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	43 import org.eclipse.core.commands.ITypedParameter;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	44 import org.eclipse.core.commands.HandlerEvent;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	45
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	46 import java.lang.all;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	47 import tango.io.Stdout;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	48
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	49 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	50 * <p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	51 * A command is an abstract representation for some semantic behaviour. It is
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	52 * not the actual implementation of this behaviour, nor is it the visual
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	53 * appearance of this behaviour in the user interface. Instead, it is a bridge
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	54 * between the two.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	55 * </p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	56 * <p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	57 * The concept of a command is based on the command design pattern. The notable
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	58 * difference is how the command delegates responsibility for execution. Rather
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	59 * than allowing concrete subclasses, it uses a handler mechanism (see the
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	60 * <code>handlers</code> extension point). This provides another level of
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	61 * indirection.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	62 * </p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	63 * <p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	64 * A command will exist in two states: defined and undefined. A command is
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	65 * defined if it is declared in the XML of a resolved plug-in. If the plug-in is
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	66 * unloaded or the command is simply not declared, then it is undefined. Trying
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	67 * to reference an undefined command will succeed, but trying to access any of
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	68 * its functionality will fail with a <code>NotDefinedException</code>. If
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	69 * you need to know when a command changes from defined to undefined (or vice
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	70 * versa), then attach a command listener.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	71 * </p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	72 * <p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	73 * Commands are mutable and will change as their definition changes.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	74 * </p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	75 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	76 * @since 3.1
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	77 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	78 public final class Command : NamedHandleObjectWithState,
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	79 Comparable {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	80
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	81 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	82 * This flag can be set to <code>true</code> if commands should print
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	83 * information to <code>System.out</code> when executing.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	84 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	85 public static bool DEBUG_COMMAND_EXECUTION = false;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	86
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	87 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	88 * This flag can be set to <code>true</code> if commands should print
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	89 * information to <code>System.out</code> when changing handlers.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	90 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	91 public static bool DEBUG_HANDLERS = false;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	92
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	93 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	94 * This flag can be set to a particular command identifier if only that
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	95 * command should print information to <code>System.out</code> when
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	96 * changing handlers.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	97 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	98 public static String DEBUG_HANDLERS_COMMAND_ID = null;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	99
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	100 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	101 * The category to which this command belongs. This value should not be
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	102 * <code>null</code> unless the command is undefined.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	103 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	104 private Category category = null;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	105
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	106 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	107 * A collection of objects listening to the execution of this command. This
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	108 * collection is <code>null</code> if there are no listeners.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	109 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	110 private /+transient+/ ListenerList executionListeners = null;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	111
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	112 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	113 * The handler currently associated with this command. This value may be
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	114 * <code>null</code> if there is no handler currently.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	115 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	116 private /+transient+/ IHandler handler = null;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	117
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	118 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	119 * The help context identifier for this command. This can be
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	120 * <code>null</code> if there is no help currently associated with the
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	121 * command.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	122 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	123 * @since 3.2
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	124 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	125 private String helpContextId;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	126
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	127 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	128 * The ordered array of parameters understood by this command. This value
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	129 * may be <code>null</code> if there are no parameters, or if the command
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	130 * is undefined. It may also be empty.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	131 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	132 private IParameter[] parameters = null;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	133
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	134 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	135 * The type of the return value of this command. This value may be
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	136 * <code>null</code> if the command does not declare a return type.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	137 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	138 * @since 3.2
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	139 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	140 private ParameterType returnType = null;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	141
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	142 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	143 * Our command will listen to the active handler for enablement changes so
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	144 * that they can be fired from the command itself.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	145 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	146 * @since 3.3
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	147 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	148 private IHandlerListener handlerListener;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	149
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	150 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	151 * Constructs a new instance of <code>Command</code> based on the given
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	152 * identifier. When a command is first constructed, it is undefined.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	153 * Commands should only be constructed by the <code>CommandManager</code>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	154 * to ensure that the identifier remains unique.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	155 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	156 * @param id
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	157 * The identifier for the command. This value must not be
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	158 * <code>null</code>, and must be unique amongst all commands.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	159 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	160 this(String id) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	161 super(id);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	162 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	163
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	164 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	165 * Adds a listener to this command that will be notified when this command's
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	166 * state changes.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	167 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	168 * @param commandListener
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	169 * The listener to be added; must not be <code>null</code>.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	170 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	171 public final void addCommandListener(ICommandListener commandListener) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	172 if (commandListener is null) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	173 throw new NullPointerException("Cannot add a null command listener"); //$NON-NLS-1$
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	174 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	175 addListenerObject(cast(Object)commandListener);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	176 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	177
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	178 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	179 * Adds a listener to this command that will be notified when this command
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	180 * is about to execute.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	181 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	182 * @param executionListener
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	183 * The listener to be added; must not be <code>null</code>.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	184 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	185 public final void addExecutionListener(
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	186 IExecutionListener executionListener) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	187 if (executionListener is null) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	188 throw new NullPointerException(
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	189 "Cannot add a null execution listener"); //$NON-NLS-1$
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	190 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	191
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	192 if (executionListeners is null) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	193 executionListeners = new ListenerList(ListenerList.IDENTITY);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	194 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	195
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	196 executionListeners.add(cast(Object)executionListener);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	197 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	198
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	199 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	200 * <p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	201 * Adds a state to this command. This will add this state to the active
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	202 * handler, if the active handler is an instance of {@link IObjectWithState}.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	203 * </p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	204 * <p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	205 * A single instance of {@link State} cannot be registered with multiple
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	206 * commands. Each command requires its own unique instance.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	207 * </p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	208 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	209 * @param id
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	210 * The identifier of the state to add; must not be
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	211 * <code>null</code>.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	212 * @param state
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	213 * The state to add; must not be <code>null</code>.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	214 * @since 3.2
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	215 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	216 public override void addState(String id, State state) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	217 super.addState(id, state);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	218 state.setId(id);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	219 if ( auto h = cast(IObjectWithState)handler) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	220 h.addState(id, state);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	221 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	222 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	223
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	224 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	225 * Compares this command with another command by comparing each of its
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	226 * non-transient attributes.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	227 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	228 * @param object
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	229 * The object with which to compare; must be an instance of
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	230 * <code>Command</code>.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	231 * @return A negative integer, zero or a postivie integer, if the object is
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	232 * greater than, equal to or less than this command.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	233 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	234 public final int compareTo(Object object) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	235 Command castedObject = cast(Command) object;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	236 int compareTo = Util.compare(category, castedObject.category);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	237 if (compareTo is 0) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	238 compareTo = Util.compare(defined, castedObject.defined);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	239 if (compareTo is 0) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	240 compareTo = Util.compare(description, castedObject.description);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	241 if (compareTo is 0) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	242 compareTo = Util.compare(cast(Object)handler, cast(Object)castedObject.handler);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	243 if (compareTo is 0) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	244 compareTo = Util.compare(id, castedObject.id);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	245 if (compareTo is 0) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	246 compareTo = Util.compare(name, castedObject.name);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	247 if (compareTo is 0) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	248 Object[] left, right;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	249 foreach( p; parameters ){
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	250 left ~= cast(Object)p;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	251 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	252 foreach( p; castedObject.parameters ){
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	253 right ~= cast(Object)p;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	254 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	255 compareTo = Util.compare(left,
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	256 right);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	257 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	258 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	259 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	260 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	261 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	262 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	263 return compareTo;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	264 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	265
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	266 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	267 * <p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	268 * Defines this command by giving it a name, and possibly a description as
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	269 * well. The defined property automatically becomes <code>true</code>.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	270 * </p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	271 * <p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	272 * Notification is sent to all listeners that something has changed.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	273 * </p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	274 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	275 * @param name
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	276 * The name of this command; must not be <code>null</code>.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	277 * @param description
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	278 * The description for this command; may be <code>null</code>.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	279 * @param category
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	280 * The category for this command; must not be <code>null</code>.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	281 * @since 3.2
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	282 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	283 public final void define(String name, String description,
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	284 Category category) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	285 define(name, description, category, null);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	286 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	287
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	288 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	289 * <p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	290 * Defines this command by giving it a name, and possibly a description as
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	291 * well. The defined property automatically becomes <code>true</code>.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	292 * </p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	293 * <p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	294 * Notification is sent to all listeners that something has changed.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	295 * </p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	296 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	297 * @param name
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	298 * The name of this command; must not be <code>null</code>.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	299 * @param description
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	300 * The description for this command; may be <code>null</code>.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	301 * @param category
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	302 * The category for this command; must not be <code>null</code>.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	303 * @param parameters
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	304 * The parameters understood by this command. This value may be
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	305 * either <code>null</code> or empty if the command does not
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	306 * accept parameters.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	307 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	308 public final void define(String name, String description,
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	309 Category category, IParameter[] parameters) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	310 define(name, description, category, parameters, null);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	311 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	312
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	313 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	314 * <p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	315 * Defines this command by giving it a name, and possibly a description as
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	316 * well. The defined property automatically becomes <code>true</code>.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	317 * </p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	318 * <p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	319 * Notification is sent to all listeners that something has changed.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	320 * </p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	321 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	322 * @param name
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	323 * The name of this command; must not be <code>null</code>.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	324 * @param description
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	325 * The description for this command; may be <code>null</code>.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	326 * @param category
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	327 * The category for this command; must not be <code>null</code>.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	328 * @param parameters
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	329 * The parameters understood by this command. This value may be
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	330 * either <code>null</code> or empty if the command does not
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	331 * accept parameters.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	332 * @param returnType
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	333 * The type of value returned by this command. This value may be
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	334 * <code>null</code> if the command does not declare a return
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	335 * type.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	336 * @since 3.2
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	337 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	338 public final void define(String name, String description,
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	339 Category category, IParameter[] parameters,
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	340 ParameterType returnType) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	341 define(name, description, category, parameters, returnType, null);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	342 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	343
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	344 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	345 * <p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	346 * Defines this command by giving it a name, and possibly a description as
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	347 * well. The defined property automatically becomes <code>true</code>.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	348 * </p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	349 * <p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	350 * Notification is sent to all listeners that something has changed.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	351 * </p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	352 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	353 * @param name
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	354 * The name of this command; must not be <code>null</code>.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	355 * @param description
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	356 * The description for this command; may be <code>null</code>.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	357 * @param category
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	358 * The category for this command; must not be <code>null</code>.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	359 * @param parameters
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	360 * The parameters understood by this command. This value may be
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	361 * either <code>null</code> or empty if the command does not
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	362 * accept parameters.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	363 * @param returnType
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	364 * The type of value returned by this command. This value may be
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	365 * <code>null</code> if the command does not declare a return
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	366 * type.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	367 * @param helpContextId
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	368 * The identifier of the help context to associate with this
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	369 * command; may be <code>null</code> if this command does not
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	370 * have any help associated with it.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	371 * @since 3.2
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	372 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	373 public final void define(String name, String description,
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	374 Category category, IParameter[] parameters,
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	375 ParameterType returnType, String helpContextId) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	376 if (name is null) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	377 throw new NullPointerException(
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	378 "The name of a command cannot be null"); //$NON-NLS-1$
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	379 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	380
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	381 if (category is null) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	382 throw new NullPointerException(
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	383 "The category of a command cannot be null"); //$NON-NLS-1$
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	384 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	385
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	386 bool definedChanged = !this.defined;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	387 this.defined = true;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	388
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	389 bool nameChanged = !Util.equals(this.name, name);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	390 this.name = name;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	391
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	392 bool descriptionChanged = !Util.equals(this.description,
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	393 description);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	394 this.description = description;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	395
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	396 bool categoryChanged = !Util.equals(this.category, category);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	397 this.category = category;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	398
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	399 Object[] pLeft, pRight;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	400 foreach( p; this.parameters ){
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	401 pLeft ~= cast(Object)p;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	402 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	403 foreach( p; parameters ){
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	404 pRight ~= cast(Object)p;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	405 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	406 bool parametersChanged = !Util.equals(pLeft,
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	407 pRight);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	408 this.parameters = parameters;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	409
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	410 bool returnTypeChanged = !Util.equals(this.returnType,
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	411 returnType);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	412 this.returnType = returnType;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	413
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	414 bool helpContextIdChanged = !Util.equals(this.helpContextId,
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	415 helpContextId);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	416 this.helpContextId = helpContextId;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	417
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	418 fireCommandChanged(new CommandEvent(this, categoryChanged,
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	419 definedChanged, descriptionChanged, false, nameChanged,
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	420 parametersChanged, returnTypeChanged, helpContextIdChanged));
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	421 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	422
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	423 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	424 * Executes this command by delegating to the current handler, if any. If
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	425 * the debugging flag is set, then this method prints information about
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	426 * which handler is selected for performing this command. This method will
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	427 * succeed regardless of whether the command is enabled or defined. It is
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	428 * generally preferred to call {@link #executeWithChecks(ExecutionEvent)}.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	429 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	430 * @param event
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	431 * An event containing all the information about the current
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	432 * state of the application; must not be <code>null</code>.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	433 * @return The result of the execution; may be <code>null</code>. This
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	434 * result will be available to the client executing the command, and
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	435 * execution listeners.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	436 * @throws ExecutionException
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	437 * If the handler has problems executing this command.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	438 * @throws NotHandledException
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	439 * If there is no handler.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	440 * @deprecated Please use {@link #executeWithChecks(ExecutionEvent)}
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	441 * instead.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	442 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	443 public final Object execute(ExecutionEvent event) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	444 firePreExecute(event);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	445 IHandler handler = this.handler;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	446
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	447 // Perform the execution, if there is a handler.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	448 if ((handler !is null) && (handler.isHandled())) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	449 try {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	450 Object returnValue = handler.execute(event);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	451 firePostExecuteSuccess(returnValue);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	452 return returnValue;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	453 } catch (ExecutionException e) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	454 firePostExecuteFailure(e);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	455 throw e;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	456 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	457 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	458
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	459 NotHandledException e = new NotHandledException(
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	460 "There is no handler to execute. " ~ getId()); //$NON-NLS-1$
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	461 fireNotHandled(e);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	462 throw e;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	463 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	464
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	465 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	466 * Executes this command by delegating to the current handler, if any. If
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	467 * the debugging flag is set, then this method prints information about
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	468 * which handler is selected for performing this command. This does checks
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	469 * to see if the command is enabled and defined. If it is not both enabled
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	470 * and defined, then the execution listeners will be notified and an
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	471 * exception thrown.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	472 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	473 * @param event
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	474 * An event containing all the information about the current
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	475 * state of the application; must not be <code>null</code>.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	476 * @return The result of the execution; may be <code>null</code>. This
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	477 * result will be available to the client executing the command, and
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	478 * execution listeners.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	479 * @throws ExecutionException
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	480 * If the handler has problems executing this command.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	481 * @throws NotDefinedException
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	482 * If the command you are trying to execute is not defined.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	483 * @throws NotEnabledException
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	484 * If the command you are trying to execute is not enabled.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	485 * @throws NotHandledException
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	486 * If there is no handler.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	487 * @since 3.2
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	488 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	489 public final Object executeWithChecks(ExecutionEvent event) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	490 firePreExecute(event);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	491 IHandler handler = this.handler;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	492
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	493 if (!isDefined()) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	494 NotDefinedException exception = new NotDefinedException(
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	495 "Trying to execute a command that is not defined. " //$NON-NLS-1$
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	496 ~ getId());
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	497 fireNotDefined(exception);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	498 throw exception;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	499 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	500

12

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1 /*******************************************************************************

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

4 * are made available under the terms of the Eclipse Public License v1.0

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

5 * which accompanies this distribution, and is available at

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

6 * http://www.eclipse.org/legal/epl-v10.html

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

7 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

8 * Contributors:

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

9 * IBM Corporation - initial API and implementation

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

10 * Port to the D programming language:

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

11 * Frank Benoit <benoit@tionex.de>

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

12 *******************************************************************************/

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

13 module org.eclipse.core.commands.Command;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

14

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

15 // import java.io.BufferedWriter;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

16 // import java.io.IOException;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

17 // import java.io.StringWriter;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

18

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

19 import org.eclipse.core.commands.common.NotDefinedException;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

20 import org.eclipse.core.commands.util.Tracing;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

21 import org.eclipse.core.internal.commands.util.Util;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

22 import org.eclipse.core.runtime.ISafeRunnable;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

23 import org.eclipse.core.runtime.ListenerList;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

24 import org.eclipse.core.runtime.SafeRunner;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

25

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

26 import org.eclipse.core.commands.IParameter;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

27 import org.eclipse.core.commands.IHandlerListener;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

28 import org.eclipse.core.commands.NotEnabledException;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

29 import org.eclipse.core.commands.NotHandledException;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

30 import org.eclipse.core.commands.ExecutionException;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

31 import org.eclipse.core.commands.CommandEvent;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

32 import org.eclipse.core.commands.State;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

33 import org.eclipse.core.commands.Category;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

34 import org.eclipse.core.commands.NamedHandleObjectWithState;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

35 import org.eclipse.core.commands.ExecutionEvent;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

36 import org.eclipse.core.commands.ParameterType;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

37 import org.eclipse.core.commands.IExecutionListener;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

38 import org.eclipse.core.commands.ICommandListener;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

39 import org.eclipse.core.commands.IHandler;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

40 import org.eclipse.core.commands.IHandler2;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

41 import org.eclipse.core.commands.IObjectWithState;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

42 import org.eclipse.core.commands.IExecutionListenerWithChecks;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

43 import org.eclipse.core.commands.ITypedParameter;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

44 import org.eclipse.core.commands.HandlerEvent;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

45

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

46 import java.lang.all;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

47 import tango.io.Stdout;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

48

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

49 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

50 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

51 * A command is an abstract representation for some semantic behaviour. It is

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

52 * not the actual implementation of this behaviour, nor is it the visual

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

53 * appearance of this behaviour in the user interface. Instead, it is a bridge

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

54 * between the two.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

55 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

56 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

57 * The concept of a command is based on the command design pattern. The notable

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

58 * difference is how the command delegates responsibility for execution. Rather

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

59 * than allowing concrete subclasses, it uses a handler mechanism (see the

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

60 * <code>handlers</code> extension point). This provides another level of

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

61 * indirection.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

62 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

63 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

64 * A command will exist in two states: defined and undefined. A command is

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

65 * defined if it is declared in the XML of a resolved plug-in. If the plug-in is

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

66 * unloaded or the command is simply not declared, then it is undefined. Trying

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

67 * to reference an undefined command will succeed, but trying to access any of

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

68 * its functionality will fail with a <code>NotDefinedException</code>. If

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

69 * you need to know when a command changes from defined to undefined (or vice

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

70 * versa), then attach a command listener.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

71 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

72 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

73 * Commands are mutable and will change as their definition changes.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

74 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

75 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

76 * @since 3.1

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

77 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

78 public final class Command : NamedHandleObjectWithState,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

79 Comparable {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

80

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

81 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

82 * This flag can be set to <code>true</code> if commands should print

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

83 * information to <code>System.out</code> when executing.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

84 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

85 public static bool DEBUG_COMMAND_EXECUTION = false;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

86

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

87 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

88 * This flag can be set to <code>true</code> if commands should print

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

89 * information to <code>System.out</code> when changing handlers.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

90 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

91 public static bool DEBUG_HANDLERS = false;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

92

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

93 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

94 * This flag can be set to a particular command identifier if only that

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

95 * command should print information to <code>System.out</code> when

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

96 * changing handlers.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

97 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

98 public static String DEBUG_HANDLERS_COMMAND_ID = null;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

99

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

100 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

101 * The category to which this command belongs. This value should not be

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

102 * <code>null</code> unless the command is undefined.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

103 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

104 private Category category = null;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

105

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

106 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

107 * A collection of objects listening to the execution of this command. This

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

108 * collection is <code>null</code> if there are no listeners.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

109 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

110 private /+transient+/ ListenerList executionListeners = null;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

111

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

112 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

113 * The handler currently associated with this command. This value may be

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

114 * <code>null</code> if there is no handler currently.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

115 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

116 private /+transient+/ IHandler handler = null;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

117

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

118 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

119 * The help context identifier for this command. This can be

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

120 * <code>null</code> if there is no help currently associated with the

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

121 * command.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

122 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

123 * @since 3.2

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

124 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

125 private String helpContextId;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

126

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

127 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

128 * The ordered array of parameters understood by this command. This value

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

129 * may be <code>null</code> if there are no parameters, or if the command

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

130 * is undefined. It may also be empty.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

131 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

132 private IParameter[] parameters = null;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

133

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

134 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

135 * The type of the return value of this command. This value may be

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

136 * <code>null</code> if the command does not declare a return type.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

137 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

138 * @since 3.2

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

139 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

140 private ParameterType returnType = null;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

141

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

142 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

143 * Our command will listen to the active handler for enablement changes so

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

144 * that they can be fired from the command itself.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

145 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

146 * @since 3.3

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

147 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

148 private IHandlerListener handlerListener;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

149

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

150 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

151 * Constructs a new instance of <code>Command</code> based on the given

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

152 * identifier. When a command is first constructed, it is undefined.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

153 * Commands should only be constructed by the <code>CommandManager</code>

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

154 * to ensure that the identifier remains unique.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

155 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

156 * @param id

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

157 * The identifier for the command. This value must not be

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

158 * <code>null</code>, and must be unique amongst all commands.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

159 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

160 this(String id) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

161 super(id);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

162 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

163

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

164 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

165 * Adds a listener to this command that will be notified when this command's

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

166 * state changes.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

167 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

168 * @param commandListener

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

169 * The listener to be added; must not be <code>null</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

170 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

171 public final void addCommandListener(ICommandListener commandListener) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

172 if (commandListener is null) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

173 throw new NullPointerException("Cannot add a null command listener"); //$NON-NLS-1$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

174 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

175 addListenerObject(cast(Object)commandListener);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

176 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

177

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

178 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

179 * Adds a listener to this command that will be notified when this command

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

180 * is about to execute.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

181 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

182 * @param executionListener

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

183 * The listener to be added; must not be <code>null</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

184 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

185 public final void addExecutionListener(

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

186 IExecutionListener executionListener) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

187 if (executionListener is null) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

188 throw new NullPointerException(

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

189 "Cannot add a null execution listener"); //$NON-NLS-1$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

190 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

191

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

192 if (executionListeners is null) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

193 executionListeners = new ListenerList(ListenerList.IDENTITY);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

194 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

195

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

196 executionListeners.add(cast(Object)executionListener);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

197 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

198

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

199 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

200 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

201 * Adds a state to this command. This will add this state to the active

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

202 * handler, if the active handler is an instance of {@link IObjectWithState}.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

203 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

204 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

205 * A single instance of {@link State} cannot be registered with multiple

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

206 * commands. Each command requires its own unique instance.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

207 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

208 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

209 * @param id

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

210 * The identifier of the state to add; must not be

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

211 * <code>null</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

212 * @param state

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

213 * The state to add; must not be <code>null</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

214 * @since 3.2

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

215 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

216 public override void addState(String id, State state) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

217 super.addState(id, state);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

218 state.setId(id);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

219 if ( auto h = cast(IObjectWithState)handler) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

220 h.addState(id, state);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

221 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

222 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

223

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

224 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

225 * Compares this command with another command by comparing each of its

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

226 * non-transient attributes.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

227 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

228 * @param object

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

229 * The object with which to compare; must be an instance of

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

230 * <code>Command</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

231 * @return A negative integer, zero or a postivie integer, if the object is

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

232 * greater than, equal to or less than this command.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

233 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

234 public final int compareTo(Object object) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

235 Command castedObject = cast(Command) object;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

236 int compareTo = Util.compare(category, castedObject.category);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

237 if (compareTo is 0) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

238 compareTo = Util.compare(defined, castedObject.defined);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

239 if (compareTo is 0) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

240 compareTo = Util.compare(description, castedObject.description);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

241 if (compareTo is 0) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

242 compareTo = Util.compare(cast(Object)handler, cast(Object)castedObject.handler);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

243 if (compareTo is 0) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

244 compareTo = Util.compare(id, castedObject.id);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

245 if (compareTo is 0) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

246 compareTo = Util.compare(name, castedObject.name);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

247 if (compareTo is 0) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

248 Object[] left, right;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

249 foreach( p; parameters ){

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

250 left ~= cast(Object)p;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

251 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

252 foreach( p; castedObject.parameters ){

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

253 right ~= cast(Object)p;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

254 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

255 compareTo = Util.compare(left,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

256 right);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

257 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

258 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

259 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

260 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

261 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

262 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

263 return compareTo;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

264 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

265

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

266 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

267 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

268 * Defines this command by giving it a name, and possibly a description as

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

269 * well. The defined property automatically becomes <code>true</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

270 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

271 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

272 * Notification is sent to all listeners that something has changed.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

273 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

274 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

275 * @param name

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

276 * The name of this command; must not be <code>null</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

277 * @param description

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

278 * The description for this command; may be <code>null</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

279 * @param category

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

280 * The category for this command; must not be <code>null</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

281 * @since 3.2

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

282 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

283 public final void define(String name, String description,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

284 Category category) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

285 define(name, description, category, null);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

286 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

287

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

288 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

289 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

290 * Defines this command by giving it a name, and possibly a description as

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

291 * well. The defined property automatically becomes <code>true</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

292 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

293 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

294 * Notification is sent to all listeners that something has changed.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

295 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

296 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

297 * @param name

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

298 * The name of this command; must not be <code>null</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

299 * @param description

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

300 * The description for this command; may be <code>null</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

301 * @param category

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

302 * The category for this command; must not be <code>null</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

303 * @param parameters

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

304 * The parameters understood by this command. This value may be

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

305 * either <code>null</code> or empty if the command does not

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

306 * accept parameters.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

307 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

308 public final void define(String name, String description,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

309 Category category, IParameter[] parameters) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

310 define(name, description, category, parameters, null);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

311 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

312

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

313 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

314 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

315 * Defines this command by giving it a name, and possibly a description as

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

316 * well. The defined property automatically becomes <code>true</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

317 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

318 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

319 * Notification is sent to all listeners that something has changed.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

320 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

321 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

322 * @param name

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

323 * The name of this command; must not be <code>null</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

324 * @param description

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

325 * The description for this command; may be <code>null</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

326 * @param category

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

327 * The category for this command; must not be <code>null</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

328 * @param parameters

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

329 * The parameters understood by this command. This value may be

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

330 * either <code>null</code> or empty if the command does not

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

331 * accept parameters.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

332 * @param returnType

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

333 * The type of value returned by this command. This value may be

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

334 * <code>null</code> if the command does not declare a return

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

335 * type.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

336 * @since 3.2

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

337 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

338 public final void define(String name, String description,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

339 Category category, IParameter[] parameters,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

340 ParameterType returnType) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

341 define(name, description, category, parameters, returnType, null);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

342 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

343

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

344 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

345 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

346 * Defines this command by giving it a name, and possibly a description as

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

347 * well. The defined property automatically becomes <code>true</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

348 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

349 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

350 * Notification is sent to all listeners that something has changed.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

351 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

352 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

353 * @param name

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

354 * The name of this command; must not be <code>null</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

355 * @param description

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

356 * The description for this command; may be <code>null</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

357 * @param category

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

358 * The category for this command; must not be <code>null</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

359 * @param parameters

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

360 * The parameters understood by this command. This value may be

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

361 * either <code>null</code> or empty if the command does not

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

362 * accept parameters.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

363 * @param returnType

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

364 * The type of value returned by this command. This value may be

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

365 * <code>null</code> if the command does not declare a return

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

366 * type.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

367 * @param helpContextId

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

368 * The identifier of the help context to associate with this

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

369 * command; may be <code>null</code> if this command does not

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

370 * have any help associated with it.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

371 * @since 3.2

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

372 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

373 public final void define(String name, String description,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

374 Category category, IParameter[] parameters,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

375 ParameterType returnType, String helpContextId) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

376 if (name is null) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

377 throw new NullPointerException(

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

378 "The name of a command cannot be null"); //$NON-NLS-1$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

379 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

380

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

381 if (category is null) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

382 throw new NullPointerException(

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

383 "The category of a command cannot be null"); //$NON-NLS-1$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

384 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

385

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

386 bool definedChanged = !this.defined;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

387 this.defined = true;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

388

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

389 bool nameChanged = !Util.equals(this.name, name);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

390 this.name = name;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

391

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

392 bool descriptionChanged = !Util.equals(this.description,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

393 description);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

394 this.description = description;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

395

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

396 bool categoryChanged = !Util.equals(this.category, category);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

397 this.category = category;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

398

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

399 Object[] pLeft, pRight;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

400 foreach( p; this.parameters ){

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

401 pLeft ~= cast(Object)p;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

402 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

403 foreach( p; parameters ){

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

404 pRight ~= cast(Object)p;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

405 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

406 bool parametersChanged = !Util.equals(pLeft,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

407 pRight);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

408 this.parameters = parameters;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

409

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

410 bool returnTypeChanged = !Util.equals(this.returnType,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

411 returnType);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

412 this.returnType = returnType;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

413

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

414 bool helpContextIdChanged = !Util.equals(this.helpContextId,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

415 helpContextId);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

416 this.helpContextId = helpContextId;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

417

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

418 fireCommandChanged(new CommandEvent(this, categoryChanged,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

419 definedChanged, descriptionChanged, false, nameChanged,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

420 parametersChanged, returnTypeChanged, helpContextIdChanged));

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

421 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

422

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

423 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

424 * Executes this command by delegating to the current handler, if any. If

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

425 * the debugging flag is set, then this method prints information about

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

426 * which handler is selected for performing this command. This method will

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

427 * succeed regardless of whether the command is enabled or defined. It is

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

428 * generally preferred to call {@link #executeWithChecks(ExecutionEvent)}.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

429 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

430 * @param event

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

431 * An event containing all the information about the current

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

432 * state of the application; must not be <code>null</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

433 * @return The result of the execution; may be <code>null</code>. This

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

434 * result will be available to the client executing the command, and

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

435 * execution listeners.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

436 * @throws ExecutionException

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

437 * If the handler has problems executing this command.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

438 * @throws NotHandledException

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

439 * If there is no handler.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

440 * @deprecated Please use {@link #executeWithChecks(ExecutionEvent)}

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

441 * instead.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

442 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

443 public final Object execute(ExecutionEvent event) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

444 firePreExecute(event);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

445 IHandler handler = this.handler;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

446

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

447 // Perform the execution, if there is a handler.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

448 if ((handler !is null) && (handler.isHandled())) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

449 try {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

450 Object returnValue = handler.execute(event);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

451 firePostExecuteSuccess(returnValue);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

452 return returnValue;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

453 } catch (ExecutionException e) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

454 firePostExecuteFailure(e);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

455 throw e;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

456 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

457 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

458

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

459 NotHandledException e = new NotHandledException(

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

460 "There is no handler to execute. " ~ getId()); //$NON-NLS-1$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

461 fireNotHandled(e);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

462 throw e;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

463 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

464

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

465 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

466 * Executes this command by delegating to the current handler, if any. If

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

467 * the debugging flag is set, then this method prints information about

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

468 * which handler is selected for performing this command. This does checks

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

469 * to see if the command is enabled and defined. If it is not both enabled

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

470 * and defined, then the execution listeners will be notified and an

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

471 * exception thrown.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

472 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

473 * @param event

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

474 * An event containing all the information about the current

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

475 * state of the application; must not be <code>null</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

476 * @return The result of the execution; may be <code>null</code>. This

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

477 * result will be available to the client executing the command, and

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

478 * execution listeners.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

479 * @throws ExecutionException

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

480 * If the handler has problems executing this command.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

481 * @throws NotDefinedException

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

482 * If the command you are trying to execute is not defined.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

483 * @throws NotEnabledException

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

484 * If the command you are trying to execute is not enabled.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

485 * @throws NotHandledException

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

486 * If there is no handler.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

487 * @since 3.2

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

488 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

489 public final Object executeWithChecks(ExecutionEvent event) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

490 firePreExecute(event);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

491 IHandler handler = this.handler;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

492

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

493 if (!isDefined()) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

494 NotDefinedException exception = new NotDefinedException(

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

495 "Trying to execute a command that is not defined. " //$NON-NLS-1$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

496 ~ getId());

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

497 fireNotDefined(exception);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

498 throw exception;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

499 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

500

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

501 // Perform the execution, if there is a handler.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

502 if ((handler !is null) && (handler.isHandled())) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

503 setEnabled(event.getApplicationContext());

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

504 if (!isEnabled()) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

505 NotEnabledException exception = new NotEnabledException(

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

506 "Trying to execute the disabled command " ~ getId()); //$NON-NLS-1$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

507 fireNotEnabled(exception);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

508 throw exception;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

509 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

510

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

511 try {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

512 Object returnValue = handler.execute(event);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

513 firePostExecuteSuccess(returnValue);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

514 return returnValue;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

515 } catch (ExecutionException e) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

516 firePostExecuteFailure(e);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

517 throw e;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

518 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

519 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

520

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

521 NotHandledException e = new NotHandledException(

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

522 "There is no handler to execute for command " ~ getId()); //$NON-NLS-1$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

523 fireNotHandled(e);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

524 throw e;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

525 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

526

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

527 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

528 * Notifies the listeners for this command that it has changed in some way.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

529 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

530 * @param commandEvent

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

531 * The event to send to all of the listener; must not be

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

532 * <code>null</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

533 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

534 private final void fireCommandChanged(CommandEvent commandEvent) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

535 if (commandEvent is null) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

536 throw new NullPointerException("Cannot fire a null event"); //$NON-NLS-1$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

537 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

538

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

539 Object[] listeners = getListeners();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

540 for (int i = 0; i < listeners.length; i++) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

541 ICommandListener listener = cast(ICommandListener) listeners[i];

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

542 SafeRunner.run(new class(listener) ISafeRunnable {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

543 ICommandListener listener_;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

544 this(ICommandListener a){ this.listener_ = a; }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

545 public void handleException(Exception exception) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

546 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

547

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

548 public void run() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

549 listener_.commandChanged(commandEvent);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

550 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

551 });

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

552 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

553 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

554

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

555 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

556 * Notifies the execution listeners for this command that an attempt to

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

557 * execute has failed because the command is not defined.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

558 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

559 * @param e

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

560 * The exception that is about to be thrown; never

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

561 * <code>null</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

562 * @since 3.2

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

563 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

564 private final void fireNotDefined(NotDefinedException e) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

565 // Debugging output

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

566 if (DEBUG_COMMAND_EXECUTION) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

567 Tracing.printTrace("COMMANDS", "execute" ~ Tracing.SEPARATOR //$NON-NLS-1$ //$NON-NLS-2$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

568 ~ "not defined: id=" ~ getId() ~ "; exception=" ~ e.toString ); //$NON-NLS-1$ //$NON-NLS-2$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

569 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

570

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

571 if (executionListeners !is null) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

572 Object[] listeners = executionListeners.getListeners();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

573 for (int i = 0; i < listeners.length; i++) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

574 Object object = listeners[i];

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

575 if ( auto listener = cast(IExecutionListenerWithChecks)object ) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

576 listener.notDefined(getId(), e);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

577 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

578 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

579 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

580 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

581

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

582 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

583 * Notifies the execution listeners for this command that an attempt to

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

584 * execute has failed because there is no handler.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

585 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

586 * @param e

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

587 * The exception that is about to be thrown; never

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

588 * <code>null</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

589 * @since 3.2

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

590 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

591 private final void fireNotEnabled(NotEnabledException e) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

592 // Debugging output

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

593 if (DEBUG_COMMAND_EXECUTION) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

594 Tracing.printTrace("COMMANDS", "execute" ~ Tracing.SEPARATOR //$NON-NLS-1$ //$NON-NLS-2$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

595 ~ "not enabled: id=" ~ getId() ~ "; exception=" ~ e.toString ); //$NON-NLS-1$ //$NON-NLS-2$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

596 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

597

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

598 if (executionListeners !is null) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

599 Object[] listeners = executionListeners.getListeners();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

600 for (int i = 0; i < listeners.length; i++) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

601 Object object = listeners[i];

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

602 if ( auto listener = cast(IExecutionListenerWithChecks)object ) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

603 listener.notEnabled(getId(), e);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

604 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

605 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

606 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

607 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

608

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

609 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

610 * Notifies the execution listeners for this command that an attempt to

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

611 * execute has failed because there is no handler.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

612 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

613 * @param e

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

614 * The exception that is about to be thrown; never

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

615 * <code>null</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

616 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

617 private final void fireNotHandled(NotHandledException e) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

618 // Debugging output

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

619 if (DEBUG_COMMAND_EXECUTION) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

620 Tracing.printTrace("COMMANDS", "execute" ~ Tracing.SEPARATOR //$NON-NLS-1$ //$NON-NLS-2$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

621 ~ "not handled: id=" ~ getId() ~ "; exception=" ~ e.toString ); //$NON-NLS-1$ //$NON-NLS-2$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

622 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

623

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

624 if (executionListeners !is null) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

625 Object[] listeners = executionListeners.getListeners();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

626 for (int i = 0; i < listeners.length; i++) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

627 IExecutionListener listener = cast(IExecutionListener) listeners[i];

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

628 listener.notHandled(getId(), e);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

629 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

630 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

631 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

632

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

633 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

634 * Notifies the execution listeners for this command that an attempt to

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

635 * execute has failed during the execution.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

636 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

637 * @param e

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

638 * The exception that has been thrown; never <code>null</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

639 * After this method completes, the exception will be thrown

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

640 * again.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

641 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

642 private final void firePostExecuteFailure(ExecutionException e) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

643 // Debugging output

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

644 if (DEBUG_COMMAND_EXECUTION) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

645 Tracing.printTrace("COMMANDS", "execute" ~ Tracing.SEPARATOR //$NON-NLS-1$ //$NON-NLS-2$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

646 ~ "failure: id=" ~ getId() ~ "; exception=" ~ e.toString ); //$NON-NLS-1$ //$NON-NLS-2$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

647 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

648

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

649 if (executionListeners !is null) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

650 Object[] listeners = executionListeners.getListeners();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

651 for (int i = 0; i < listeners.length; i++) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

652 IExecutionListener listener = cast(IExecutionListener) listeners[i];

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

653 listener.postExecuteFailure(getId(), e);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

654 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

655 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

656 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

657

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

658 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

659 * Notifies the execution listeners for this command that an execution has

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

660 * completed successfully.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

661 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

662 * @param returnValue

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

663 * The return value from the command; may be <code>null</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

664 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

665 private final void firePostExecuteSuccess(Object returnValue) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

666 // Debugging output

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

667 if (DEBUG_COMMAND_EXECUTION) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

668 Tracing.printTrace("COMMANDS", "execute" ~ Tracing.SEPARATOR //$NON-NLS-1$ //$NON-NLS-2$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

669 ~ "success: id=" ~ getId() ~ "; returnValue=" //$NON-NLS-1$ //$NON-NLS-2$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

670 ~ returnValue.toString );

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

671 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

672

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

673 if (executionListeners !is null) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

674 Object[] listeners = executionListeners.getListeners();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

675 for (int i = 0; i < listeners.length; i++) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

676 IExecutionListener listener = cast(IExecutionListener) listeners[i];

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

677 listener.postExecuteSuccess(getId(), returnValue);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

678 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

679 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

680 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

681

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

682 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

683 * Notifies the execution listeners for this command that an attempt to

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

684 * execute is about to start.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

685 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

686 * @param event

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

687 * The execution event that will be used; never <code>null</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

688 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

689 private final void firePreExecute(ExecutionEvent event) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

690 // Debugging output

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

691 if (DEBUG_COMMAND_EXECUTION) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

692 Tracing.printTrace("COMMANDS", "execute" ~ Tracing.SEPARATOR //$NON-NLS-1$ //$NON-NLS-2$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

693 ~ "starting: id=" ~ getId() ~ "; event=" ~ event.toString ); //$NON-NLS-1$ //$NON-NLS-2$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

694 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

695

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

696 if (executionListeners !is null) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

697 Object[] listeners = executionListeners.getListeners();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

698 for (int i = 0; i < listeners.length; i++) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

699 IExecutionListener listener = cast(IExecutionListener) listeners[i];

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

700 listener.preExecute(getId(), event);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

701 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

702 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

703 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

704

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

705 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

706 * Returns the category for this command.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

707 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

708 * @return The category for this command; never <code>null</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

709 * @throws NotDefinedException

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

710 * If the handle is not currently defined.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

711 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

712 public final Category getCategory() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

713 if (!isDefined()) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

714 throw new NotDefinedException(

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

715 "Cannot get the category from an undefined command. " //$NON-NLS-1$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

716 ~ id);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

717 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

718

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

719 return category;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

720 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

721

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

722 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

723 * Returns the current handler for this command. This is used by the command

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

724 * manager for determining the appropriate help context identifiers and by

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

725 * the command service to allow handlers to update elements.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

726 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

727 * This value can change at any time and should never be cached.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

728 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

729 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

730 * @return The current handler for this command; may be <code>null</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

731 * @since 3.3

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

732 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

733 public final IHandler getHandler() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

734 return handler;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

735 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

736

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

737 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

738 * Returns the help context identifier associated with this command. This

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

739 * method should not be called by clients. Clients should use

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

740 * {@link CommandManager#getHelpContextId(Command)} instead.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

741 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

742 * @return The help context identifier for this command; may be

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

743 * <code>null</code> if there is none.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

744 * @since 3.2

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

745 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

746 final String getHelpContextId() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

747 return helpContextId;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

748 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

749

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

750 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

751 * Returns the parameter with the provided id or <code>null</code> if this

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

752 * command does not have a parameter with the id.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

753 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

754 * @param parameterId

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

755 * The id of the parameter to retrieve.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

756 * @return The parameter with the provided id or <code>null</code> if this

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

757 * command does not have a parameter with the id.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

758 * @throws NotDefinedException

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

759 * If the handle is not currently defined.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

760 * @since 3.2

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

761 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

762 public final IParameter getParameter(String parameterId) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

763 if (!isDefined()) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

764 throw new NotDefinedException(

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

765 "Cannot get a parameter from an undefined command. " //$NON-NLS-1$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

766 ~ id);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

767 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

768

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

769 if (parameters is null) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

770 return null;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

771 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

772

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

773 for (int i = 0; i < parameters.length; i++) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

774 IParameter parameter = parameters[i];

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

775 if (parameter.getId().equals(parameterId)) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

776 return parameter;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

777 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

778 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

779

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

780 return null;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

781 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

782

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

783 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

784 * Returns the parameters for this command. This call triggers provides a

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

785 * copy of the array, so excessive calls to this method should be avoided.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

786 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

787 * @return The parameters for this command. This value might be

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

788 * <code>null</code>, if the command has no parameters.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

789 * @throws NotDefinedException

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

790 * If the handle is not currently defined.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

791 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

792 public final IParameter[] getParameters() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

793 if (!isDefined()) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

794 throw new NotDefinedException(

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

795 "Cannot get the parameters from an undefined command. " //$NON-NLS-1$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

796 ~ id);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

797 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

798

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

799 if ((parameters is null) || (parameters.length is 0)) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

800 return null;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

801 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

802

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

803 IParameter[] returnValue = new IParameter[parameters.length];

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

804 SimpleType!(IParameter).arraycopy(parameters, 0, returnValue, 0, parameters.length);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

805 return returnValue;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

806 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

807

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

808 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

809 * Returns the {@link ParameterType} for the parameter with the provided id

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

810 * or <code>null</code> if this command does not have a parameter type

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

811 * with the id.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

812 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

813 * @param parameterId

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

814 * The id of the parameter to retrieve the {@link ParameterType}

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

815 * of.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

816 * @return The {@link ParameterType} for the parameter with the provided id

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

817 * or <code>null</code> if this command does not have a parameter

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

818 * type with the provided id.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

819 * @throws NotDefinedException

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

820 * If the handle is not currently defined.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

821 * @since 3.2

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

822 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

823 public final ParameterType getParameterType(String parameterId) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

824 IParameter parameter = getParameter(parameterId);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

825 if ( auto parameterWithType = cast(ITypedParameter)parameter ) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

826 return parameterWithType.getParameterType();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

827 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

828 return null;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

829 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

830

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

831 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

832 * Returns the {@link ParameterType} for the return value of this command or

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

833 * <code>null</code> if this command does not declare a return value

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

834 * parameter type.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

835 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

836 * @return The {@link ParameterType} for the return value of this command or

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

837 * <code>null</code> if this command does not declare a return

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

838 * value parameter type.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

839 * @throws NotDefinedException

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

840 * If the handle is not currently defined.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

841 * @since 3.2

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

842 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

843 public final ParameterType getReturnType() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

844 if (!isDefined()) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

845 throw new NotDefinedException(

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

846 "Cannot get the return type of an undefined command. " //$NON-NLS-1$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

847 ~ id);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

848 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

849

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

850 return returnType;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

851 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

852

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

853 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

854 * Returns whether this command has a handler, and whether this handler is

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

855 * also handled and enabled.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

856 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

857 * @return <code>true</code> if the command is handled; <code>false</code>

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

858 * otherwise.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

859 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

860 public final bool isEnabled() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

861 if (handler is null) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

862 return false;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

863 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

864

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

865 try {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

866 return handler.isEnabled();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

867 } catch (Exception e) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

868 if (DEBUG_HANDLERS) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

869 // since this has the ability to generate megs of logs, only

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

870 // provide information if tracing

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

871 Tracing.printTrace("HANDLERS", "Handler " ~ (cast(Object)handler).toString() ~ " for " //$NON-NLS-1$//$NON-NLS-2$ //$NON-NLS-3$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

872 ~ id ~ " threw unexpected exception"); //$NON-NLS-1$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

873 ExceptionPrintStackTrace( e, Stdout );

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

874 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

875 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

876 return false;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

877 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

878

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

879 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

880 * Called be the framework to allow the handler to update its enabled state.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

881 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

882 * @param evaluationContext

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

883 * the state to evaluate against. May be <code>null</code>

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

884 * which indicates that the handler can query whatever model that

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

885 * is necessary. This context must not be cached.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

886 * @since 3.4

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

887 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

888 public void setEnabled(Object evaluationContext) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

889 if (null !is cast(IHandler2)handler ) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

890 (cast(IHandler2) handler).setEnabled(evaluationContext);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

891 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

892 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

893

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

894 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

895 * Returns whether this command has a handler, and whether this handler is

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

896 * also handled.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

897 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

898 * @return <code>true</code> if the command is handled; <code>false</code>

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

899 * otherwise.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

900 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

901 public final bool isHandled() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

902 if (handler is null) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

903 return false;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

904 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

905

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

906 return handler.isHandled();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

907 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

908

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

909 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

910 * Removes a listener from this command.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

911 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

912 * @param commandListener

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

913 * The listener to be removed; must not be <code>null</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

914 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

915 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

916 public final void removeCommandListener(

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

917 ICommandListener commandListener) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

918 if (commandListener is null) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

919 throw new NullPointerException(

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

920 "Cannot remove a null command listener"); //$NON-NLS-1$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

921 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

922

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

923 removeListenerObject(cast(Object)commandListener);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

924 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

925

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

926 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

927 * Removes a listener from this command.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

928 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

929 * @param executionListener

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

930 * The listener to be removed; must not be <code>null</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

931 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

932 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

933 public final void removeExecutionListener(

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

934 IExecutionListener executionListener) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

935 if (executionListener is null) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

936 throw new NullPointerException(

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

937 "Cannot remove a null execution listener"); //$NON-NLS-1$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

938 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

939

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

940 if (executionListeners !is null) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

941 executionListeners.remove(cast(Object)executionListener);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

942 if (executionListeners.isEmpty()) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

943 executionListeners = null;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

944 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

945 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

946 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

947

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

948 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

949 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

950 * Removes a state from this command. This will remove the state from the

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

951 * active handler, if the active handler is an instance of

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

952 * {@link IObjectWithState}.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

953 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

954 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

955 * @param stateId

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

956 * The identifier of the state to remove; must not be

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

957 * <code>null</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

958 * @since 3.2

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

959 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

960 public override void removeState(String stateId) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

961 if ( auto h = cast(IObjectWithState)handler ) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

962 h.removeState(stateId);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

963 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

964 super.removeState(stateId);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

965 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

966

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

967 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

968 * Changes the handler for this command. This will remove all the state from

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

969 * the currently active handler (if any), and add it to <code>handler</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

970 * If debugging is turned on, then this will also print information about

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

971 * the change to <code>System.out</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

972 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

973 * @param handler

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

974 * The new handler; may be <code>null</code> if none.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

975 * @return <code>true</code> if the handler changed; <code>false</code>

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

976 * otherwise.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

977 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

978 public final bool setHandler(IHandler handler) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

979 if (Util.equals(cast(Object)handler, cast(Object)this.handler)) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

980 return false;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

981 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

982

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

983 // Swap the state around.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

984 String[] stateIds = getStateIds();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

985 if (stateIds !is null) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

986 for (int i = 0; i < stateIds.length; i++) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

987 String stateId = stateIds[i];

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

988 if ( auto h = cast(IObjectWithState)this.handler ) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

989 h.removeState(stateId);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

990 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

991 if ( auto h = cast(IObjectWithState)handler ) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

992 State stateToAdd = getState(stateId);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

993 h.addState(stateId, stateToAdd);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

994 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

995 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

996 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

997

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

998 bool enabled = isEnabled();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

999 if (this.handler !is null) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1000 this.handler.removeHandlerListener(getHandlerListener());

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1001 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1002

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1003 // Update the handler, and flush the string representation.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1004 this.handler = handler;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1005 if (this.handler !is null) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1006 this.handler.addHandlerListener(getHandlerListener());

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1007 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1008 string = null;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1009

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1010 // Debugging output

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1011 if ((DEBUG_HANDLERS)

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1012 && ((DEBUG_HANDLERS_COMMAND_ID is null) || (DEBUG_HANDLERS_COMMAND_ID

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1013 .equals(id)))) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1014 StringBuffer buffer = new StringBuffer("Command('"); //$NON-NLS-1$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1015 buffer.append(id);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1016 buffer.append("') has changed to "); //$NON-NLS-1$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1017 if (handler is null) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1018 buffer.append("no handler"); //$NON-NLS-1$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1019 } else {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1020 buffer.append('\'');

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1021 buffer.append(( cast(Object)handler).toString);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1022 buffer.append("' as its handler"); //$NON-NLS-1$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1023 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1024 Tracing.printTrace("HANDLERS", buffer.toString()); //$NON-NLS-1$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1025 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1026

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1027 // Send notification

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1028 fireCommandChanged(new CommandEvent(this, false, false, false, true,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1029 false, false, false, false, enabled !is isEnabled()));

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1030

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1031 return true;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1032 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1033

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1034 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1035 * @return the handler listener

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1036 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1037 private IHandlerListener getHandlerListener() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1038 if (handlerListener is null) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1039 handlerListener = new class IHandlerListener {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1040 public void handlerChanged(HandlerEvent handlerEvent) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1041 bool enabledChanged = handlerEvent.isEnabledChanged();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1042 bool handledChanged = handlerEvent.isHandledChanged();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1043 fireCommandChanged(new CommandEvent(this.outer, false,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1044 false, false, handledChanged, false, false, false,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1045 false, enabledChanged));

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1046 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1047 };

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1048 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1049 return handlerListener;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1050 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1051

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1052 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1053 * The string representation of this command -- for debugging purposes only.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1054 * This string should not be shown to an end user.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1055 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1056 * @return The string representation; never <code>null</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1057 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1058 public override final String toString() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1059 if (string is null) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1060 String parms;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1061 foreach( p; parameters ){

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1062 parms ~= "{"~(cast(Object)p).toString~"}";

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1063 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1064 string = Format("Command({},{},\n\t\t{},\n\t\t{},\n\t\t{},\n\t\t{},{},{})",

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1065 id,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1066 name is null ? "":name,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1067 description is null?"":description,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1068 category is null?"":category.toString(),

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1069 handler is null?"": (cast(Object)handler).toString(),

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1070 parms,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1071 returnType is null?"":returnType.toString(),

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1072 defined

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1073 );

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1074 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1075 return string;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1076 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1077

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1078 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1079 * Makes this command become undefined. This has the side effect of changing

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1080 * the name and description to <code>null</code>. This also removes all

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1081 * state and disposes of it. Notification is sent to all listeners.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1082 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1083 public override final void undefine() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1084 bool enabledChanged = isEnabled();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1085

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1086 string = null;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1087

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1088 bool definedChanged = defined;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1089 defined = false;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1090

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1091 bool nameChanged = name !is null;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1092 name = null;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1093

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1094 bool descriptionChanged = description !is null;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1095 description = null;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1096

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1097 bool categoryChanged = category !is null;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1098 category = null;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1099

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1100 bool parametersChanged = parameters !is null;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1101 parameters = null;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1102

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1103 bool returnTypeChanged = returnType !is null;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1104 returnType = null;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1105

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1106 String[] stateIds = getStateIds();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1107 if (stateIds !is null) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1108 if ( auto handlerWithState = cast(IObjectWithState)handler ) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1109 for (int i = 0; i < stateIds.length; i++) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1110 String stateId = stateIds[i];

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1111 handlerWithState.removeState(stateId);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1112

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1113 State state = getState(stateId);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1114 removeState(stateId);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1115 state.dispose();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1116 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1117 } else {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1118 for (int i = 0; i < stateIds.length; i++) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1119 String stateId = stateIds[i];

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1120 State state = getState(stateId);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1121 removeState(stateId);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1122 state.dispose();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1123 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1124 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1125 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1126

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1127 fireCommandChanged(new CommandEvent(this, categoryChanged,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1128 definedChanged, descriptionChanged, false, nameChanged,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1129 parametersChanged, returnTypeChanged, false, enabledChanged));

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1130 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1131 }

Mercurial > projects > dwt2

annotate org.eclipse.core.commands/src/org/eclipse/core/commands/Command.d @ 12:bc29606a740c