replaced <code></code> with more concise {@code}
[idea/community.git] / platform / editor-ui-api / src / com / intellij / openapi / editor / EditorCustomElementRenderer.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 org.jetbrains.annotations.NotNull;
19 import org.jetbrains.annotations.Nullable;
20
21 import java.awt.*;
22
23 /**
24  * An interface, defining size and representation of custom visual element in editor.
25  *
26  * @see InlayModel#addInlineElement(int, EditorCustomElementRenderer)
27  * @see Inlay#getRenderer()
28  */
29 public interface EditorCustomElementRenderer {
30   /**
31    * Defines width of custom element (in pixels)
32    */
33   int calcWidthInPixels(@NotNull Editor editor);
34
35   /**
36    * Implements painting for the custom region. Rectangle passed as a parameter defines target region where painting should be performed.
37    */
38   void paint(@NotNull Editor editor, @NotNull Graphics g, @NotNull Rectangle r);
39
40   /**
41    * Returns a registered id of action group, which is to be used for displaying context menu for the given custom element.
42    * If {@code null} is returned, standard editor's context menu will be displayed upon corresponding mouse event.
43    */
44   @Nullable
45   default String getContextMenuGroupId() {
46     return null;
47   }
48 }