Class AbstractBlock

protected AbstractBlock()

Creates a new block.

public Size2D arrange(Graphics2D g2)

Arranges the contents of the block, with no constraints, and returns the block size.

Parameters:

g2 - the graphics device.

Returns:

The block size (in Java2D units, never null).

public Size2D arrange(Graphics2D g2,
                      RectangleConstraint constraint)

Arranges the contents of the block, within the given constraints, and returns the block size.

Parameters:

g2 - the graphics device.

constraint - the constraint (null not permitted).

Returns:

The block size (in Java2D units, never null).

protected double calculateTotalHeight(double contentHeight)

Adds the margin, border and padding to the specified content height.

Parameters:

contentHeight - the content height.

Returns:

The adjusted height.

protected double calculateTotalWidth(double contentWidth)

Adds the margin, border and padding to the specified content width.

Parameters:

contentWidth - the content width.

Returns:

The adjusted width.

public Object clone()
            throws CloneNotSupportedException

Returns a clone of this block.

Returns:

A clone.

protected void drawBorder(Graphics2D g2,
                          Rectangle2D area)

Draws the border around the perimeter of the specified area.

Parameters:

g2 - the graphics device.

area - the area.

public boolean equals(Object obj)

Tests this block for equality with an arbitrary object.

Parameters:

obj - the object (null permitted).

Returns:

A boolean.

public BlockBorder getBorder()

Deprecated. Use getBlockFrame() instead.

Returns the border.

Returns:

The border (never null).

public Rectangle2D getBounds()

Returns the current bounds of the block.

Returns:

The bounds.

See Also:

setBounds(Rectangle2D)

public double getContentXOffset()

Returns the x-offset for the content within the block.

Returns:

The x-offset.

See Also:

getContentYOffset()

public double getContentYOffset()

Returns the y-offset for the content within the block.

Returns:

The y-offset.

See Also:

getContentXOffset()

public BlockFrame getFrame()

Returns the current frame (border).

Returns:

The frame.

Since:

1.0.5

public double getHeight()

Returns the natural height of the block, if this is known in advance. The actual height of the block may be overridden if layout constraints make this necessary.

Returns:

The height.

See Also:

setHeight(double)

public String getID()

Returns the id.

Returns:

The id (possibly null).

See Also:

setID(String)

public RectangleInsets getMargin()

Returns the margin.

Returns:

The margin (never null).

See Also:

getMargin()

public RectangleInsets getPadding()

Returns the padding.

Returns:

The padding (never null).

See Also:

setPadding(RectangleInsets)

public double getWidth()

Returns the natural width of the block, if this is known in advance. The actual width of the block may be overridden if layout constraints make this necessary.

Returns:

The width.

See Also:

setWidth(double)

public void setBorder(double top,
                      double left,
                      double bottom,
                      double right)

Sets a black border with the specified line widths.

Parameters:

top - the top border line width.

left - the left border line width.

bottom - the bottom border line width.

right - the right border line width.

public void setBorder(BlockBorder border)

Deprecated. Use setBorderFrame() instead.

Sets the border for the block (use BlockBorder.NONE for no border).

Parameters:

border - the border (null not permitted).

See Also:

getBorder()

public void setBounds(Rectangle2D bounds)

Sets the bounds of the block.

Parameters:

bounds - the bounds (null not permitted).

See Also:

getBounds()

public void setFrame(BlockFrame frame)

Sets the frame (or border).

Parameters:

frame - the frame (null not permitted).

Since:

1.0.5

public void setHeight(double height)

Sets the natural width of the block, if this is known in advance.

Parameters:

height - the width (in Java2D units)

See Also:

getHeight()

public void setID(String id)

Sets the id for the block.

Parameters:

id - the id (null permitted).

See Also:

getID()

public void setMargin(RectangleInsets margin)

Sets the margin (use RectangleInsets.ZERO_INSETS for no padding).

Parameters:

margin - the margin (null not permitted).

See Also:

getMargin()

public void setMargin(double top,
                      double left,
                      double bottom,
                      double right)

Sets the margin.

Parameters:

top - the top margin.

left - the left margin.

bottom - the bottom margin.

right - the right margin.

See Also:

getMargin()

public void setPadding(RectangleInsets padding)

Sets the padding (use RectangleInsets.ZERO_INSETS for no padding).

Parameters:

padding - the padding (null not permitted).

See Also:

getPadding()

public void setPadding(double top,
                       double left,
                       double bottom,
                       double right)

Sets the padding.

Parameters:

top - the top padding.

left - the left padding.

bottom - the bottom padding.

right - the right padding.

public void setWidth(double width)

Sets the natural width of the block, if this is known in advance.

Parameters:

width - the width (in Java2D units)

See Also:

getWidth()

protected RectangleConstraint toContentConstraint(RectangleConstraint c)

Returns a constraint for the content of this block that will result in the bounds of the block matching the specified constraint.

Parameters:

c - the outer constraint (null not permitted).

Returns:

The content constraint.

protected Rectangle2D trimBorder(Rectangle2D area)

Reduces the specified area by the amount of space consumed by the border.

Parameters:

area - the area (null not permitted).

Returns:

The trimmed area.

protected Rectangle2D trimMargin(Rectangle2D area)

Reduces the specified area by the amount of space consumed by the margin.

Parameters:

area - the area (null not permitted).

Returns:

The trimmed area.

protected Rectangle2D trimPadding(Rectangle2D area)

Reduces the specified area by the amount of space consumed by the padding.

Parameters:

area - the area (null not permitted).

Returns:

The trimmed area.

protected double trimToContentHeight(double fixedHeight)

Calculate the height available for content after subtracting the margin, border and padding space from the specified fixed height.

Parameters:

fixedHeight - the fixed height.

Returns:

The available space.

See Also:

trimToContentWidth(double)

protected double trimToContentWidth(double fixedWidth)

Calculate the width available for content after subtracting the margin, border and padding space from the specified fixed width.

Parameters:

fixedWidth - the fixed width.

Returns:

The available space.

See Also:

trimToContentHeight(double)