001: /*******************************************************************************
002: * Copyright (c) 2000, 2006 IBM Corporation and others.
003: * All rights reserved. This program and the accompanying materials
004: * are made available under the terms of the Eclipse Public License v1.0
005: * which accompanies this distribution, and is available at
006: * http://www.eclipse.org/legal/epl-v10.html
007: *
008: * Contributors:
009: * IBM Corporation - initial API and implementation
010: *******************************************************************************/package org.eclipse.ui.commands;
011:
012: /**
013: * An instance of this class describes changes to an instance of
014: * <code>IKeyConfiguration</code>.
015: * <p>
016: * This class is not intended to be extended by clients.
017: * </p>
018: *
019: * @since 3.0
020: * @see IKeyConfigurationListener#keyConfigurationChanged(KeyConfigurationEvent)
021: * @deprecated Please use the bindings support in the "org.eclipse.jface"
022: * plug-in instead.
023: * @see org.eclipse.jface.bindings.SchemeEvent
024: */
025: public final class KeyConfigurationEvent {
026:
027: /**
028: * whether the key configuration has become or active or inactive.
029: */
030: private final boolean activeChanged;
031:
032: /**
033: * Whether the key configuration has become defined or undefined.
034: */
035: private final boolean definedChanged;
036:
037: /**
038: * The key configuration that has changed; this value is never
039: * <code>null</code>.
040: */
041: private final IKeyConfiguration keyConfiguration;
042:
043: /**
044: * Whether the name of the key configuration has changed.
045: */
046: private final boolean nameChanged;
047:
048: /**
049: * Whether the parent identifier has changed.
050: */
051: private final boolean parentIdChanged;
052:
053: /**
054: * Creates a new instance of this class.
055: *
056: * @param keyConfiguration
057: * the instance of the interface that changed.
058: * @param activeChanged
059: * true, iff the active property changed.
060: * @param definedChanged
061: * true, iff the defined property changed.
062: * @param nameChanged
063: * true, iff the name property changed.
064: * @param parentIdChanged
065: * true, iff the parentId property changed.
066: */
067: public KeyConfigurationEvent(IKeyConfiguration keyConfiguration,
068: boolean activeChanged, boolean definedChanged,
069: boolean nameChanged, boolean parentIdChanged) {
070: if (keyConfiguration == null) {
071: throw new NullPointerException();
072: }
073:
074: this .keyConfiguration = keyConfiguration;
075: this .activeChanged = activeChanged;
076: this .definedChanged = definedChanged;
077: this .nameChanged = nameChanged;
078: this .parentIdChanged = parentIdChanged;
079: }
080:
081: /**
082: * Returns the instance of the interface that changed.
083: *
084: * @return the instance of the interface that changed. Guaranteed not to be
085: * <code>null</code>.
086: */
087: public IKeyConfiguration getKeyConfiguration() {
088: return keyConfiguration;
089: }
090:
091: /**
092: * Returns whether or not the active property changed.
093: *
094: * @return true, iff the active property changed.
095: */
096: public boolean hasActiveChanged() {
097: return activeChanged;
098: }
099:
100: /**
101: * Returns whether or not the defined property changed.
102: *
103: * @return true, iff the defined property changed.
104: */
105: public boolean hasDefinedChanged() {
106: return definedChanged;
107: }
108:
109: /**
110: * Returns whether or not the name property changed.
111: *
112: * @return true, iff the name property changed.
113: */
114: public boolean hasNameChanged() {
115: return nameChanged;
116: }
117:
118: /**
119: * Returns whether or not the parentId property changed.
120: *
121: * @return true, iff the parentId property changed.
122: */
123: public boolean hasParentIdChanged() {
124: return parentIdChanged;
125: }
126: }
|