org.eclipse.nebula.paperclips.core.grid

Interface GridLookPainter

All Known Implementing Classes:

BasicGridLookPainter, DefaultGridLookPainter

public interface GridLookPainter

Interface for drawing a GridLook.

Method Summary

Modifier and Type	Method and Description
void	dispose() Disposes the system resources allocated by this GridLookPainter.
GridMargins	getMargins() Returns the grid margins used for the GridLook.
void	paint(org.eclipse.swt.graphics.GC gc, int x, int y, int[] columns, int[] headerRows, int[][] headerColSpans, int firstRowIndex, boolean topOpen, int[] bodyRows, int[][] bodyColSpans, boolean bottomOpen, int[] footerRows, int[][] footerColSpans) Paints the grid look onto the GC.

Method Detail

getMargins

GridMargins getMargins()

Returns the grid margins used for the GridLook.

Returns:

the grid margins used for the GridLook.

See Also:

GridMargins

paint

void paint(org.eclipse.swt.graphics.GC gc,
           int x,
           int y,
           int[] columns,
           int[] headerRows,
           int[][] headerColSpans,
           int firstRowIndex,
           boolean topOpen,
           int[] bodyRows,
           int[][] bodyColSpans,
           boolean bottomOpen,
           int[] footerRows,
           int[][] footerColSpans)

Paints the grid look onto the GC.

Parameters:

gc - the graphics context to paint on.

x - the x coordinate of the top-left of the grid.

y - the y coordinate of the top-left of the grid.

columns - the column widths. The left and right margins of each cell are included in the column widths.

headerRows - the header row heights.

headerColSpans - a two-dimensional array of cell spans in the header. Each element in the outer array is a header row. Each element of an inner array is a cell, where the element value indicates how many columns the cell spans.

firstRowIndex - the zero-based index of the first row displayed on the page.

topOpen - whether the top body row should be drawn with the top edge of the cell border "open." An open top border is a visual indication that the top row is being continued from the previous page.

bodyRows - the body row heights.

bodyColSpans - a two-dimensional array of cell spans in the body. Each element in the outer array is a body row. Each element of an inner array is a cell, where the element value indicates how many columns the cell spans.

bottomOpen - whether the bottom body row should be drawn with the bottom edge of the cell border "open." An open bottom border is a visual indication that the bottom row will be continued on the next page.

footerRows - the footer row heights.

footerColSpans - a two-dimensional array of cell spans in the footer. Each element in the outer array is a footer row. Each element of an inner array is a cell, where the element value indicates how many columns the cell spans.

dispose

void dispose()

Disposes the system resources allocated by this GridLookPainter. The dispose method is not a permanent disposal of a GridLookPainter. It is intended to reclaim system resources, however future calls to paint(GC,int,int) may require that the resources be allocated again.