FoldManager

java.lang.Object
- com.fr.design.gui.syntax.ui.rsyntaxtextarea.folding.FoldManager

```
public class FoldManager
extends java.lang.Object
```
Manages code folding in an instance of RSyntaxTextArea.

版本:

1.0

作者:

Robert Futrell

字段概要

字段
限定符和类型字段和说明

static java.lang.String PROPERTY_FOLDS_UPDATED
Property fired when folds have been updated.

字段
限定符和类型	字段和说明
`static java.lang.String`	`PROPERTY_FOLDS_UPDATED` Property fired when folds have been updated.

构造器概要

构造器
构造器和说明

FoldManager(RSyntaxTextArea textArea)
Constructor.

构造器
构造器和说明
`FoldManager(RSyntaxTextArea textArea)` Constructor.

方法概要

方法
限定符和类型	方法和说明
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener l)` Adds a property change listener to this fold manager.
`void`	`clear()` Removes all folds.
`boolean`	`ensureOffsetNotInClosedFold(int offs)` Ensures that the specified offset is not hidden in a collapsed fold.
`Fold`	`getDeepestFoldContaining(int offs)` Returns the "deepest" nested fold containing the specified offset.
`Fold`	`getDeepestOpenFoldContaining(int offs)` Returns the "deepest" open fold containing the specified offset.
`Fold`	`getFold(int index)` Returns a specific top-level fold, which may have child folds.
`int`	`getFoldCount()` Returns the number of top-level folds.
`Fold`	`getFoldForLine(int line)` Returns the fold region that starts at the specified line.
`int`	`getHiddenLineCount()` Returns the total number of hidden (folded) lines.
`int`	`getHiddenLineCountAbove(int line)` Returns the number of lines "hidden" by collapsed folds above the specified line.
`int`	`getHiddenLineCountAbove(int line, boolean physical)` Returns the number of lines "hidden" by collapsed folds above the specified line.
`int`	`getLastVisibleLine()` Returns the last visible line in the text area, taking into account folds.
`int`	`getVisibleLineAbove(int line)`
`int`	`getVisibleLineBelow(int line)`
`boolean`	`isCodeFoldingEnabled()` Returns whether code folding is enabled.
`boolean`	`isCodeFoldingSupportedAndEnabled()` Returns `true` if and only if code folding is enabled for this text area, AND folding is supported for the language it is editing.
`boolean`	`isFoldStartLine(int line)` Returns whether the specified line contains the start of a fold region.
`boolean`	`isLineHidden(int line)` Returns whether a line is hidden in a collapsed fold.
`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener l)` Removes a property change listener from this fold manager.
`void`	`reparse()` Forces an immediate reparsing for folds, if folding is enabled.
`void`	`setCodeFoldingEnabled(boolean enabled)` Sets whether code folding is enabled.
`void`	`setFolds(java.util.List<Fold> folds)` Sets the folds for this fold manager.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - PROPERTY_FOLDS_UPDATED
```
public static final java.lang.String PROPERTY_FOLDS_UPDATED
```
    Property fired when folds have been updated.
    
    另请参阅:
    常量字段值
- 构造器详细资料
  - FoldManager
```
public FoldManager(RSyntaxTextArea textArea)
```
    Constructor.
    
    参数:
    textArea - The text area whose folds we are managing.
- 方法详细资料
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.beans.PropertyChangeListener l)
```
    Adds a property change listener to this fold manager.
    
    参数:
    l - The new listener.
    另请参阅:
    removePropertyChangeListener(PropertyChangeListener)
  - clear
```
public void clear()
```
    Removes all folds.
  - ensureOffsetNotInClosedFold
```
public boolean ensureOffsetNotInClosedFold(int offs)
```
    Ensures that the specified offset is not hidden in a collapsed fold. Any folds containing this offset that are collapsed will be expanded.
    
    参数:
    offs - The offset.
    
    返回:
    Whether any folds had to be opened.
    另请参阅:
    getDeepestFoldContaining(int)
  - getDeepestFoldContaining
```
public Fold getDeepestFoldContaining(int offs)
```
    Returns the "deepest" nested fold containing the specified offset.
    
    参数:
    offs - The offset.
    
    返回:
    The deepest fold containing the offset, or null if no fold contains the offset.
  - getDeepestOpenFoldContaining
```
public Fold getDeepestOpenFoldContaining(int offs)
```
    Returns the "deepest" open fold containing the specified offset.
    
    参数:
    offs - The offset.
    
    返回:
    The fold, or null if no open fold contains the offset.
  - getFold
```
public Fold getFold(int index)
```
    Returns a specific top-level fold, which may have child folds.
    
    参数:
    index - The index of the fold.
    
    返回:
    The fold.
    另请参阅:
    getFoldCount()
  - getFoldCount
