Package net.sf.paperclips
Interface GridMargins
public interface GridMargins
An interface for informing a GridPrint what cell margins to use for the
GridLook.
- Author:
- Matthew Hall
-
Method Summary
Modifier and TypeMethodDescriptionintgetBodyBottom(boolean footerPresent, boolean open) Returns the margin, in pixels, at the bottom of the body cells.intgetBodyTop(boolean headerPresent, boolean open) Returns the margin, in pixels, at the top of the body cells.intReturns the vertical spacing, in pixels, between rows in the body.intReturns the margin, in pixels, at the bottom of the footer cells.intReturns the vertical spacing, in pixels, between rows in the footer.intReturns the margin, in pixels, at the top of the header cells.intReturns the vertical spacing, in pixels, between rows in the header.intReturns the horizontal spacing, in pixels, between grid cells.intgetLeft()Returns the margin, in pixels, at the left side of the grid.intgetRight()Returns the margin, in pixels, at the right side of the grid.
-
Method Details
-
getLeft
int getLeft()Returns the margin, in pixels, at the left side of the grid.- Returns:
- the margin, in pixels, at the left side of the grid.
-
getHorizontalSpacing
int getHorizontalSpacing()Returns the horizontal spacing, in pixels, between grid cells.- Returns:
- the horizontal spacing, in pixels, between grid cells.
-
getRight
int getRight()Returns the margin, in pixels, at the right side of the grid.- Returns:
- the margin, in pixels, at the right side of the grid.
-
getHeaderTop
int getHeaderTop()Returns the margin, in pixels, at the top of the header cells. If a grid has no header cells, this value is ignored.- Returns:
- the margin, in pixels, at the top of the header cells.
-
getHeaderVerticalSpacing
int getHeaderVerticalSpacing()Returns the vertical spacing, in pixels, between rows in the header.- Returns:
- the vertical spacing, in pixels, between rows in the header.
-
getBodyTop
int getBodyTop(boolean headerPresent, boolean open) Returns the margin, in pixels, at the top of the body cells. If a header is present, this is the spacing, in pixels, between the last header row and the first body row. If a header is not present, this is the margin, in pixels, at the top of the grid.- Parameters:
headerPresent- whether a header is present.open- whether the top row of body cells are "open." That is, whether the top row was started on a previous page and is continuing on this page. A GridLook may choose to show a visual indication for cells that were "opened" on previous pages.- Returns:
- the margin, in pixels, at the top of the body cells.
-
getBodyVerticalSpacing
int getBodyVerticalSpacing()Returns the vertical spacing, in pixels, between rows in the body.- Returns:
- the vertical spacing, in pixels, between rows in the body.
-
getBodyBottom
int getBodyBottom(boolean footerPresent, boolean open) Returns the margin, in pixels, at the bottom of the body cells. If a footer is present, this is the spacing, in pixels, between the last body row and the first footer row. If a header is not present, this is the margin, in pixels, at the bottom of the grid.- Parameters:
footerPresent- whether a footer is present.open- whether the bottom row of body cells are "open." That is, whether the bottom row still has more content to display on the next page. A GridLook may choose to show a visual indication for cells that will be "continued" on the next page.- Returns:
- the margin, in pixels, at the bottom of the body cells.
-