platform/vcs-api/src/com/intellij/openapi/vcs/ui/Refreshable.java

   1 /*
   2  * Copyright 2000-2009 JetBrains s.r.o.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package com.intellij.openapi.vcs.ui;
  17
  18 import com.intellij.openapi.actionSystem.DataKey;
  19
  20 /**
  21  * Base interface for user interface objects which can be refreshed and can save/restore
  22  * their state.
  23  *
  24  * @author lesya
  25  */
  26 public interface Refreshable {
  27   DataKey<Refreshable> PANEL_KEY = DataKey.create("Panel");
  28
  29   /**
  30    * The data ID which can be used to retrieve the active <code>Refreshable</code>
  31    * instance from {@link com.intellij.openapi.actionSystem.DataContext}.
  32    *
  33    * @see com.intellij.openapi.actionSystem.DataContext#getData(String)
  34    */
  35   @Deprecated String PANEL = PANEL_KEY.getName();
  36
  37   void refresh();
  38
  39   void saveState();
  40
  41   void restoreState();
  42 }