org.divxdede.swing.busy.JBusyComponent Maven / Gradle / Ivy
The newest version!
/*
*
* Copyright (c) 2007 ANDRE Sébastien (divxdede). All rights reserved.
* JBusyComponent.java is a part of this JBusyComponent library
* ====================================================================
*
* JBusyComponent library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation, either version 3 of the License,
* or any later version.
*
* This is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, see
* This decorator enhance a view (swing component) that provide a smart animation
* when it's view is busy and restrict any acces to it.
* The decorator take parts on the components hierarchy and must be added to the
* container instead of the original component that is now a simple view of the
* JBusyComponent
*
* Your component still the same as before and keep all of theses features and
* behaviour. The main difference is that now you can refer and use a
* BusyModel from the JBusyComponent decorator.
* This model allow you to control the busy property and some
* other related informations.
*
* Typically, a busy component is locked (can't be accessed anymore) and show
* on an overlay a smart animation showing this busy state. Regarding the
* BusyModel configuration, you can have also a progress bar (if
* the BusyModel is on a determinate state) and/or a cancel button
* (if the BusyModel is cancellable
* JBusyComponent is at the top of this API.
* But in fact, it's just a wrapper of JXLayer and a LayerUI implementation.
* All business implementation are done by the LayerUI and you can use directly
* a JXLayer instead of a JBusyComponent.
*
* This is a little example:
*
* // your component to enhance
* JTree comp = .....;
*
* // Create the JBusyComponent enhancer
* JBusyComponent busyComp = new JXLayer(comp);
*
* // Add our JBusyComponent to the container instead of our component
* myContainer.add( layer );
*
* // Use the BusyModel for control the busy state on our component
* BusyModel model = busyComp.getBusyModel();
*
* // Let's got to put our original component to a busy state
* model.setBusy(true); // an animation over our component is shown
*
*
* @see BusyModel
* @see JXLayer
* @see BusyLayerUI
* @author André Sébastien
*/
public class JBusyComponent extends JComponent {
/** Members
*/
private JXLayer layer = null;
private BusyLayerUI ui = null;
/**
* Create a JBusyComponent with no view
* @see #setView
*/
public JBusyComponent() {
this(null);
}
/**
* Create a JBusyComponent with a specified view
* @param view The view of this component
*/
public JBusyComponent( final C view ) {
this( view , new BasicBusyLayerUI() );
}
/**
* Create a JBusyComponent with a specified view and a BusyLayerUI
* @param view The view of this component
* @param ui The ui of this component
*/
public JBusyComponent( final C view , final BusyLayerUI ui) {
/** Create the layer
*/
this.layer = new JXLayer(view);
/** Configure it's fixed contents
*/
super.setLayout( new BorderLayout() );
super.add( this.layer );
super.setOpaque(false);
/** Install the UI
*/
setBusyLayerUI(ui);
/** Create a default model
*/
setBusyModel( new DefaultBusyModel() );
}
/**
* Returns the View of this JBusyComponent
* @return the underlying view of this JBusyComponent
*/
public C getView() {
return (C)this.layer.getView();
}
/**
* Define the view of this JBusyComponent
* @param view the new view of this component
*/
public void setView(final C view) {
this.layer.setView(view);
}
/**
* Returns the BusyLayerUI used by this component.
* @returns BusyLayerUI used by this component, this ui subclass LayerUI
* @see LayerUI
*/
public BusyLayerUI getBusyLayerUI() {
return this.ui;
}
/**
* Define which BusyLayerUI this component must used for render the "busy" state
* @param newUI New BusyLayerUI to use
*/
public void setBusyLayerUI( BusyLayerUI newUI) {
if( newUI == null ) newUI = new BasicBusyLayerUI();
else {
if( ! (newUI instanceof LayerUI ) ) {
throw new IllegalArgumentException("newUI must subclass LayerUI");
}
}
/** Keep track to our "Busy Model"
*/
BusyModel model = null;
if( getBusyLayerUI() != null ) {
model = getBusyLayerUI().getBusyModel();
getBusyLayerUI().setBusyModel(null);
}
/** Change the UI
*/
this.ui = newUI;
this.layer.setUI( (LayerUI)getBusyLayerUI() );
/** Update the BusyLayerUI with our "Busy Model"
*/
if( getBusyLayerUI() != null ) {
getBusyLayerUI().setBusyModel(model);
}
}
/**
* Define the BusyModel used by this component
* @param model New BusyModel to use by this component
*/
public void setBusyModel(final BusyModel model) {
final BusyLayerUI myUI = getBusyLayerUI();
if( myUI == null ) throw new IllegalStateException("Can't set a BusyModel on a JBusyComponent without a BusyLayerUI");
myUI.setBusyModel( model );
}
/**
* Returns the BusyModel used by this component
* @return BusyModel used by this component
*/
public BusyModel getBusyModel() {
final BusyLayerUI myUI = getBusyLayerUI();
if( myUI == null ) return null;
return myUI.getBusyModel();
}
/**
* Returns true if this component is on a busy state
* @return true if this component is on a busy state
*/
public boolean isBusy() {
return getBusyModel() != null && getBusyModel().isBusy();
}
/**
* Define if this component is in a busy state or not
* @param value true value set this component in a busy state
*/
public void setBusy(final boolean value) {
final BusyModel model = getBusyModel();
if( model != null ) model.setBusy(value);
}
@Override
public Component add(final Component comp) {
throw new UnsupportedOperationException("JBusyComponent.add() is not supported.");
}
@Override
public void remove(final Component comp) {
throw new UnsupportedOperationException("JBusyComponent.remove(Component) is not supported.");
}
@Override
public void removeAll() {
throw new UnsupportedOperationException("JBusyComponent.removeAll() is not supported.");
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy