917a8fa1a3edbc4babb434bf3bcb210564001a27
[idea/community.git] / images / src / org / intellij / images / editor / ImageEditor.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 com.intellij.openapi.Disposable;
19 import com.intellij.openapi.project.Project;
20 import com.intellij.openapi.vfs.VirtualFile;
21 import org.intellij.images.ui.ImageComponentDecorator;
22
23 import javax.swing.*;
24
25 /**
26  * Image viewer.
27  *
28  * @author <a href="mailto:aefimov.box@gmail.com">Alexey Efimov</a>
29  */
30 public interface ImageEditor extends Disposable, ImageComponentDecorator {
31
32     VirtualFile getFile();
33
34     Project getProject();
35
36     ImageDocument getDocument();
37
38     JComponent getComponent();
39
40     /**
41      * Return the target of image editing area within entire component,
42      * returned by {@link #getComponent()}.
43      *
44      * @return Content component
45      */
46     JComponent getContentComponent();
47
48     /**
49      * Return <code>true</code> if editor show valid image.
50      *
51      * @return <code>true</code> if editor show valid image.
52      */
53     boolean isValid();
54
55     /**
56      * Return <code>true</code> if editor is already disposed.
57      *
58      * @return <code>true</code> if editor is already disposed.
59      */
60     boolean isDisposed();
61
62 }