com.cete.dynamicpdf.pageelements
Class LayoutGrid

java.lang.Object
  com.cete.dynamicpdf.PageElement
      com.cete.dynamicpdf.pageelements.LayoutGrid

public class LayoutGrid
extends PageElement

This class can be used to place a grid on the entire page. This grid is very helpful with the design and layout of the document.

Licensing:
This class is a DynamicPDF Generator Community Edition feature.

View Example

Constructor Summary

LayoutGrid()
Creates a new instance of LayoutGrid.

LayoutGrid(boolean showTitle)
Creates a new instance of LayoutGrid.

LayoutGrid(GridType type)
Creates a new instance of LayoutGrid.

LayoutGrid(GridType type, boolean showTitle)
Creates a new instance of LayoutGrid.

Method Summary

void	draw(PageWriter writer) Draws the layout grid to the given PageWriter object.
boolean	getTitle() Gets the option to display the title on LayoutGrid.
GridType	getType() Gets the style of grid.
void	setTitle(boolean showTitle) Sets the option to display the title on LayoutGrid.
void	setType(GridType value) Sets the style of grid.

Methods inherited from class com.cete.dynamicpdf.PageElement

getRequiredLicenseLevel, getStrID, setRequiredLicenseLevel, setStrID

Methods inherited from class java.lang.Object

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

Constructor Detail

LayoutGrid

public LayoutGrid()

Creates a new instance of LayoutGrid.

See Also:

LayoutGrid

LayoutGrid

public LayoutGrid(boolean showTitle)

Creates a new instance of LayoutGrid.

Parameters:

showTitle - This value specifies whether or not to display the grid's title information.

See Also:

LayoutGrid

LayoutGrid

public LayoutGrid(GridType type)

Creates a new instance of LayoutGrid.

Parameters:

type - Type of grid to display.

See Also:

LayoutGrid

LayoutGrid

public LayoutGrid(GridType type,
                  boolean showTitle)

Creates a new instance of LayoutGrid.

Parameters:

type - Type of grid to display.

showTitle - This value specifies whether or not to display the grid's title information.

Method Detail

getType

public GridType getType()

Gets the style of grid.

Returns:

the style of grid.

setType

public void setType(GridType value)

Sets the style of grid.

Parameters:

value - the style of grid.

setTitle

public void setTitle(boolean showTitle)

Sets the option to display the title on LayoutGrid.

Parameters:

showTitle - the option to display the title on LayoutGrid.

getTitle

public boolean getTitle()

Gets the option to display the title on LayoutGrid.

Returns:

the option to display the title on LayoutGrid.

draw

public void draw(PageWriter writer)

Draws the layout grid to the given PageWriter object.

Specified by:

draw in class PageElement

Parameters:

writer - PageWriter object to receive the layout grid's output.

See Also:

PageWriter