Plugins/ProcessHierarchy/NotationProcessHierarchy/src/cz/cvut/promod/hierarchyNotation/ProcessHierarchyNotation.java

   1 package cz.cvut.promod.hierarchyNotation;
   2
   3 import com.jgoodies.binding.PresentationModel;
   4 import com.jgoodies.binding.value.ValueModel;
   5 import com.jidesoft.status.LabelStatusBarItem;
   6 import com.jidesoft.swing.JideBoxLayout;
   7 import cz.cvut.promod.gui.Modeler;
   8 import cz.cvut.promod.gui.settings.SettingPageData;
   9 import cz.cvut.promod.hierarchyNotation.ioController.ProcessHierarchyIOController;
  10 import cz.cvut.promod.hierarchyNotation.modelFactory.ProcessHierarchyModelFactory;
  11 import cz.cvut.promod.hierarchyNotation.resources.Resources;
  12 import cz.cvut.promod.plugin.notationSpecificPlugIn.DockableFrameData;
  13 import cz.cvut.promod.plugin.notationSpecificPlugIn.notation.NotationWorkspaceData;
  14 import cz.cvut.promod.plugin.notationSpecificPlugIn.notation.factory.DiagramModelFactory;
  15 import cz.cvut.promod.plugin.notationSpecificPlugIn.notation.localIOController.NotationLocalIOController;
  16 import cz.cvut.promod.services.ModelerSession;
  17 import cz.cvut.promod.services.actionService.actionUtils.ProModAction;
  18 import cz.cvut.promod.services.menuService.MenuService;
  19 import cz.cvut.promod.services.menuService.utils.InsertMenuItemResult;
  20 import cz.cvut.promod.services.menuService.utils.MenuItemPosition;
  21
  22 import javax.swing.*;
  23 import java.util.List;
  24 import java.util.Set;
  25
  26 /**
  27  * ProMod, master thesis project
  28  * User: Petr Zverina, petr.zverina@gmail.com
  29  * Date: 23:30:50, 25.11.2009
  30  *
  31  * Implementation of a ProcessHierarchyNotation plugin.
  32  */
  33 public class ProcessHierarchyNotation implements cz.cvut.promod.plugin.notationSpecificPlugIn.notation.Notation{
  34
  35     private final ProcessHierarchyNotationModel model;
  36
  37     private final ProcessHierarchyModelFactory modelFactory;
  38
  39     private final ProcessHierarchyIOController ioController;
  40
  41     private final ValueModel checkTreeStructureModel;
  42
  43     private static final Icon ICON = Resources.getIcon(Resources.ICONS + Resources.DIAGRAM);
  44
  45     private final LabelStatusBarItem statusBarItem = ModelerSession.getComponentFactoryService().createLabelStatusBarItem();
  46
  47     /**
  48      * Parameter-less constructor.
  49      */
  50     public ProcessHierarchyNotation(){
  51         model = new ProcessHierarchyNotationModel(statusBarItem);
  52
  53         final PresentationModel<ProcessHierarchyNotationModel> presentation =
  54                 new PresentationModel<ProcessHierarchyNotationModel>(model);
  55
  56         checkTreeStructureModel = presentation.getModel(ProcessHierarchyNotationModel.CHECK_TREE_STRUCTURE_PROPERTY);
  57
  58         checkTreeStructureModel.setValue(true); // initialize is this check turned on
  59
  60         modelFactory = new ProcessHierarchyModelFactory();
  61
  62         ioController = new ProcessHierarchyIOController(model.getExtension(), getIdentifier());
  63
  64         initComponents();
  65     }
  66
  67     /** {@inheritDoc} */
  68     public String getName() {
  69         return model.getName();
  70     }
  71
  72     /** {@inheritDoc} */
  73     public String getDescription() {
  74         return model.getDescription();
  75     }
  76
  77     /** {@inheritDoc} */
  78     private void initComponents() {
  79         statusBarItem.setHorizontalAlignment(JLabel.RIGHT);
  80     }
  81
  82     /** {@inheritDoc} */
  83     public Set<DockableFrameData> getDockableFrames() {
  84         return model.getDockableFrames();
  85     }
  86
  87     /** {@inheritDoc} */
  88     public String getFullName() {
  89         return model.getFullName();
  90     }
  91
  92     /** {@inheritDoc} */
  93     public String getAbbreviation() {
  94         return model.getAbbreviation();
  95     }
  96
  97     /** {@inheritDoc} */
  98     public Icon getNotationIcon() {
  99         return ICON;
 100     }
 101
 102     /** {@inheritDoc} */
 103     public String getNotationToolTip() {
 104         return "Process Hierarchy.";
 105     }
 106
 107     /** {@inheritDoc} */
 108     public NotationWorkspaceData getNotationWorkspaceData() {
 109         return model.getWorkspace();
 110     }
 111
 112     /** {@inheritDoc} */
 113     public ImageIcon getNotationPreviewImage() {
 114         return Resources.getIcon(Resources.ICONS + Resources.PREVIEW);
 115     }
 116
 117     /** {@inheritDoc} */
 118     public String getNotationPreviewText() {
 119         return "Process Hierarchy Notation is supposed to be used for a process or organization hierarchy modeling. It is not a standard kind of flow-chart. Use the processes and build the hierarchical structure.";
 120     }
 121
 122     /** {@inheritDoc} */
 123     public DiagramModelFactory getDiagramModelFactory() {
 124         return modelFactory;
 125     }
 126
 127     /** {@inheritDoc} */
 128     public NotationLocalIOController getLocalIOController() {
 129         return ioController;
 130     }
 131
 132     /** {@inheritDoc} */
 133     public String getIdentifier() {
 134         return model.getIdentifier();
 135     }
 136
 137     /**
 138      * Process Hierarchy notation does NOT support popup menu functionality.
 139      *
 140      * {@inheritDoc}
 141      */
 142      public InsertMenuItemResult addPopupMenuItem(ProModAction proModAction, MenuItemPosition menuItemPosition, MenuService.MenuSeparator menuSeparator, boolean checkable){
 143         return InsertMenuItemResult.POPUP_NOT_SUPPORTED;
 144     }
 145
 146     /** {@inheritDoc} */
 147     public List<SettingPageData> getSettingPages() {
 148         return null;
 149     }
 150
 151     /** {@inheritDoc} */
 152     public void init() {
 153         initActions();
 154
 155         initToolBar();
 156
 157         initStatusBar();
 158
 159         initMainMenu();
 160     }
 161
 162     private void initMainMenu() {
 163         ModelerSession.getMenuService().insertMainMenuItem(
 164                 model.getAction(ProcessHierarchyNotationModel.SAVE_ACTION_KEY),
 165                 new MenuItemPosition(Modeler.FILE_LABEL, MenuItemPosition.PlacementStyle.FIRST
 166                 )
 167         );
 168
 169         ModelerSession.getMenuService().insertMainMenuItem(
 170                 model.getAction(ProcessHierarchyNotationModel.REFRESH_ACTION_KEY),
 171                 new MenuItemPosition(ProcessHierarchyNotationModel.PROCESS_HIERARCHY_LABEL)
 172         );
 173     }
 174
 175     private void initStatusBar() {
 176
 177         ModelerSession.getStatusBarService().addStatusBarItem(
 178                 getIdentifier(), statusBarItem, JideBoxLayout.VARY
 179         );
 180     }
 181
 182     private void initToolBar() {
 183         ModelerSession.getToolBarService().addAction(
 184                 getIdentifier(),
 185                 model.getAction(ProcessHierarchyNotationModel.SAVE_ACTION_KEY)
 186         );
 187
 188         ModelerSession.getToolBarService().addAction(
 189                 getIdentifier(),
 190                 model.getAction(ProcessHierarchyNotationModel.SAVE_ALL_ACTION_KEY)
 191         );
 192
 193         ModelerSession.getToolBarControlService().getCommandBar(getIdentifier()).addSeparator();
 194
 195         ModelerSession.getToolBarService().addAction(
 196                 getIdentifier(),
 197                 model.getAction(ProcessHierarchyNotationModel.REFRESH_ACTION_KEY)
 198         );
 199
 200         ModelerSession.getToolBarService().addAction(
 201                 getIdentifier(),
 202                 model.getAction(ProcessHierarchyNotationModel.DELETE_ACTION_KEY)
 203         );
 204
 205         ModelerSession.getToolBarControlService().getCommandBar(getIdentifier()).addSeparator();
 206
 207         ModelerSession.getToolBarControlService().getCommandBar(getIdentifier()).add(createTreeTestCheckBox());
 208     }
 209
 210     private JCheckBox createTreeTestCheckBox() {
 211         final JCheckBox checkBox = ModelerSession.getComponentFactoryService().createCheckBox();
 212         checkBox.setText(ProcessHierarchyNotationModel.CHECK_TREE_STRUCTURE_LABEL);
 213
 214         com.jgoodies.binding.adapter.Bindings.bind(checkBox, checkTreeStructureModel);
 215
 216         return checkBox;
 217     }
 218
 219     private void initActions() {
 220         ModelerSession.getActionService().registerAction(
 221                 getIdentifier(),
 222                 ProcessHierarchyNotationModel.REFRESH_ACTION_KEY,
 223                 model.getAction(ProcessHierarchyNotationModel.REFRESH_ACTION_KEY)
 224         );
 225
 226         ModelerSession.getActionService().registerAction(
 227                 getIdentifier(),
 228                 ProcessHierarchyNotationModel.DELETE_ACTION_KEY,
 229                 model.getAction(ProcessHierarchyNotationModel.DELETE_ACTION_KEY)
 230         );
 231
 232         ModelerSession.getActionService().registerAction(
 233                 getIdentifier(),
 234                 ProcessHierarchyNotationModel.SAVE_ACTION_KEY,
 235                 model.getAction(ProcessHierarchyNotationModel.SAVE_ACTION_KEY)
 236         );
 237
 238         ModelerSession.getActionService().registerAction(
 239                 getIdentifier(),
 240                 ProcessHierarchyNotationModel.SAVE_ALL_ACTION_KEY,
 241                 model.getAction(ProcessHierarchyNotationModel.SAVE_ALL_ACTION_KEY)
 242         );
 243     }
 244
 245     /** {@inheritDoc} */
 246     public void finish() { }
 247
 248     public boolean checkTreeStructure(){
 249         return (Boolean) checkTreeStructureModel.getValue();
 250     }
 251
 252     /**
 253      * Sets a text to the label status bar item.
 254      *
 255      * @param text is the text to be displayed in the status bar
 256      */
 257     public void setStatusInfoText(final String text){
 258         statusBarItem.setText(text);
 259     }
 260 }