bundles/org.simantics.utils.ui/src/org/simantics/utils/ui/action/IPriorityAction.java

   1 /*******************************************************************************
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management
   3  * in Industry THTH ry.
   4  * All rights reserved. This program and the accompanying materials
   5  * are made available under the terms of the Eclipse Public License v1.0
   6  * which accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *     VTT Technical Research Centre of Finland - initial API and implementation
  11  *******************************************************************************/
  12 package org.simantics.utils.ui.action;
  13
  14 import org.eclipse.jface.action.IAction;
  15
  16 /**
  17  * An IAction with the addition of a priority specification for providing a way
  18  * of choosing one among multiple actions automatically or sorting multiple
  19  * actions based on their relatedness.
  20  *
  21  * @author Tuukka Lehtonen
  22  */
  23 public interface IPriorityAction extends IAction, Comparable<IPriorityAction> {
  24
  25     int LOW = -500;
  26
  27     int NORMAL = 0;
  28
  29     int MEDIUM = 500;
  30
  31     int HIGH   = 1000;
  32
  33     /**
  34      * @return a priority for this IAction, bigger stands for higher priority
  35      */
  36     public int getPriority();
  37
  38 }