```
public int getFoldCount()
```
    Returns the number of top-level folds.
    
    返回:
    The number of top-level folds.
    另请参阅:
    getFold(int)
  - getFoldForLine
```
public Fold getFoldForLine(int line)
```
    Returns the fold region that starts at the specified line.
    
    参数:
    line - The line number.
    
    返回:
    The fold, or null if the line is not the start of a fold region.
    另请参阅:
    isFoldStartLine(int)
  - getHiddenLineCount
```
public int getHiddenLineCount()
```
    Returns the total number of hidden (folded) lines.
    
    返回:
    The total number of hidden (folded) lines.
    另请参阅:
    getHiddenLineCountAbove(int)
  - getHiddenLineCountAbove
```
public int getHiddenLineCountAbove(int line)
```
    Returns the number of lines "hidden" by collapsed folds above the specified line.
    
    参数:
    line - The line. This is the line number for a logical line. For the line number of a physical line (i.e. visible, not folded), use getHiddenLineCountAbove(int, true).
    
    返回:
    The number of lines hidden in folds above line.
    另请参阅:
    getHiddenLineCountAbove(int, boolean)
  - getHiddenLineCountAbove
```
public int getHiddenLineCountAbove(int line,
                          boolean physical)
```
    Returns the number of lines "hidden" by collapsed folds above the specified line.
    
    参数:
    line - The line.
    physical - Whether line is the number of a physical line (i.e. visible, not code-folded), or a logical one (i.e. any line from the model). If line was determined by a raw line calculation (i.e. (visibleTopY / lineHeight)), this value should be true. It should be false when it was calculated from an offset in the document (for example).
    
    返回:
    The number of lines hidden in folds above line.
  - getLastVisibleLine
```
public int getLastVisibleLine()
```
    Returns the last visible line in the text area, taking into account folds.
    
    返回:
    The last visible line.
  - getVisibleLineAbove
```
public int getVisibleLineAbove(int line)
```
  - getVisibleLineBelow
```
public int getVisibleLineBelow(int line)
```
  - isCodeFoldingEnabled
```
public boolean isCodeFoldingEnabled()
```
    Returns whether code folding is enabled. Note that only certain languages support code folding; those that do not will ignore this property.
    
    返回:
    Whether code folding is enabled.
    另请参阅:
    setCodeFoldingEnabled(boolean)
  - isCodeFoldingSupportedAndEnabled
```
public boolean isCodeFoldingSupportedAndEnabled()
```
    Returns true if and only if code folding is enabled for this text area, AND folding is supported for the language it is editing. Whether or not folding is supported for a language depends on whether a fold parser is registered for that language with the FoldParserManager.
    
    返回:
    Whether folding is supported and enabled for this text area.
    另请参阅:
    FoldParserManager
  - isFoldStartLine
```
public boolean isFoldStartLine(int line)
```
    Returns whether the specified line contains the start of a fold region.
    
    参数:
    line - The line.
    
    返回:
    Whether the line contains the start of a fold region.
    另请参阅:
    getFoldForLine(int)
  - isLineHidden
```
public boolean isLineHidden(int line)
```
    Returns whether a line is hidden in a collapsed fold.
    
    参数:
    line - The line to check.
    
    返回:
    Whether the line is hidden in a collapsed fold.
  - removePropertyChangeListener
```
public void removePropertyChangeListener(java.beans.PropertyChangeListener l)
```
    Removes a property change listener from this fold manager.
    
    参数:
    l - The listener to remove.
    另请参阅:
    addPropertyChangeListener(PropertyChangeListener)
  - reparse
```
public void reparse()
```
    Forces an immediate reparsing for folds, if folding is enabled. This usually does not need to be called by the programmer, since fold parsing is done automatically by RSTA.
  - setCodeFoldingEnabled
```
public void setCodeFoldingEnabled(boolean enabled)
```
    Sets whether code folding is enabled. Note that only certain languages will support code folding out of the box. Those languages which do not support folding will ignore this property.
    
    参数:
    enabled - Whether code folding should be enabled.
    另请参阅:
    isCodeFoldingEnabled()
  - setFolds
```
public void setFolds(java.util.List<Fold> folds)
```
    Sets the folds for this fold manager.
    
    参数:
    folds - The new folds. This should not be null.

类 FoldManager

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

PROPERTY_FOLDS_UPDATED

构造器详细资料

FoldManager

方法详细资料

addPropertyChangeListener

clear

ensureOffsetNotInClosedFold

getDeepestFoldContaining

getDeepestOpenFoldContaining

getFold

getFoldCount

getFoldForLine

getHiddenLineCount

getHiddenLineCountAbove

getHiddenLineCountAbove

getLastVisibleLine

getVisibleLineAbove

getVisibleLineBelow

isCodeFoldingEnabled

isCodeFoldingSupportedAndEnabled

isFoldStartLine

isLineHidden

removePropertyChangeListener

reparse

setCodeFoldingEnabled

setFolds