com.jidesoft.editor.margin
Interface CodeFoldingPainter

All Known Implementing Classes:

DefaultCodeFoldingPainter

public interface CodeFoldingPainter

A painter interface to paint the code folding.

Method Summary

int	getPreferredWidth() Gets preferred width.
void	paintBackground(Component c, Graphics g, Rectangle rect) Paints the background of the code folding area.
void	paintCollapsedFolding(Component c, Graphics g, Span span, Rectangle rect, int state) Paints the collapsed folding.
void	paintExpandedFolding(Component c, Graphics g, Span span, Rectangle rect, int state) Paints the expanded folding.
int	paintFoldingEnd(Component c, Graphics g, Span span, Rectangle rect, int state) Paints the end of the folding.
void	paintFoldingLine(Component c, Graphics g, Span span, Rectangle rect, int state) Paints the folding line between the start and the end of the folding.
int	paintFoldingStart(Component c, Graphics g, Span span, Rectangle rect, int state) Paints the start of the folding.

Method Detail

paintFoldingStart

int paintFoldingStart(Component c,
                      Graphics g,
                      Span span,
                      Rectangle rect,
                      int state)

Paints the start of the folding.

Parameters:

c -

g -

span -

rect -

state -

Returns:

return the y value after the start of the folding is paint. paintFoldingLine method will use this y value as the starting point of the line.

paintFoldingEnd

int paintFoldingEnd(Component c,
                    Graphics g,
                    Span span,
                    Rectangle rect,
                    int state)

Paints the end of the folding.

Parameters:

c -

g -

span -

rect -

state -

Returns:

return the y value at where the end of the folding is painted. paintFoldingLine method will use this y value as the ending point of the line.

paintCollapsedFolding

void paintCollapsedFolding(Component c,
                           Graphics g,
                           Span span,
                           Rectangle rect,
                           int state)

Paints the collapsed folding.

Parameters:

c -

g -

span -

rect -

state -

paintExpandedFolding

void paintExpandedFolding(Component c,
                          Graphics g,
                          Span span,
                          Rectangle rect,
                          int state)

Paints the expanded folding.

Parameters:

c -

g -

span -

rect -

state -

paintFoldingLine

void paintFoldingLine(Component c,
                      Graphics g,
                      Span span,
                      Rectangle rect,
                      int state)

Paints the folding line between the start and the end of the folding.

Parameters:

c -

g -

span -

rect -

state -

paintBackground

void paintBackground(Component c,
                     Graphics g,
                     Rectangle rect)

Paints the background of the code folding area. It's for the whole code folding margin, not just for one code folding.

Parameters:

c -

g -

rect -

getPreferredWidth

int getPreferredWidth()

Gets preferred width.

Returns:

the preferred width.