org.simantics.proconf.processeditor/src/fi/vtt/simantics/processeditor/monitors/Monitor.java

   1 /*******************************************************************************\r
   2  * Copyright (c) 2007 VTT Technical Research Centre of Finland and others.\r
   3  * All rights reserved. This program and the accompanying materials\r
   4  * are made available under the terms of the Eclipse Public License v1.0\r
   5  * which accompanies this distribution, and is available at\r
   6  * http://www.eclipse.org/legal/epl-v10.html\r
   7  *\r
   8  * Contributors:\r
   9  *     VTT Technical Research Centre of Finland - initial API and implementation\r
  10  *******************************************************************************/\r
  11 package fi.vtt.simantics.processeditor.monitors;\r
  12 \r
  13 import org.simantics.db.Graph;\r
  14 import org.simantics.proconf.g3d.scenegraph.IGraphicsNode;\r
  15 \r
  16 \r
  17 \r
  18 \r
  19 /**\r
  20  * Interface for monitors (Textual display of objects properties)\r
  21  * \r
  22  * @author Marko Luukkainen\r
  23  *\r
  24  */\r
  25 public interface Monitor {\r
  26         \r
  27         /**\r
  28          * Returns true if monitor can be attached to node\r
  29          * @param node\r
  30          * @return\r
  31          */\r
  32         public boolean acceptNode(Graph graph,IGraphicsNode node);\r
  33         \r
  34         /**\r
  35          * Returns the scene-graph node where monitor is attached\r
  36          * @return\r
  37          */\r
  38         public IGraphicsNode getNode();\r
  39 \r
  40         /**\r
  41          * Sets monitored node\r
  42          * @param node\r
  43          */\r
  44         public void setNode(Graph graph,IGraphicsNode node);\r
  45         \r
  46         /**\r
  47          * Updates monitor's texts\r
  48          *\r
  49          */\r
  50         public void update();\r
  51         \r
  52         public void update(Graph graph);\r
  53         \r
  54         /**\r
  55          * Removes the monitor. \r
  56          */\r
  57         public void remove();   \r
  58         \r
  59         \r
  60         public void setTextProvider(MonitorTextProvider provider);\r
  61         \r
  62 }\r