IndependentModeler/src/cz/cvut/promod/services/menuService/utils/ModelerMenuItem.java

   1 package cz.cvut.promod.services.menuService.utils;
   2
   3 import java.util.List;
   4
   5 /**
   6  * ProMod, master thesis project
   7  * User: Petr Zverina, petr.zverina@gmail.com
   8  * Date: 1:22:36, 30.10.2009
   9  */
  10
  11 /**
  12  * Class that is a base class for all items in menus.
  13  */
  14 public interface ModelerMenuItem {
  15
  16     /**
  17      * Returns the list of relative items. Relives are all items in menu that have the same name (text).
  18      * All relatives return empty list (but not nullary), but one returns list containing references to all
  19      * other relative items (to make it possible to set them not visible).
  20      *
  21      * @return If the item is supposed to be hidden when not related notation is selected, than this methods
  22      * return an empty list, if it has no relatives then returns null, and if this is the item that is supposed
  23      * to be shown (event if it is disabled anyway) that it returns the non empty list of relatives.
  24      */
  25     public List<ModelerMenuItem> getListOfRelatives();
  26
  27     /**
  28      * Sets the list of relative items. Relives are all items in menu that have the same name (text).
  29      * All relatives return empty list (but not nullary), but one returns list containing references to all
  30      * other relative items (to make it possible to set them not visible).
  31      *
  32      * @param relatives is the list of relatives
  33      */
  34     public void setListOfRelatives(List<ModelerMenuItem> relatives);
  35
  36 }