replaced <code></code> with more concise {@code}
[idea/community.git] / platform / editor-ui-api / src / com / intellij / openapi / editor / InlayModel.java
1 /*
2  * Copyright 2000-2016 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.editor;
17
18 import com.intellij.openapi.Disposable;
19 import org.jetbrains.annotations.ApiStatus;
20 import org.jetbrains.annotations.NotNull;
21 import org.jetbrains.annotations.Nullable;
22
23 import java.awt.*;
24 import java.util.EventListener;
25 import java.util.List;
26
27 /**
28  * Provides an ability to introduce custom visual elements into editor's representation.
29  * Such elements are not reflected in document contents.
30  * <p>
31  * WARNING! This is an experimental API, it can change at any time.
32  */
33 @ApiStatus.Experimental
34 public interface InlayModel {
35   /**
36    * Introduces an inline visual element at a given offset, its width and appearance is defined by the provided renderer. With respect to
37    * document changes, created element behaves in a similar way to a zero-range {@link RangeMarker}. This method returns {@code null}
38    * if requested element cannot be created, e.g. if corresponding functionality is not supported by current editor instance.
39    */
40   @Nullable
41   Inlay addInlineElement(int offset, @NotNull EditorCustomElementRenderer renderer);
42
43   /**
44    * Returns a list of inline elements for a given offset range (both limits are inclusive). Returned list is sorted by offset.
45    */
46   @NotNull
47   List<Inlay> getInlineElementsInRange(int startOffset, int endOffset);
48
49   /**
50    * Tells whether there exists an inline visual element at a given offset.
51    */
52   boolean hasInlineElementAt(int offset);
53
54   /**
55    * Tells whether there exists an inline visual element at a given visual position.
56    * Only visual position to the left of the element is recognized.
57    */
58   boolean hasInlineElementAt(@NotNull VisualPosition visualPosition);
59
60   /**
61    * Return a custom visual element at given coordinates in editor's coordinate space,
62    * or {@code null} if there's no element at given point.
63    */
64   @Nullable
65   Inlay getElementAt(@NotNull Point point);
66
67   /**
68    * Adds a listener that will be notified after adding, updating and removal of custom visual elements.
69    */
70   void addListener(@NotNull Listener listener, @NotNull Disposable disposable);
71
72   interface Listener extends EventListener {
73     void onAdded(@NotNull Inlay inlay);
74
75     void onUpdated(@NotNull Inlay inlay);
76
77     void onRemoved(@NotNull Inlay inlay);
78   }
79
80   /**
81    * An adapter useful for the cases, when the same action is to be performed after custom visual element's adding, updating and removal.
82    */
83   abstract class SimpleAdapter implements Listener {
84     @Override
85     public void onAdded(@NotNull Inlay inlay) {
86       onUpdated(inlay);
87     }
88
89     @Override
90     public void onUpdated(@NotNull Inlay inlay) {}
91
92     @Override
93     public void onRemoved(@NotNull Inlay inlay) {
94       onUpdated(inlay);
95     }
96   }
97 }