com.qoppa.pdfNotes

Class GridSettings

java.lang.Object

com.qoppa.pdfNotes.GridSettings

public class GridSettings
extends Object

This class holds information about the grid including the color, number of subdivisions, offset from the top and left, and spacing between major grid lines.

Author:

Qoppa Software

Constructor Summary

Constructors

Constructor and Description
GridSettings() Construct a GridSettings objects with all values set to default.
GridSettings(int units) Construct a GridSettings objects and set the value of units to either RulerSettings.UNIT_INCHES or RulerSettings.UNIT_CENTIMETERS

Method Summary

Modifier and Type	Method and Description
Color	getColor() Get the color of the grid lines.
double	getHorizontalSpacing() Get the number of inches or centimeters between vertical grid lines.
double	getLeftOffset() Get the distance from the left side of the page where vertical grid lines will begin.
int	getSubDivisions() Get the number of subdivisions between major grid lines.
double	getTopOffset() Get the distance from the top of the page where horizontal grid lines will begin.
int	getUnits() Returns the units that this grid is using when displaying.
double	getVerticalSpacing() Get the number of inches or centimeters between horizontal grid lines.
void	setColor(Color color) Set the new color of the grid lines.
void	setHorizontalSpacing(double divisionWidth) Set the number of inches or centimeters between vertical grid lines.
void	setLeftOffset(double offsetLeft) Set the distance from the left side of the page where vertical grid lines will begin.
void	setSubDivisions(int subDivisions) Set the number of subdivisions between major grid lines.
void	setTopOffset(double offsetTop) Set the distance from the top of the page where horizontal grid lines will begin.
void	setUnits(int units) Sets the units to use when displaying the grid.
void	setVerticalSpacing(double divisionHeight) Set the number of inches or centimeters between horizontal grid lines.

Methods inherited from class java.lang.Object

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

Constructor Detail

GridSettings

public GridSettings()

Construct a GridSettings objects with all values set to default.

GridSettings

public GridSettings(int units)

Construct a GridSettings objects and set the value of units to either RulerSettings.UNIT_INCHES or RulerSettings.UNIT_CENTIMETERS

Method Detail

getColor

public Color getColor()

Get the color of the grid lines.

Returns:

grid color

getVerticalSpacing

public double getVerticalSpacing()

Get the number of inches or centimeters between horizontal grid lines.

Returns:

inches or centimeters between horizontal grid lines.

getHorizontalSpacing

public double getHorizontalSpacing()

Get the number of inches or centimeters between vertical grid lines.

Returns:

inches or centimeters between vertical grid lines.

getLeftOffset

public double getLeftOffset()

Get the distance from the left side of the page where vertical grid lines will begin.

Returns:

distance from the left side of the page where vertical grid lines will begin.

getTopOffset

public double getTopOffset()

Get the distance from the top of the page where horizontal grid lines will begin.

Returns:

distance from the top of the page where horizontal grid lines will begin.

getSubDivisions

public int getSubDivisions()

Get the number of subdivisions between major grid lines.

Returns:

subdivisions between major grid lines.

setColor

public void setColor(Color color)

Set the new color of the grid lines.

Parameters:

color - the new color of the grid lines.

setVerticalSpacing

public void setVerticalSpacing(double divisionHeight)

Set the number of inches or centimeters between horizontal grid lines.

Parameters:

divisionHeight - inches or centimeters between horizontal grid lines.

setHorizontalSpacing

public void setHorizontalSpacing(double divisionWidth)

Set the number of inches or centimeters between vertical grid lines.

Parameters:

divisionWidth - inches or centimeters between vertical grid lines.

setUnits

public void setUnits(int units)

Sets the units to use when displaying the grid. This value should be RulerSettings.UNIT_INCHES or RulerSettings.UNIT_CENTIMETERS

Parameters:

units -

getUnits

public int getUnits()

Returns the units that this grid is using when displaying.

Returns:

The current ruler units.

setLeftOffset

public void setLeftOffset(double offsetLeft)

Set the distance from the left side of the page where vertical grid lines will begin.

Parameters:

offsetLeft - the distance from the left side of the page where vertical grid lines will begin.

setTopOffset

public void setTopOffset(double offsetTop)

Set the distance from the top of the page where horizontal grid lines will begin.

Parameters:

offsetTop - the distance from the top of the page where horizontal grid lines will begin.

setSubDivisions

public void setSubDivisions(int subDivisions)

Set the number of subdivisions between major grid lines.

Parameters:

subDivisions - the number of subdivisions between major grid lines.