001: /*BEGIN_COPYRIGHT_BLOCK
002: *
003: * Copyright (c) 2001-2007, JavaPLT group at Rice University (javaplt@rice.edu)
004: * All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions are met:
008: * * Redistributions of source code must retain the above copyright
009: * notice, this list of conditions and the following disclaimer.
010: * * Redistributions in binary form must reproduce the above copyright
011: * notice, this list of conditions and the following disclaimer in the
012: * documentation and/or other materials provided with the distribution.
013: * * Neither the names of DrJava, the JavaPLT group, Rice University, nor the
014: * names of its contributors may be used to endorse or promote products
015: * derived from this software without specific prior written permission.
016: *
017: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
018: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
019: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
020: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
021: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
022: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
023: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
024: * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
025: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
026: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
027: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
028: *
029: * This software is Open Source Initiative approved Open Source Software.
030: * Open Source Initative Approved is a trademark of the Open Source Initiative.
031: *
032: * This file is part of DrJava. Download the current version of this project
033: * from http://www.drjava.org/ or http://sourceforge.net/projects/drjava/
034: *
035: * END_COPYRIGHT_BLOCK*/
036:
037: package edu.rice.cs.drjava.ui;
038:
039: import javax.swing.*;
040: import java.awt.event.*;
041: import java.awt.*;
042: import java.awt.dnd.*;
043: import java.awt.datatransfer.*;
044: import edu.rice.cs.drjava.DrJavaRoot;
045:
046: /**
047: * Extended by all panels that can dynamically be added or removed from the
048: * _tabbedPane in MainFrame. Provides a boolean indicating if the panel is being
049: * displayed, and a close button. Attaches an action to the close button which
050: * calls the _close method. This method can be overwritten in a subclass if
051: * needed.
052: * @version $Id: TabbedPanel.java 4260 2007-10-10 20:28:34Z mgricken $
053: */
054: public abstract class TabbedPanel extends JPanel implements
055: DropTargetListener {
056: // indicates whether this tab is displayed in the tabbed pane
057: protected boolean _displayed;
058: // button which removes this pane's tab
059: protected JButton _closeButton;
060: // panel that has _closeButton in the north so it can't be stretched
061: // vertically
062: protected JPanel _closePanel;
063: // the panel that the subclasses of TabbedPanel can use
064: protected JPanel _mainPanel;
065: // used to be able to reference removeTab
066: protected MainFrame _frame;
067: // string to be displayed on the tab
068: private String _name;
069:
070: /** Constructor.
071: * @param frame MainFrame displaying the tab
072: * @param name Name to display for the tab
073: */
074: public TabbedPanel(MainFrame frame, String name) {
075: _frame = frame;
076: _name = name;
077: _setUpPanes();
078: _displayed = false;
079: }
080:
081: /** Puts the close panel in the east of this panel and puts the main panel in the
082: * center. Also adds the action to the close button.
083: */
084: private void _setUpPanes() {
085: this .setFocusCycleRoot(true);
086: this .setLayout(new BorderLayout());
087:
088: _mainPanel = new JPanel();
089: _closePanel = new JPanel(new BorderLayout());
090: _closeButton = new CommonCloseButton(_closeListener);
091: _closePanel.add(_closeButton, BorderLayout.NORTH);
092: add(_closePanel, BorderLayout.EAST);
093: add(_mainPanel, BorderLayout.CENTER);
094: }
095:
096: /** Defines the action that takes place upon clicking the close button. */
097: private final ActionListener _closeListener = new ActionListener() {
098: public void actionPerformed(ActionEvent e) {
099: _close();
100: }
101: };
102:
103: /** Visibly closes the panel and removes it from the frame. */
104: protected void _close() {
105: _displayed = false;
106: _frame.removeTab(this );
107: }
108:
109: /** @return whether this tabbedPanel is displayed in a tab */
110: public boolean isDisplayed() {
111: return _displayed;
112: }
113:
114: /** @return the display name of this tab. */
115: public String getName() {
116: return _name;
117: }
118:
119: /** Sets whether the tab is displayed. Doesn't actually show or hide the tab. */
120: public void setDisplayed(boolean displayed) {
121: _displayed = displayed;
122: }
123:
124: JPanel getMainPanel() {
125: return _mainPanel;
126: }
127:
128: /** This is overridden so that when switch previous pane focus is called
129: * on the currentDefPane, the caret will move here on the first call.
130: */
131: public boolean requestFocusInWindow() {
132: // System.err.println("requestFocusInWindow called on TabbedPanel");
133: super .requestFocusInWindow();
134: return _mainPanel.requestFocusInWindow();
135: }
136:
137: /** Drag and drop target. */
138: DropTarget dropTarget = new DropTarget(this , this );
139:
140: /** User dragged something into the component. */
141: public void dragEnter(DropTargetDragEvent dropTargetDragEvent) {
142: DrJavaRoot.dragEnter(dropTargetDragEvent);
143: }
144:
145: public void dragExit(DropTargetEvent dropTargetEvent) {
146: }
147:
148: public void dragOver(DropTargetDragEvent dropTargetDragEvent) {
149: }
150:
151: public void dropActionChanged(
152: DropTargetDragEvent dropTargetDragEvent) {
153: }
154:
155: /** User dropped something on the component. */
156: public synchronized void drop(
157: DropTargetDropEvent dropTargetDropEvent) {
158: DrJavaRoot.drop(dropTargetDropEvent);
159: }
160: }
|