com.miginfocom.calendar.grid
Interface GridLineProvider

All Known Implementing Classes:
DefaultGridLineProvider, GridLineSpecification, SubRowGridLineProvider

public interface GridLineProvider

A special RepetitionSpec that returns GridLineRepetitions. I short it's a collection of GridLineRepetitions that should cover all indexes for a given range.


Method Summary
 int configureGridLines(GridRow[] rows, GridLine[] gridLines)
          Configures the grid lines.
 GridLine[] createGridLines(GridRow[] rows)
          Returns the grid lines between and around the rows.
 int getGridLinesSize(GridRow[] rows)
          Returns the total size of the grid lines for the given rows.
 

Method Detail

createGridLines

GridLine[] createGridLines(GridRow[] rows)
Returns the grid lines between and around the rows.

Parameters:
rows - The rows to have the grid lines around.
Returns:
The grid lines for decorating around the grid rows. Always one more that the row count.

configureGridLines

int configureGridLines(GridRow[] rows,
                       GridLine[] gridLines)
Configures the grid lines.

Parameters:
rows - Some rows for which grid lines has previously been created with this provider.
gridLines - The grid lines to configure.
Returns:
The size of the grid lines.

getGridLinesSize

int getGridLinesSize(GridRow[] rows)
Returns the total size of the grid lines for the given rows.

If the same rows are passed into createGridLines(GridRow[]) those's size must be the same as the returned size from this method.

Parameters:
rows - The rows.
Returns:
The total size of the grid lines.


Copyright © 2009 MiG InfoCom AB. All Rights Reserved.