oracle.javatools.editor.folding

Class DefaultFoldingBlock<B extends DefaultFoldingBlock,U>

java.lang.Object

oracle.javatools.editor.folding.AbstractFoldingBlock<B>

oracle.javatools.editor.folding.DefaultFoldingBlock<B,U>

All Implemented Interfaces:

FoldingBlock<B>

public class DefaultFoldingBlock<B extends DefaultFoldingBlock,U>
extends AbstractFoldingBlock<B>

A general-purpose implementation describing a collapsible source code block in the code editor.

Since:

10.1.3

Constructor Summary

Constructors

Constructor and Description
DefaultFoldingBlock()
DefaultFoldingBlock(int startOffset, int endOffset)
DefaultFoldingBlock(int startOffset, int endOffset, java.lang.String replacement)
DefaultFoldingBlock(int startOffset, int endOffset, java.lang.String replacement, boolean isExpanded)

Method Summary

Modifier and Type	Method and Description
int	getEndOffset() Returns the ending caret offset of this source code block.
java.lang.String	getReplacementText() Returns the abbreviated text used to represent this source code block in the code editor when the block is collapsed.
int	getStartOffset() Returns the starting caret offset of this source code block.
U	getUserObject()
void	setEndOffset(int endOffset)
void	setReplacementText(java.lang.String replacement)
void	setStartOffset(int startOffset)
void	setUserObject(U userObject)

Methods inherited from class oracle.javatools.editor.folding.AbstractFoldingBlock

add, bounds, getChildCount, getChildren, getParent, isExpanded, length, remove, removeAll, setExpanded, setParent

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultFoldingBlock

public DefaultFoldingBlock()

DefaultFoldingBlock

public DefaultFoldingBlock(int startOffset,
                           int endOffset)

DefaultFoldingBlock

public DefaultFoldingBlock(int startOffset,
                           int endOffset,
                           java.lang.String replacement)

DefaultFoldingBlock

public DefaultFoldingBlock(int startOffset,
                           int endOffset,
                           java.lang.String replacement,
                           boolean isExpanded)

Method Detail

getStartOffset

public int getStartOffset()

Description copied from interface: FoldingBlock

Returns the starting caret offset of this source code block.

Specified by:

getStartOffset in interface FoldingBlock<B extends DefaultFoldingBlock>

Specified by:

getStartOffset in class AbstractFoldingBlock<B extends DefaultFoldingBlock>

Returns:

the starting caret offset of the block

setStartOffset

public void setStartOffset(int startOffset)

getEndOffset

public int getEndOffset()

Description copied from interface: FoldingBlock

Returns the ending caret offset of this source code block.

Specified by:

getEndOffset in interface FoldingBlock<B extends DefaultFoldingBlock>

Specified by:

getEndOffset in class AbstractFoldingBlock<B extends DefaultFoldingBlock>

Returns:

the ending caret offset of the block

setEndOffset

public void setEndOffset(int endOffset)

getReplacementText

public java.lang.String getReplacementText()

Description copied from interface: FoldingBlock

Returns the abbreviated text used to represent this source code block in the code editor when the block is collapsed.

Specified by:

getReplacementText in interface FoldingBlock<B extends DefaultFoldingBlock>

Specified by:

getReplacementText in class AbstractFoldingBlock<B extends DefaultFoldingBlock>

Returns:

the abbreviated replacement text for the block

setReplacementText

public void setReplacementText(java.lang.String replacement)

getUserObject

public U getUserObject()

setUserObject

public void setUserObject(U userObject)