org.jplot2d.element

Interface PlotMargin

All Superinterfaces:

Element

All Known Subinterfaces:

PlotMarginEx

All Known Implementing Classes:

PlotMarginImpl

public interface PlotMargin
extends Element

Subplot has a content area in the center, surrounded by margin area. The margin area holds axes, title and legend. Besides the margin, there are also extra margins. The extra margin plus the margin will be the total margin.

Method Summary

Modifier and Type	Method and Description
double	getBottom() Returns the actual margin value.
double	getExtraBottom() Returns the extra bottom margin.
double	getExtraLeft() Returns the extra left margin.
double	getExtraRight() Returns the extra right margin.
double	getExtraTop() Returns the extra top margin.
double	getLeft() Returns the actual margin value.
double	getRight() Returns the actual margin value.
double	getTop() Returns the actual margin value.
boolean	isAutoBottom() Returns true if the margin is a auto chose nice value.
boolean	isAutoLeft() Returns true if the margin is a auto chose nice value.
boolean	isAutoRight() Returns true if the margin is a auto chose nice value.
boolean	isAutoTop() Returns true if the margin is a auto chose nice value.
void	setAutoBottom(boolean auto) Set to true to let layout director to choose a nice value.
void	setAutoLeft(boolean auto) Set to true to let layout director to choose a nice value.
void	setAutoRight(boolean auto) Set to true to let layout director to choose a nice value.
void	setAutoTop(boolean auto) Set to true to let layout director to choose a nice value.
void	setBottom(double marginBottom) Sets the bottom margin value.
void	setExtraBottom(double marginBottom) Sets the extra bottom margin.
void	setExtraLeft(double marginLeft) Sets the extra left margin.
void	setExtraRight(double marginRight) Sets the extra right margin.
void	setExtraTop(double marginTop) Sets the extra top margin.
void	setLeft(double marginLeft) Sets the left margin value.
void	setRight(double marginRight) Sets the right margin value.
void	setTop(double marginTop) Sets the top margin value.

Methods inherited from interface org.jplot2d.element.Element

getEnvironment, getId, getParent

Method Detail

isAutoLeft

boolean isAutoLeft()

Returns true if the margin is a auto chose nice value.

Returns:

true if the margin is a auto chose nice value

isAutoRight

boolean isAutoRight()

Returns true if the margin is a auto chose nice value.

Returns:

true if the margin is a auto chose nice value

isAutoBottom

boolean isAutoBottom()

Returns true if the margin is a auto chose nice value.

Returns:

true if the margin is a auto chose nice value

isAutoTop

boolean isAutoTop()

Returns true if the margin is a auto chose nice value.

Returns:

true if the margin is a auto chose nice value

setAutoLeft

void setAutoLeft(boolean auto)

Set to true to let layout director to choose a nice value. If set to false, user must supply the margin value by setLeft(double).

Parameters:

auto - the flag

setAutoRight

void setAutoRight(boolean auto)

Set to true to let layout director to choose a nice value. If set to false, user must supply the margin value by setRight(double).

Parameters:

auto - the flag

setAutoBottom

void setAutoBottom(boolean auto)

Set to true to let layout director to choose a nice value. If set to false, user must supply the margin value by setBottom(double).

Parameters:

auto - the flag

setAutoTop

void setAutoTop(boolean auto)

Set to true to let layout director to choose a nice value. If set to false, user must supply the margin value by setTop(double).

Parameters:

auto - the flag

getLeft

double getLeft()

Returns the actual margin value.

Returns:

the actual margin value

getRight

double getRight()

Returns the actual margin value.

Returns:

the actual margin value

getBottom

double getBottom()

Returns the actual margin value.

Returns:

the actual margin value

getTop

double getTop()

Returns the actual margin value.

Returns:

the actual margin value

setLeft

void setLeft(double marginLeft)

Sets the left margin value. Setting a new value will disable auto margin calculation and make isAutoLeft() returns false.

Parameters:

marginLeft -

setRight

void setRight(double marginRight)

Sets the right margin value. Setting a new value will disable auto margin calculation and make isAutoRight() returns false.

Parameters:

marginRight -

setBottom

void setBottom(double marginBottom)

Sets the bottom margin value. Setting a new value will disable auto margin calculation and make isAutoBottom() returns false.

Parameters:

marginBottom -

setTop

void setTop(double marginTop)

Sets the top margin value. Setting a new value will disable auto margin calculation and make isAutoTop() returns false.

Parameters:

marginTop -

getExtraLeft

double getExtraLeft()

Returns the extra left margin.

Returns:

the extra left margin

getExtraRight

double getExtraRight()

Returns the extra right margin.

Returns:

the extra right margin

getExtraBottom

double getExtraBottom()

Returns the extra bottom margin.

Returns:

the extra bottom margin

getExtraTop

double getExtraTop()

Returns the extra top margin.

Returns:

the extra top margin

setExtraLeft

void setExtraLeft(double marginLeft)

Sets the extra left margin.

Parameters:

marginTop - the extra left margin

setExtraRight

void setExtraRight(double marginRight)

Sets the extra right margin.

Parameters:

marginTop - the extra right margin

setExtraBottom

void setExtraBottom(double marginBottom)

Sets the extra bottom margin.

Parameters:

marginTop - the extra bottom margin

setExtraTop

void setExtraTop(double marginTop)

Sets the extra top margin.

Parameters:

marginTop - the extra top margin