replaced <code></code> with more concise {@code}
[idea/community.git] / platform / platform-impl / src / com / intellij / openapi / preview / PreviewManager.java
1 /*
2  * Copyright 2000-2014 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.preview;
17
18 import com.intellij.openapi.project.Project;
19 import org.jetbrains.annotations.NotNull;
20 import org.jetbrains.annotations.Nullable;
21
22 public interface PreviewManager {
23   class SERVICE {
24
25     private SERVICE() {
26     }
27
28     @Nullable
29     private static PreviewManager getInstance(@NotNull Project project) {
30       return null;//disabled for a while
31       //if (!UISettings.getInstance().NAVIGATE_TO_PREVIEW) return null;
32       //return ServiceManager.getService(project, PreviewManager.class);
33     }
34
35     /**
36      * @return null if preview cannot be performed
37      */
38     @Nullable
39     public static <V, C> C preview(@NotNull Project project, @NotNull PreviewProviderId<V, C> id, V data, boolean requestFocus) {
40       PreviewManager instance = getInstance(project);
41       if (instance == null) return null;
42       return instance.preview(id, data, requestFocus);
43     }
44
45     public static <V, C> void close(@NotNull Project project, @NotNull PreviewProviderId<V, C> id, V data) {
46       PreviewManager instance = getInstance(project);
47       if (instance != null) {
48         instance.close(id, data);
49       }
50     }
51
52     public static <V, C> void moveToStandardPlaceImpl(@NotNull Project project, @NotNull PreviewProviderId<V, C> id, V data) {
53       PreviewManager instance = getInstance(project);
54       if (instance != null) {
55         instance.moveToStandardPlaceImpl(id, data);
56       }
57     }
58   }
59
60   /**
61    * @return {@code null} if provider is not available / not active or if it forces to use standard view instead of preview at the moment
62    */
63   @Nullable
64   <V, C> C preview(@NotNull PreviewProviderId<V, C> id, V data, boolean requestFocus);
65
66   <V, C> void moveToStandardPlaceImpl(@NotNull PreviewProviderId<V, C> id, V data);
67
68   <V, C> void close(@NotNull PreviewProviderId<V, C> id, V data);
69 }