replaced <code></code> with more concise {@code}
[idea/community.git] / platform / platform-impl / src / com / intellij / openapi / editor / impl / TextDrawingCallback.java
1 /*
2  * Copyright 2000-2010 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.impl;
17
18 import org.jetbrains.annotations.NotNull;
19
20 import java.awt.*;
21
22 /**
23  * IDEA editors use highly-optimized drawing algorithm that is tuned for painting large amounts of text data.
24  * <p/>
25  * However, there is a possible case that particular editor extension or third-party component may want to draw text at
26  * IDEA editor on it own. It's not supposed to do that directly, contrary, it's expected to delegate the processing
27  * to the code that knows how to do that.
28  * <p/>
29  * Current interface defines a contract for such a text drawing delegation task.
30  *
31  * @author Denis Zhdanov
32  * @since Jul 1, 2010 8:01:30 PM
33  */
34 public interface TextDrawingCallback {
35
36   /**
37    * Asks to draw symbols from {@code [start; end)} range of given char array at given graphics buffer using given
38    * font info and color.
39    *
40    * @param g         graphics buffer to use
41    * @param data      target symbols holder
42    * @param start     start offset within the symbols holder to use (inclusive)
43    * @param end       end offset within the symbols holder to use (inclusive)
44    * @param x         {@code 'x'} coordinate to use as a start position at the given graphics buffer
45    * @param y         {@code 'y'} coordinate to use as a start position at the given graphics buffer
46    * @param fontInfo  font info to use during drawing target text at the given graphics buffer
47    * @param color     color to use during drawing target text at the given graphics buffer
48    */
49   void drawChars(@NotNull Graphics g, @NotNull char[] data, int start, int end, int x, int y, Color color, FontInfo fontInfo);
50 }