/*
* The University of Wales, Cardiff Triana Project Software License (Based
* on the Apache Software License Version 1.1)
*
* Copyright (c) 2007 University of Wales, Cardiff. All rights reserved.
*
* Redistribution and use of the software in source and binary forms, with
* or without modification, are permitted provided that the following
* conditions are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. 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.
*
* 3. The end-user documentation included with the redistribution, if any,
* must include the following acknowledgment: "This product includes
* software developed by the University of Wales, Cardiff for the Triana
* Project (http://www.trianacode.org)." Alternately, this
* acknowledgment may appear in the software itself, if and wherever
* such third-party acknowledgments normally appear.
*
* 4. The names "Triana" and "University of Wales, Cardiff" must not be
* used to endorse or promote products derived from this software
* without prior written permission. For written permission, please
* contact triana@trianacode.org.
*
* 5. Products derived from this software may not be called "Triana," nor
* may Triana appear in their name, without prior written permission of
* the University of Wales, Cardiff.
*
* 6. This software may not be sold, used or incorporated into any product
* for sale to third parties.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 UNIVERSITY OF WALES, CARDIFF OR ITS 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.
*
* ------------------------------------------------------------------------
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Triana Project. For more information on the
* Triana Project, please see. http://www.trianacode.org.
*
* This license is based on the BSD license as adopted by the Apache
* Foundation and is governed by the laws of England and Wales.
*
*/
package org.trianacode.gui.hci.tools;
import javax.swing.Action;
import javax.swing.Icon;
import javax.swing.JPopupMenu;
import org.trianacode.gui.main.TaskComponent;
import org.trianacode.taskgraph.Task;
import org.trianacode.taskgraph.tool.Tool;
/**
* The model for a tool in the tool tree and on the workspace
*
* @author Ian Wang
* @version $Revision: 4048 $
*/
public interface ToolComponentModel {
public static final int UNKNOWN_ACTION = 0;
public static final int DISPLAY_ICON = 1;
public static final int HIDE_ICON = 2;
/**
* @return the icon for the specified tool (if null is returned then the default leaf icon is used)
*/
public Icon getTreeIcon(Tool tool);
/**
* @return the tool tip for the tool when in the tree (if null is returned then the default tool tip is used, return
* a empty string for no tip)
*/
public String getTreeToolTip(Tool tool, boolean extended);
/**
* @return the popup menu the tool when in the tree (if null is returned then the default popup menu is used, return
* a empty popup menu for no popup)
*/
public JPopupMenu getTreePopup(Tool tool);
/**
* @return the tool tip for the tool when on the workspace (if null is returned then the default tool tip is used,
* return a empty string for no tip)
*/
public String getWorkspaceToolTip(Task task, boolean extended);
/**
* @return the popup menu the tool when in the workspace (if null is returned then the default popup menu is used,
* return a empty popup menu for no popup)
*/
public JPopupMenu getWorkspacePopup(Task task);
/**
* @return the action that is invoked when the task is activated (e.g. double-clicked). If null is returned the
* default tool action is used.
*/
public Action getTaskAction(Task task);
/**
* @return the task component used to represent the specified task (if null is returned then the default component
* is used)
*/
public TaskComponent getTaskComponent(Task task);
/**
* Called to determine if an icon for the specified action should be displayed, e.g. ADD_INPUT_NODE_ACTION. Returns
* whether the icon should be displayed (DISPLAY_ICON), should not be displayed (HIDE_ICON) or the action is unknown
* and should be deffered to the default handler (UNKNOWN_ACTION). If the default handler does not know the action
* then the icon is not displayed.
*
* @param action the update action (e.g. ADD_INPUT_NODE_ACTION as defined in UpdateActionConstants)
* @return either DISPLAY_ICON, HIDE_ICON or UNKNOWN_ACTION
*/
public int isUpdateIcon(Task task, String action);
/**
* Called to determine the action that is invoked when an update action is choosen.
*
* @param action the update action (e.g. ADD_INPUT_NODE_ACTION)
* @return either the action or null if unknown.
*/
public Action getUpdateAction(Task task, String action);
}