eu.etaxonomy.taxeditor.editor/src/main/java/eu/etaxonomy/taxeditor/editor/IMultiPageTaxonEditorPage.java

   1 /**
   2 * Copyright (C) 2007 EDIT
   3 * European Distributed Institute of Taxonomy
   4 * http://www.e-taxonomy.eu
   5 *
   6 * The contents of this file are subject to the Mozilla Public License Version 1.1
   7 * See LICENSE.TXT at the top of this package for the full license terms.
   8 */
   9
  10 package eu.etaxonomy.taxeditor.editor;
  11
  12 import org.eclipse.ui.IEditorPart;
  13
  14 /**
  15  * <p>IMultiPageTaxonEditorPage interface.</p>
  16  *
  17  * @author n.hoffmann
  18  * @created Jan 5, 2010
  19  * @version 1.0
  20  */
  21 public interface IMultiPageTaxonEditorPage extends IEditorPart {
  22
  23         /**
  24          * Redraws this editor
  25          * return true on success
  26          *
  27          * @return a boolean.
  28          */
  29         public boolean redraw();
  30
  31         /**
  32          * Redraws the editor controls
  33          *
  34          * @param focus if set to true the focus is set on the editor
  35          * @return true on success
  36          */
  37         public boolean redraw(boolean focus);
  38
  39         /**
  40          * Whether the editor page is currently redrawing
  41          *
  42          * @return a boolean.
  43          */
  44         public boolean isRedrawing();
  45
  46         /**
  47          * Sets the editor page into enabled or disabled state depending on the
  48          * value of the supplied parameter <code>enabled</code>.
  49          *
  50          * @param enabled
  51          */
  52         public void setEnabled(boolean enabled);
  53
  54         /**
  55          * Sets the editor page into disabled state and changes the
  56          * appearance accordingly.
  57          */
  58         void setDisabled();
  59
  60         /**
  61          * Sets the editor page into disabled state and changes the
  62          * appearance in order to indicate that an error has occurred.
  63          */
  64         public void setOnError();
  65
  66 }