replaced <code></code> with more concise {@code}
[idea/community.git] / platform / lang-impl / src / com / intellij / codeInsight / folding / CodeFoldingManager.java
1 /*
2  * Copyright 2000-2017 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
17 package com.intellij.codeInsight.folding;
18
19 import com.intellij.openapi.editor.Document;
20 import com.intellij.openapi.editor.Editor;
21 import com.intellij.openapi.editor.FoldRegion;
22 import com.intellij.openapi.fileEditor.impl.text.CodeFoldingState;
23 import com.intellij.openapi.project.Project;
24 import com.intellij.openapi.util.WriteExternalException;
25 import org.jdom.Element;
26 import org.jetbrains.annotations.NotNull;
27 import org.jetbrains.annotations.Nullable;
28
29 public abstract class CodeFoldingManager {
30   public static CodeFoldingManager getInstance(Project project){
31     return project.getComponent(CodeFoldingManager.class);
32   }
33
34   public abstract void updateFoldRegions(@NotNull Editor editor);
35
36   public abstract void forceDefaultState(@NotNull Editor editor);
37
38   @Nullable
39   public abstract Runnable updateFoldRegionsAsync(@NotNull Editor editor, boolean firstTime);
40
41   @Nullable
42   public abstract FoldRegion findFoldRegion(@NotNull Editor editor, int startOffset, int endOffset);
43   public abstract FoldRegion[] getFoldRegionsAtOffset(@NotNull Editor editor, int offset);
44
45   public abstract CodeFoldingState saveFoldingState(@NotNull Editor editor);
46   public abstract void restoreFoldingState(@NotNull Editor editor, @NotNull CodeFoldingState state);
47   
48   public abstract void writeFoldingState(@NotNull CodeFoldingState state, @NotNull Element element) throws WriteExternalException;
49   public abstract CodeFoldingState readFoldingState(@NotNull Element element, @NotNull Document document);
50
51   public abstract void releaseFoldings(@NotNull Editor editor);
52   public abstract void buildInitialFoldings(@NotNull Editor editor);
53   @Nullable
54   public abstract CodeFoldingState buildInitialFoldings(@NotNull Document document);
55
56   /**
57    * For auto-generated regions (created by {@link com.intellij.lang.folding.FoldingBuilder}s), returns their 'collapsed by default'
58    * status, for other regions returns {@code null}.
59    */
60   @Nullable
61   public abstract Boolean isCollapsedByDefault(@NotNull FoldRegion region);
62
63   /**
64    * Schedules recalculation of foldings in editor ({@link com.intellij.codeInsight.daemon.impl.CodeFoldingPass CodeFoldingPass}), which
65    * will happen even if document (and other dependencies declared by {@link com.intellij.lang.folding.FoldingBuilder FoldingBuilder}) 
66    * haven't changed.
67    */
68   public abstract void scheduleAsyncFoldingUpdate(@NotNull Editor editor);
69 }