org.divxdede.swing.busy.DefaultBusyModel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jbusycomponent
JBusyComponent : Enhance any swing components with a "busy" state
The newest version!
/*
 * 
 * Copyright (c) 2007 ANDRE Sébastien (divxdede).  All rights reserved.
 * DefaultBusyModel.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 .
 */
package org.divxdede.swing.busy;

import javax.swing.DefaultBoundedRangeModel;
import javax.swing.SwingUtilities;

/**
 * Default Implementation of interface BusyModel.
 * 
 * It add AutoCompletion feature for determinate model.
 * This feature allow to move the current value to the minimum range when the busy 
 * property is set to true.

 * At the other side, when the  current value reach the maximum bounded range, it set
 * automatically the busy property to false.
 * 
 * @author André Sébastien
 */
public class DefaultBusyModel extends DefaultBoundedRangeModel implements BusyModel {

    private boolean         busyState           = false;
    private boolean         determinateState    = false;
    private boolean         autoCompletionState = false;
    private boolean         cancellableState    = false;
    
    /** 
     * Define if the model is on a "busy" state
     * @param value true to going in a busy state
     */
    public void setBusy(final boolean value) {
        // new Exception("PASS(" + value + ")").printStackTrace();
        final boolean oldValue = isBusy();
        this.busyState = value;
        
        if( oldValue != isBusy() ) {
            if( this.isBusy() && this.isDeterminate() && this.isAutoCompletionEnabled() ) {
                this.setValue( getMinimum() );
            }
            this.fireStateChanged();
        }
    }
    
    /**
     * Returns true if the model is currently on a busy state
     * @return tue if the model is currently busy
     */
    public boolean isBusy() {
        return this.busyState;
    }

    /** Manage auto completion
     */
    @Override
    public void setValue(final int n) {
        super.setValue(n);
        
        if( isDeterminate() && isAutoCompletionEnabled() && getValue() >= getMaximum() ) {
            setBusy(false);
        }
    }
    
    /** 
     * Define if the model is in a determinate mode or not
     * @param value true for change this model in a determinate mode
     */
    public void setDeterminate(final boolean value) {
        final boolean oldValue = isDeterminate();
        this.determinateState = value;
        
        if( oldValue != isDeterminate() )
            this.fireStateChanged();
    }
    
    /** 
     * Returns true if the model is in a determinate mode.
     * @returns true if the model is in a determinate mode.
     */
    public boolean isDeterminate() {
        return this.determinateState;
    }
    
    /** 
     * Define if the range value must manage the completion automatically.
     * This property is significant only when this model is determinate.
     * When the busy property is set to true the range value is set to the minimum.
     * When the range value reach the maximum, the busy property is set to false.
     */
    public void setAutoCompletionEnabled(final boolean value) {
        final boolean oldValue = isAutoCompletionEnabled();
        
        this.autoCompletionState = value;
        
        if( oldValue != this.isAutoCompletionEnabled() )
            this.fireStateChanged();
    }
    
    /** 
     * Returns true if the range value must manage the completion automatically.
     * This property is significant only when this model is determinate.
     * When the busy property is set to true the range value is set to the minimum.
     * When the range value reach the maximum, the busy property is set to false.
     */
    public boolean isAutoCompletionEnabled() {
        return this.autoCompletionState;
    }

    /** 
     * Returns true if the model is cancellable the performing the job responsible on the busy state
     * @return true is the model is cancellable
     */
    public boolean isCancellable() {
        return this.cancellableState;
    }

    /**
     * Default implementation that simply stop the busy state
     */
    public void cancel() {
        if( ! isCancellable() ) throw new IllegalStateException("this model is not cancellable");
        setBusy(false);
    }
    
    /** 
     * Define if this model is cancellable
     * @param value true for set this model cancellable.
     */
    public void setCancellable(final boolean value) {
        final boolean oldValue = isCancellable();
        
        this.cancellableState = value;
        
        if( oldValue != isCancellable() ) {
            this.fireStateChanged();
        }
    }
    
    @Override
    protected void fireStateChanged() {
        if( ! SwingUtilities.isEventDispatchThread() ) {
            final Runnable doRun = new Runnable() {
                public void run() {
                    fireStateChanged();
                }
            };
            SwingUtilities.invokeLater(doRun);
            return;
        }
        super.fireStateChanged();
    }
}