bundles/org.simantics.g2d/src/org/simantics/g2d/element/handler/Validator.java

   1 /*******************************************************************************\r
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
   3  * in Industry THTH ry.\r
   4  * All rights reserved. This program and the accompanying materials\r
   5  * are made available under the terms of the Eclipse Public License v1.0\r
   6  * which accompanies this distribution, and is available at\r
   7  * http://www.eclipse.org/legal/epl-v10.html\r
   8  *\r
   9  * Contributors:\r
  10  *     VTT Technical Research Centre of Finland - initial API and implementation\r
  11  *******************************************************************************/\r
  12 package org.simantics.g2d.element.handler;\r
  13 \r
  14 import java.util.Collection;\r
  15 \r
  16 import org.simantics.g2d.canvas.ICanvasContext;\r
  17 import org.simantics.g2d.element.IElement;\r
  18 \r
  19 /**\r
  20  * This interface is implemented by all element contributions that\r
  21  * have fields to be validated. \r
  22  * \r
  23  * @author Toni Kalajainen\r
  24  */\r
  25 public interface Validator extends ElementHandler {\r
  26         \r
  27         public interface Suggestion {\r
  28                 String  getMessage(IElement e, ICanvasContext ctx);\r
  29                 /**\r
  30                  * \r
  31                  * @param e\r
  32                  * @param ctx\r
  33                  * @return\r
  34                  */\r
  35                 boolean fix(IElement e, ICanvasContext ctx);\r
  36         }\r
  37         \r
  38         public interface Issue {\r
  39                 String  getMessage(IElement e, ICanvasContext ctx);\r
  40                 /**\r
  41                  * \r
  42                  * @param e\r
  43                  * @param ctx\r
  44                  * @param suggestionList instances are should be static, shareable \r
  45                  */\r
  46                 void    addSuggestions(IElement e, ICanvasContext ctx, Collection<Suggestion> suggestionList);\r
  47         }\r
  48                 \r
  49         void validate(IElement e, ICanvasContext ctx, Collection<Issue> lst);   \r
  50 \r
  51 }\r