IndependentModeler/src/cz/cvut/promod/services/statusBarService/StatusBarService.java

   1 package cz.cvut.promod.services.statusBarService;
   2
   3 import com.jidesoft.status.StatusBarItem;
   4 import cz.cvut.promod.services.Service;
   5 import cz.cvut.promod.services.statusBarService.utils.InsertStatusBarItemResult;
   6
   7 /**
   8  * ProMod, master thesis project
   9  * User: Petr Zverina, petr.zverina@gmail.com
  10  * Date: 14:53:26, 21.1.2010
  11  */
  12
  13 /**
  14  * StatusBarService allows developers to insert new status bar items into the notation specific status bar.
  15  */
  16 public interface StatusBarService extends Service {
  17
  18     /**
  19      * Appends new status bar item to the notation specific status bar.
  20      *
  21      * @param notationIdentifier is the identifier of notation into which status bar is the new item supposed to be
  22      * appended
  23      *
  24      * @param statusBarItem is the status bar item that is supposed to be appended
  25      *
  26      * @param itemLayout is the layout information, see JideBoxLayout.FIX, JideBoxLayout.FLEXIBLE, JideBoxLayout.VARY,
  27      * JideBoxLayout.FIX is the initial value in case of nullary info or invalid value
  28      *
  29      * @return any value from InsertStatusBarItemResult enumeration
  30      *
  31      * @see cz.cvut.promod.services.statusBarService.utils.InsertStatusBarItemResult for more detail info about return
  32      * values
  33      */
  34     public InsertStatusBarItemResult addStatusBarItem(final String notationIdentifier,
  35                                                       final StatusBarItem statusBarItem,
  36                                                       String itemLayout);
  37
  38 }