org.divxdede.swing.busy.BusyModel 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.
 * BusyModel.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.BoundedRangeModel;

/**
 * DataModel describe a busy state behaviour.
 * A busy state represent a disabled state (inacessible) for a while.
 * 
 * This state is commonly bound to a swing component that can't be used while it
 * is busy. Typically a pretty animation will be show.
 * 

 * When the model is gone to busy, it can be determinate that allow to track the
 * progress and time remaining like a JProgressBar.
 * In fact, a BusyModel is a  BoundedRangeModel that allow it to be bounded to a
 * JProgressBar.
 * 
 * BusyModel can be cancellable to allow the controller of this model to cancel the 
 * underlying task. 
 * 
 * @author André Sébastien
 */
public interface BusyModel extends BoundedRangeModel {

    /** 
     * Define if the model is on a "busy" state
     * @param value true to going in a busy state
     */
    public void setBusy(final boolean value);
    
    /**
     * Returns true if the model is currently on a busy state
     * @return tue if the model is currently busy
     */
    public boolean isBusy();
    
    /** 
     * 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);
    
    /** 
     * Returns true if the model is in a determinate mode.
     * @returns true if the model is in a determinate mode.
     */
    public boolean isDeterminate();

    /** 
     * 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();
    
    /** 
     * Define if this model is cancellable
     * @param value true for set this model cancellable.
     */
    public void setCancellable(final boolean value);
    
    /** Invoke this method to cancel the current job responsible of the busy state.
     *  You need to override this method for implements you own cancellation process.
     */
    public void cancel();
}