Package ca.spatial.reportwriter

Class MapLayoutReport.Grid

java.lang.Object

ca.spatial.reportwriter.MapLayoutReport.MapElement

ca.spatial.reportwriter.MapLayoutReport.Group

ca.spatial.reportwriter.MapLayoutReport.Grid

Enclosing class:

MapLayoutReport

public class MapLayoutReport.Grid
extends MapLayoutReport.Group

The Grid element is a tool that helps to lay out elements in a rectangular grid. Specify the size of the grid layout, and the number and proportional size of the rows and column. The width of the rows and columns vary according to the width and height values that are specified. Panes are addressed by specifying the starting row and column number, as well as the number of rows and columns to join together. Once a pane has been defined, use any of the methods from the MapLayoutReport.Group class to add elements. Any number of elements can be added to each pane.

Method Summary

Modifier and Type	Method	Description
MapLayoutReport.Group	cell(int column, int row)	Deprecated.
MapLayoutReport.Group	cell(int column, int row, int numCols, int numRows)	Return a pane sized by the specified number of rows and columns.
MapLayoutReport.Group	pane(int column, int row)	Return a pane that is one row by one column, at the specified starting position.
MapLayoutReport.Group	pane(int column, int row, int numCols, int numRows)	Return a pane sized by the specified number of rows and columns.

Methods inherited from class ca.spatial.reportwriter.MapLayoutReport.Group

addCircle, addEllipse, addGrid, addGroup, addGroup, addLegend, addLegend, addLine, addMap, addNorthArrow, addRectangle, addReportChart, addReportChart, addReportTable, addReportTable, addRoundedRectangle, addScalebar, addScalebar, addText, addText, p, page, page, reverseToc

Methods inherited from class ca.spatial.reportwriter.MapLayoutReport.MapElement

background, bookmark, contentHeight, contentWidth, getBackground, getHeight, getWidth, hidden, inset, margin, neatline, r, simplistHeight, simplistWidth, subtype, top, visible, zoom

Methods inherited from class java.lang.Object

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

Method Details

pane

public MapLayoutReport.Group pane(int column,
 int row)

Return a pane that is one row by one column, at the specified starting position.

Parameters:

row - The row position in the grid, with the index starting at 0

column - The column position in the grid, with the index starting at 0

pane

public MapLayoutReport.Group pane(int column,
 int row,
 int numCols,
 int numRows)

Return a pane sized by the specified number of rows and columns.

Parameters:

row - The row position in the grid, with the index starting at 0

column - The column position in the grid, with the index starting at 0

numRows - the number of rows that make up the requested pane.

numCols - the number of columns that make up the requested pane.

cell

@Deprecated
public MapLayoutReport.Group cell(int column,
 int row)

Deprecated.

Return a pane that is one row by one column, at the specified starting position.

Parameters:

column - The column position in the grid, with the index starting at 0

row - The row position in the grid, with the index starting at 0

cell

public MapLayoutReport.Group cell(int column,
 int row,
 int numCols,
 int numRows)

Return a pane sized by the specified number of rows and columns.

Parameters:

column - The column position in the grid, with the index starting at 0

row - The row position in the grid, with the index starting at 0

numRows - the number of rows that make up the requested pane.

numCols - the number of columns that make up the requested pane.