001    /*
002     * $Id: RolloverRenderer.java 3100 2008-10-14 22:33:10Z rah003 $
003     *
004     * Copyright 2006 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    package org.jdesktop.swingx.rollover;
022    
023    /**
024     * Interface to mark renderers as "live". <p>
025     * 
026     * PENDING: probably need methods to enabled/click taking a similar
027     *   set of parameters as getXXComponent because the actual 
028     *   outcome might depend on the given value. If so, we'll need
029     *   to extend the XXRenderer interfaces.
030     *   
031     * @author Jeanette Winzenburg
032     */
033    public interface RolloverRenderer {
034        /**
035         * 
036         * @return true if rollover effects are on and clickable.
037         */
038        boolean isEnabled();
039        
040        /**
041         * Same as AbstractButton.doClick(). It's up to client
042         * code to prepare the renderer's component before calling
043         * this method.
044         *
045         */
046        void doClick();
047    }