org.jfree.chart.block

Class BlockBorder

Implemented Interfaces:
BlockFrame, Serializable

public class BlockBorder
extends java.lang.Object
implements BlockFrame, Serializable

A border for a block. This class is immutable.

Field Summary

static BlockBorder
NONE
An empty border.

Constructor Summary

BlockBorder()
Creates a default border.
BlockBorder(Paint paint)
Creates a new border with the specified color.
BlockBorder(RectangleInsets insets, Paint paint)
Creates a new border.
BlockBorder(double top, double left, double bottom, double right)
Creates a new border with the specified line widths (in black).
BlockBorder(double top, double left, double bottom, double right, Paint paint)
Creates a new border with the specified line widths (in black).

Method Summary

void
draw(Graphics2D g2, Rectangle2D area)
Draws the border by filling in the reserved space.
boolean
equals(Object obj)
Tests this border for equality with an arbitrary instance.
RectangleInsets
getInsets()
Returns the space reserved for the border.
Paint
getPaint()
Returns the paint used to draw the border.

Field Details

NONE

public static final BlockBorder NONE
An empty border.

Constructor Details

BlockBorder

public BlockBorder()
Creates a default border.

BlockBorder

public BlockBorder(Paint paint)
Creates a new border with the specified color.
Parameters:
paint - the color (null not permitted).

BlockBorder

public BlockBorder(RectangleInsets insets,
                   Paint paint)
Creates a new border.
Parameters:
insets - the border insets (null not permitted).
paint - the paint (null not permitted).

BlockBorder

public BlockBorder(double top,
                   double left,
                   double bottom,
                   double right)
Creates a new border with the specified line widths (in black).
Parameters:
top - the width of the top border.
left - the width of the left border.
bottom - the width of the bottom border.
right - the width of the right border.

BlockBorder

public BlockBorder(double top,
                   double left,
                   double bottom,
                   double right,
                   Paint paint)
Creates a new border with the specified line widths (in black).
Parameters:
top - the width of the top border.
left - the width of the left border.
bottom - the width of the bottom border.
right - the width of the right border.
paint - the border paint (null not permitted).

Method Details

draw

public void draw(Graphics2D g2,
                 Rectangle2D area)
Draws the border by filling in the reserved space.
Specified by:
draw in interface BlockFrame
Parameters:
g2 - the graphics device.
area - the area.

equals

public boolean equals(Object obj)
Tests this border for equality with an arbitrary instance.
Parameters:
obj - the object (null permitted).
Returns:
A boolean.

getInsets

public RectangleInsets getInsets()
Returns the space reserved for the border.
Specified by:
getInsets in interface BlockFrame
Returns:
The space (never null).

getPaint

public Paint getPaint()
Returns the paint used to draw the border.
Returns:
The paint (never null).