Package com.intellij.psi.impl.source.tree.injected

Class FoldingRegionWindow

java.lang.Object

com.intellij.psi.impl.source.tree.injected.FoldingRegionWindow

All Implemented Interfaces:

RangeMarkerEx, FoldRegion, RangeMarker, Segment, UserDataHolder

public class FoldingRegionWindow
extends java.lang.Object
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
void	dispose()
void	documentChanged(DocumentEvent e)
FoldRegionImpl	getDelegate()
Document	getDocument() Returns the document to which the marker belongs.
Editor	getEditor()
int	getEndOffset() Returns the end offset of the text range covered by the marker.
FoldingGroup	getGroup()
long	getId()
static FoldingRegionWindow	getInjectedRegion(FoldRegion hostRegion)
java.lang.String	getPlaceholderText() Returns the placeholder text displayed when the fold region is collapsed.
int	getStartOffset() Returns the start offset of the text range covered by the marker.
<T> T	getUserData(Key<T> key)
boolean	isExpanded() Checks if the fold region is currently expanded.
boolean	isGreedyToLeft()
boolean	isGreedyToRight()
boolean	isGutterMarkEnabledForSingleLine()
boolean	isValid() Checks if the marker has been invalidated by deleting the entire fragment of text containing the marker.
<T> void	putUserData(Key<T> key, T value) Add a new user data value to this object.
void	setExpanded(boolean expanded) Expands or collapses the fold region.
void	setGreedyToLeft(boolean greedy) Sets the value indicating whether the text added exactly at the beginning of the marker should be included in the text range of the marker.
void	setGreedyToRight(boolean greedy) Sets the value indicating whether the text added exactly at the end of the marker should be included in the text range of the marker.
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	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 java.lang.Object

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

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

areInnerHighlightersMuted, setInnerHighlightersMuted

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

dispose, getDocument, getEndOffset, getStartOffset, isGreedyToLeft, isGreedyToRight, isValid, 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.

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)

getDelegate

public FoldRegionImpl getDelegate()

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

getInjectedRegion

public static FoldingRegionWindow getInjectedRegion(FoldRegion hostRegion)

getDocument

public Document getDocument()

Description copied from interface: RangeMarker

Returns the document to which the marker belongs.

Specified by:

getDocument in interface RangeMarker

Returns:

the document instance.

getStartOffset

public int getStartOffset()

Description copied from interface: RangeMarker

Returns the start offset of the text range covered by the marker.

Specified by:

getStartOffset in interface RangeMarker

Specified by:

getStartOffset in interface Segment

Returns:

the start offset.

getEndOffset

public int getEndOffset()

Description copied from interface: RangeMarker

Returns the end offset of the text range covered by the marker.

Specified by:

getEndOffset in interface RangeMarker

Specified by:

getEndOffset in interface Segment

Returns:

the end offset.

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

Returns:

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

setGreedyToLeft

public void setGreedyToLeft(boolean greedy)

Description copied from interface: RangeMarker

Sets the value indicating whether the text added exactly at the beginning of the marker should be included in the text range of the marker. The default value is false.

Specified by:

setGreedyToLeft in interface RangeMarker

Parameters:

greedy - true if text added at the beginning is included in the range, false otherwise.

setGreedyToRight

public void setGreedyToRight(boolean greedy)

Description copied from interface: RangeMarker

Sets the value indicating whether the text added exactly at the end of the marker should be included in the text range of the marker. The default value is false.

Specified by:

setGreedyToRight in interface RangeMarker

Parameters:

greedy - true if text added at the end is included in the range, false otherwise.

getUserData

public <T> T getUserData(Key<T> key)

Specified by:

getUserData in interface UserDataHolder

Returns:

a user data value associated with this object. Doesn't require read action.

putUserData

public <T> void putUserData(Key<T> key,
                            T value)

Description copied from interface: UserDataHolder

Add a new user data value to this object. Doesn't require write action.

Specified by:

putUserData in interface UserDataHolder

documentChanged

public void documentChanged(DocumentEvent e)

Specified by:

documentChanged in interface RangeMarkerEx

getId

public long getId()

Specified by:

getId in interface RangeMarkerEx

isGreedyToRight

public boolean isGreedyToRight()

Specified by:

isGreedyToRight in interface RangeMarker

isGreedyToLeft

public boolean isGreedyToLeft()

Specified by:

isGreedyToLeft in interface RangeMarker

dispose

public void dispose()

Specified by:

dispose in interface RangeMarker

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object