images/src/org/intellij/images/editor/ImageDocument.java

   1 /*
   2  * Copyright 2004-2005 Alexey Efimov
   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 org.intellij.images.editor;
  17
  18 import javax.swing.event.ChangeListener;
  19 import java.awt.*;
  20 import java.awt.image.BufferedImage;
  21
  22 /**
  23  * Image document to show or edit in {@link ImageEditor}.
  24  *
  25  * @author <a href="mailto:aefimov.box@gmail.com">Alexey Efimov</a>
  26  */
  27 public interface ImageDocument {
  28     /**
  29      * Return image for rendering
  30      *
  31      * @return Image renderer
  32      */
  33     Image getRenderer();
  34
  35     /**
  36      * Return current image.
  37      *
  38      * @return Return current buffered image
  39      */
  40     BufferedImage getValue();
  41
  42     /**
  43      * Set image value
  44      *
  45      * @param image Value
  46      */
  47     void setValue(BufferedImage image);
  48
  49     /**
  50      * Return image format.
  51      *
  52      * @return Format name
  53      */
  54     String getFormat();
  55
  56     /**
  57      * Set image format.
  58      *
  59      * @param format Format from ImageIO (GIF, PNG, JPEG etc)
  60      */
  61     void setFormat(String format);
  62
  63     void addChangeListener(ChangeListener listener);
  64
  65     void removeChangeListener(ChangeListener listener);
  66 }