1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* Oracle and Java are registered trademarks of Oracle and/or its affiliates.
* Other names may be trademarks of their respective owners.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common
* Development and Distribution License("CDDL") (collectively, the
* "License"). You may not use this file except in compliance with the
* License. You can obtain a copy of the License at
* http://www.netbeans.org/cddl-gplv2.html
* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
* specific language governing permissions and limitations under the
* License. When distributing the software, include this License Header
* Notice in each file and include the License file at
* nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the
* License Header, with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Contributor(s):
*
* The Original Software is NetBeans. The Initial Developer of the Original
* Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
* Microsystems, Inc. All Rights Reserved.
*
* If you wish your version of this file to be governed by only the CDDL
* or only the GPL Version 2, indicate your decision by adding
* "[Contributor] elects to include this software in this distribution
* under the [CDDL or GPL Version 2] license." If you do not indicate a
* single choice of license, a recipient has the option to distribute
* your version of this file under either the CDDL, the GPL Version 2 or
* to extend the choice of license to its licensees as provided above.
* However, if you add GPL Version 2 code and therefore, elected the GPL
* Version 2 license, then the option applies only if the new code is
* made subject to such option by the copyright holder.
*/
/*
* FxProvider.java
*
* Created on March 27, 2004, 9:04 PM
*/
package org.netbeans.swing.tabcontrol.plaf;
import javax.swing.*;
/** Class which can provide sliding or other eye-candy effects as a component
* is displayed. To use, subclass TabbedContainerUI and create an instance
* in createFxProvider. The abstract doFinish() method is expected to call
* TabbedContainerUI.showComponent(), so this is best implemented as an inner
* class of a TabbbedContainerUI implementation.
*
* @author Tim Boudreau
*/
public abstract class FxProvider {
protected JComponent comp;
protected JRootPane root;
private boolean running = false;
protected Object orientation = null;
/** Creates a new instance of FxProvider */
public FxProvider() {
}
/** Start the effect running. This method will set up the fields with
* the passed values, set the running flag, and then call <code>doStart()</code>.
* If <code>isRunning()</code> is true, calls <code>abort()</code> before
* initializing.
*/
public final void start(JComponent comp, JRootPane root, Object orientation) {
if (running) {
if (comp == this.comp && root == this.root) {
return;
} else {
abort();
}
}
this.comp = comp;
this.root = root;
this.orientation = orientation;
running = true;
doStart();
}
/**
* Perform any cleanup necessary and complete the effect.
* Sets the running flag to false, calls <code>doFinish()</code> (in which
* the implementation should call showComponent() on the TabbedContainerUI
* to actually show the component for which an effect has been being
* presented. <strong>After</strong> calling <code>finish()</code>, it
* calls <code>cleanup()</code>. The common use case is for the effect
* to be painted on the window's glass pane, so the idea is to leave that
* onscreen while doing the work that will display the actual component,
* and then hide the glass pane containing the effect's product once the
* window is in its new state, with the component displayed.
*/
public final void finish() {
running = false;
doFinish();
cleanup();
}
/** Abort a running effect, so that finish will never be called. Sets
* the running flag to false and calls <code>cleanup()</code>. */
public final void abort() {
running = false;
cleanup();
comp = null;
root = null;
}
/** Determine if an effect is currently running */
public final boolean isRunning() {
return running;
}
/** Clean up any artifacts of the effect, shut down timers, etc. */
public abstract void cleanup();
/** Implement whatever is needed to begin running the effect - starting a
* timer, playing with the glass pane, creating offscreen images, etc.,
* here */
protected abstract void doStart();
/** Finish the operation - this method should be implemented to actually
* install the component and leave the displayer in its final state */
protected abstract void doFinish();
}
|
