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: * FxProvider.java
043: *
044: * Created on March 27, 2004, 9:04 PM
045: */
046:
047: package org.netbeans.swing.tabcontrol.plaf;
048:
049: import javax.swing.*;
050:
051: /** Class which can provide sliding or other eye-candy effects as a component
052: * is displayed. To use, subclass TabbedContainerUI and create an instance
053: * in createFxProvider. The abstract doFinish() method is expected to call
054: * TabbedContainerUI.showComponent(), so this is best implemented as an inner
055: * class of a TabbbedContainerUI implementation.
056: *
057: * @author Tim Boudreau
058: */
059: public abstract class FxProvider {
060: protected JComponent comp;
061: protected JRootPane root;
062: private boolean running = false;
063: protected Object orientation = null;
064:
065: /** Creates a new instance of FxProvider */
066: public FxProvider() {
067: }
068:
069: /** Start the effect running. This method will set up the fields with
070: * the passed values, set the running flag, and then call <code>doStart()</code>.
071: * If <code>isRunning()</code> is true, calls <code>abort()</code> before
072: * initializing.
073: */
074: public final void start(JComponent comp, JRootPane root,
075: Object orientation) {
076: if (running) {
077: if (comp == this .comp && root == this .root) {
078: return;
079: } else {
080: abort();
081: }
082: }
083: this .comp = comp;
084: this .root = root;
085: this .orientation = orientation;
086: running = true;
087: doStart();
088: }
089:
090: /**
091: * Perform any cleanup necessary and complete the effect.
092: * Sets the running flag to false, calls <code>doFinish()</code> (in which
093: * the implementation should call showComponent() on the TabbedContainerUI
094: * to actually show the component for which an effect has been being
095: * presented. <strong>After</strong> calling <code>finish()</code>, it
096: * calls <code>cleanup()</code>. The common use case is for the effect
097: * to be painted on the window's glass pane, so the idea is to leave that
098: * onscreen while doing the work that will display the actual component,
099: * and then hide the glass pane containing the effect's product once the
100: * window is in its new state, with the component displayed.
101: */
102: public final void finish() {
103: running = false;
104: doFinish();
105: cleanup();
106: }
107:
108: /** Abort a running effect, so that finish will never be called. Sets
109: * the running flag to false and calls <code>cleanup()</code>. */
110: public final void abort() {
111: running = false;
112: cleanup();
113: comp = null;
114: root = null;
115: }
116:
117: /** Determine if an effect is currently running */
118: public final boolean isRunning() {
119: return running;
120: }
121:
122: /** Clean up any artifacts of the effect, shut down timers, etc. */
123: public abstract void cleanup();
124:
125: /** Implement whatever is needed to begin running the effect - starting a
126: * timer, playing with the glass pane, creating offscreen images, etc.,
127: * here */
128: protected abstract void doStart();
129:
130: /** Finish the operation - this method should be implemented to actually
131: * install the component and leave the displayer in its final state */
132: protected abstract void doFinish();
133:
134: }
|