replaced <code></code> with more concise {@code}
[idea/community.git] / platform / platform-impl / src / com / intellij / openapi / editor / impl / softwrap / SoftWrapHelper.java
1 /*
2  * Copyright 2000-2015 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.softwrap;
17
18 import com.intellij.openapi.editor.SoftWrap;
19 import com.intellij.openapi.editor.SoftWrapModel;
20 import com.intellij.openapi.editor.VisualPosition;
21 import com.intellij.openapi.editor.impl.CaretImpl;
22 import com.intellij.openapi.editor.impl.EditorImpl;
23
24 /**
25  * Holds utility methods for soft wraps-related processing.
26  *
27  * @author Denis Zhdanov
28  * @since Aug 11, 2010 11:03:43 AM
29  */
30 public class SoftWrapHelper {
31
32   private SoftWrapHelper() {
33   }
34
35   /**
36    * Every soft wrap implies that multiple visual positions correspond to the same document offset. We can classify
37    * such positions by the following criteria:
38    * <pre>
39    * <ul>
40    *   <li>positions from visual line with soft wrap start;</li>
41    *   <li>positions from visual line with soft wrap end;</li>
42    * </ul>
43    * </pre>
44    * <p/>
45    * This method allows to answer if caret offset of the given editor points to soft wrap and visual caret position
46    * belongs to the visual line where soft wrap end is located.
47    *
48    * @return          {@code true} if caret offset of the given editor points to visual position that belongs to
49    *                  visual line where soft wrap end is located
50    */
51   public static boolean isCaretAfterSoftWrap(CaretImpl caret) {
52     if (!caret.isUpToDate()) {
53       return false;
54     }
55     EditorImpl editor = caret.getEditor();
56     SoftWrapModel softWrapModel = editor.getSoftWrapModel();
57     int offset = caret.getOffset();
58     SoftWrap softWrap = softWrapModel.getSoftWrap(offset);
59     if (softWrap == null) {
60       return false;
61     }
62
63     VisualPosition afterWrapPosition = editor.offsetToVisualPosition(offset, false, false);
64     VisualPosition caretPosition = caret.getVisualPosition();
65     return caretPosition.line == afterWrapPosition.line && caretPosition.column <= afterWrapPosition.column;
66   }
67 }