Package com.intellij.openapi.editor.impl

Class FoldRegionImpl

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.openapi.editor.impl.RangeMarkerImpl

com.intellij.openapi.editor.impl.FoldRegionImpl

All Implemented Interfaces:

RangeMarkerEx, FoldRegion, RangeMarker, Getter<com.intellij.openapi.editor.impl.RangeMarkerWithGetterImpl>, Segment, UserDataHolder, UserDataHolderEx

public class FoldRegionImpl
extends RangeMarkerImpl
implements FoldRegion

Field Summary

Fields inherited from interface com.intellij.openapi.editor.FoldRegion

EMPTY_ARRAY

Fields inherited from interface com.intellij.openapi.editor.RangeMarker

BY_START_OFFSET

Fields inherited from interface com.intellij.openapi.util.Segment

BY_START_OFFSET_THEN_END_OFFSET

Method Summary

Modifier and Type	Method and Description
boolean	areInnerHighlightersMuted()
protected void	changedUpdateImpl(DocumentEvent e)
void	dispose()
com.intellij.openapi.editor.impl.RangeMarkerWithGetterImpl	get()
Editor	getEditor()
FoldingGroup	getGroup()
java.lang.String	getPlaceholderText() Returns the placeholder text displayed when the fold region is collapsed.
boolean	isExpanded() Checks if the fold region is currently expanded.
boolean	isGutterMarkEnabledForSingleLine()
boolean	isValid() Checks if the marker has been invalidated by deleting the entire fragment of text containing the marker.
protected void	onReTarget(DocumentEvent e)
void	setExpanded(boolean expanded) Expands or collapses the fold region.
void	setGutterMarkEnabledForSingleLine(boolean value) By default, gutter mark (for collapsing/expanding the region using mouse) is not shown for a folding region, if it's contained within a single document line.
void	setInnerHighlightersMuted(boolean value) If inner highlighters are muted for a collapsed fold region, there will be no visual indication that region contains certain highlighters inside.
void	setPlaceholderText(java.lang.String text) Updates region's placeholder text.
boolean	shouldNeverExpand() If true, this region is always in a collapsed state, FoldRegion.setExpanded(boolean) does nothing for it.
java.lang.String	toString()

Methods inherited from class com.intellij.openapi.editor.impl.RangeMarkerImpl

documentChanged, findRangeMarkerAfter, findRangeMarkerBefore, getDocument, getEndOffset, getId, getLayer, getStartOffset, intervalEnd, intervalStart, isGreedyToLeft, isGreedyToRight, registerInTree, setGreedyToLeft, setGreedyToRight, setValid, unregisterInTree

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

changeUserMap, clearUserData, clone, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.intellij.openapi.editor.RangeMarker

getDocument, getEndOffset, getStartOffset, isGreedyToLeft, isGreedyToRight, setGreedyToLeft, setGreedyToRight

Methods inherited from interface com.intellij.openapi.util.UserDataHolder

getUserData, putUserData

Method Detail

isExpanded

public boolean isExpanded()

Description copied from interface: FoldRegion

Checks if the fold region is currently expanded.

Specified by:

isExpanded in interface FoldRegion

Returns:

true if the fold region is expanded, false otherwise.

setExpanded

public void setExpanded(boolean expanded)

Description copied from interface: FoldRegion

Expands or collapses the fold region.

Specified by:

setExpanded in interface FoldRegion

Parameters:

expanded - true if the region should be expanded, false otherwise.

isValid

public boolean isValid()

Description copied from interface: RangeMarker

Checks if the marker has been invalidated by deleting the entire fragment of text containing the marker.

Specified by:

isValid in interface RangeMarker

Overrides:

isValid in class RangeMarkerImpl

Returns:

true if the marker is valid, false if it has been invalidated.

getPlaceholderText

public java.lang.String getPlaceholderText()

Description copied from interface: FoldRegion

Returns the placeholder text displayed when the fold region is collapsed.

Specified by:

getPlaceholderText in interface FoldRegion

Returns:

the placeholder text.

getEditor

public Editor getEditor()

Specified by:

getEditor in interface FoldRegion

getGroup

public FoldingGroup getGroup()

Specified by:

getGroup in interface FoldRegion

shouldNeverExpand

public boolean shouldNeverExpand()

Description copied from interface: FoldRegion

If true, this region is always in a collapsed state, FoldRegion.setExpanded(boolean) does nothing for it. No marker is displayed in gutter for such a region.

Specified by:

shouldNeverExpand in interface FoldRegion

See Also:

FoldingModelEx.createFoldRegion(int, int, String, FoldingGroup, boolean)

changedUpdateImpl

protected void changedUpdateImpl(DocumentEvent e)

Overrides:

changedUpdateImpl in class RangeMarkerImpl

onReTarget

protected void onReTarget(DocumentEvent e)

Overrides:

onReTarget in class RangeMarkerImpl

setInnerHighlightersMuted

public void setInnerHighlightersMuted(boolean value)

Description copied from interface: FoldRegion

If inner highlighters are muted for a collapsed fold region, there will be no visual indication that region contains certain highlighters inside. By default such indication is added.

Specified by:

setInnerHighlightersMuted in interface FoldRegion

See Also:

RangeHighlighterEx.isVisibleIfFolded()

areInnerHighlightersMuted

public boolean areInnerHighlightersMuted()

Specified by:

areInnerHighlightersMuted in interface FoldRegion

See Also:

FoldRegion.setInnerHighlightersMuted(boolean)

setGutterMarkEnabledForSingleLine

public void setGutterMarkEnabledForSingleLine(boolean value)

Description copied from interface: FoldRegion

By default, gutter mark (for collapsing/expanding the region using mouse) is not shown for a folding region, if it's contained within a single document line. This method allows to change this behaviour for given fold region.

Specified by:

setGutterMarkEnabledForSingleLine in interface FoldRegion

See Also:

FoldRegion.isGutterMarkEnabledForSingleLine(), EditorSettings.setAllowSingleLogicalLineFolding(boolean)

isGutterMarkEnabledForSingleLine

public boolean isGutterMarkEnabledForSingleLine()

Specified by:

isGutterMarkEnabledForSingleLine in interface FoldRegion

See Also:

FoldRegion.setGutterMarkEnabledForSingleLine(boolean)

setPlaceholderText

public void setPlaceholderText(java.lang.String text)

Description copied from interface: FoldRegion

Updates region's placeholder text. Should be called inside FoldingModel.runBatchFoldingOperation(Runnable), like any other operations with fold regions.

Specified by:

setPlaceholderText in interface FoldRegion

dispose

public void dispose()

Specified by:

dispose in interface RangeMarker

Overrides:

dispose in class RangeMarkerImpl

toString

public java.lang.String toString()

Overrides:

toString in class RangeMarkerImpl

get

public final com.intellij.openapi.editor.impl.RangeMarkerWithGetterImpl get()

Specified by:

get in interface Getter<com.intellij.openapi.editor.impl.RangeMarkerWithGetterImpl>