001/*
002 * $Id: BusyLabelUI.java 3964 2011-03-17 19:12:29Z kschaefe $
003 *
004 * Copyright 2004 Sun Microsystems, Inc., 4150 Network Circle,
005 * Santa Clara, California 95054, U.S.A. All rights reserved.
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 * 
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
015 * Lesser General Public License for more details.
016 * 
017 * You should have received a copy of the GNU Lesser General Public
018 * License along with this library; if not, write to the Free Software
019 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
020 */
021
022package org.jdesktop.swingx.plaf;
023
024import java.awt.Dimension;
025
026import org.jdesktop.swingx.painter.BusyPainter;
027
028/**
029 *
030 * @author rah003
031 */
032public interface BusyLabelUI {
033    /**
034     * @return The BusyPainter for the JXBusyLabel. If
035     * this method returns null, then no progress indication will be shown by busy label.
036     */
037    public BusyPainter getBusyPainter(Dimension dim);
038    
039    /**
040     * Delay between moving from one point to another. The exact timing will be close to the selected value but is not guaranteed to be precise (subject to the timing precision of underlaying jvm).
041     * @return Delay in ms.
042     */
043    public int getDelay();
044}