001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041: /*
042: * TabActionEvent.java
043: *
044: * Created on March 17, 2004, 3:48 PM
045: */
046:
047: package org.netbeans.swing.tabcontrol.event;
048:
049: import java.awt.event.ActionEvent;
050: import java.awt.event.MouseEvent;
051:
052: /**
053: * An action event which may be consumed by a listener. These are fired by
054: * TabControl and TabbedContainer to determine if outside code wants to handle
055: * an event, such as clicking the close button (which might be vetoed), or if
056: * the control should handle it itself.
057: *
058: * @author Tim Boudreau
059: */
060: public final class TabActionEvent extends ActionEvent {
061: private MouseEvent mouseEvent = null;
062: private int tabIndex;
063:
064: /**
065: * Creates a new instance of TabActionEvent
066: */
067: public TabActionEvent(Object source, String command, int tabIndex) {
068: super (source, ActionEvent.ACTION_PERFORMED, command);
069: this .tabIndex = tabIndex;
070: consumed = false;
071: }
072:
073: public TabActionEvent(Object source, String command, int tabIndex,
074: MouseEvent mouseEvent) {
075: this (source, command, tabIndex);
076: this .mouseEvent = mouseEvent;
077: consumed = false;
078: }
079:
080: /**
081: * Consume this event - any changes that should be performed as a result
082: * will be done by external code by manipulating the models or other means
083: */
084: public void consume() {
085: consumed = true;
086: }
087:
088: /**
089: * Determine if the event has been consumed
090: */
091: public boolean isConsumed() {
092: return super .isConsumed();
093: }
094:
095: /**
096: * If the action event was triggered by a mouse event, get the mouse event
097: * in question
098: *
099: * @return The mouse event, or null
100: */
101: public MouseEvent getMouseEvent() {
102: return mouseEvent;
103: }
104:
105: public int getTabIndex() {
106: return tabIndex;
107: }
108:
109: public void setSource(Object source) {
110: //Skip some native peer silliness in AWTEvent
111: this .source = source;
112: }
113:
114: public String toString() {
115: StringBuffer sb = new StringBuffer("TabActionEvent:"); //NOI18N
116: sb.append("Tab " + tabIndex + " " + getActionCommand()); //NOI18N
117: return sb.toString();
118: }
119:
120: }
|