| java.lang.Object
 org.netbeans.swing.tabcontrol.plaf.FxProvider
| FxProvider | | abstract public class FxProvider (Code) | | 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 |
| Method Summary | |
| final public void | abort()
Abort a running effect, so that finish will never be called. | | abstract public void | cleanup()
Clean up any artifacts of the effect, shut down timers, etc. | | abstract protected void | doFinish()
| | abstract protected void | doStart()
| | final public void | finish()
Perform any cleanup necessary and complete the effect.
Sets the running flag to false, calls doFinish() (in which
the implementation should call showComponent() on the TabbedContainerUI
to actually show the component for which an effect has been being
presented. | | final public boolean | isRunning()
| | final public void | start(JComponent comp, JRootPane root, Object orientation)
Start the effect running. |
| FxProvider | | public FxProvider()(Code) | | Creates a new instance of FxProvider
|
| abort | | final public void abort()(Code) | | Abort a running effect, so that finish will never be called. Sets
the running flag to false and calls cleanup().
|
| cleanup | | abstract public void cleanup()(Code) | | Clean up any artifacts of the effect, shut down timers, etc.
|
| doFinish | | abstract protected void doFinish()(Code) | | Finish the operation - this method should be implemented to actually
install the component and leave the displayer in its final state
|
| doStart | | abstract protected void doStart()(Code) | | Implement whatever is needed to begin running the effect - starting a
timer, playing with the glass pane, creating offscreen images, etc.,
here
|
| finish | | final public void finish()(Code) | | Perform any cleanup necessary and complete the effect.
Sets the running flag to false, calls doFinish() (in which
the implementation should call showComponent() on the TabbedContainerUI
to actually show the component for which an effect has been being
presented. After calling finish(), it
calls cleanup(). 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.
|
| isRunning | | final public boolean isRunning()(Code) | | Determine if an effect is currently running
|
| start | | final public void start(JComponent comp, JRootPane root, Object orientation)(Code) | | Start the effect running. This method will set up the fields with
the passed values, set the running flag, and then call doStart().
If isRunning() is true, calls abort() before
initializing.
|
|
|