/*
 * Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
 *
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met:
 * 
 *  o Redistributions of source code must retain the above copyright notice, 
 *    this list of conditions and the following disclaimer. 
 *     
 *  o Redistributions in binary form must reproduce the above copyright notice, 
 *    this list of conditions and the following disclaimer in the documentation 
 *    and/or other materials provided with the distribution. 
 *     
 *  o Neither the name of Flamingo Kirill Grouchnikov nor the names of 
 *    its contributors may be used to endorse or promote products derived 
 *    from this software without specific prior written permission. 
 *     
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
 */
package org.pushingpixels.flamingo.api.common.model;

import javax.swing.ButtonModel;

import org.pushingpixels.flamingo.api.common.AbstractCommandButton;

/**
 * Model for the action area of {@link AbstractCommandButton} component.
 * 
 * @author Kirill Grouchnikov
 */
public interface ActionButtonModel extends ButtonModel {
	/**
	 * Sets indication whether the associated actions should be fired on mouse
	 * press instead of mouse release.
	 * 
	 * @param toFireActionOnPress
	 *            if <code>true</code>, the associated actions will be fired on
	 *            mouse press, otherwise the associated actions will be fired on
	 *            mouse release.
	 */
	public void setFireActionOnPress(boolean toFireActionOnPress);

	/**
	 * Returns indication whether the associated actions should be fired on
	 * mouse press instead of mouse release.
	 * 
	 * @return <code>true</code> if the associated actions are fired on mouse
	 *         press, <code>false</code> if the associated actions are fired on
	 *         mouse release.
	 */
	public boolean isFireActionOnPress();
}