org.axsl.galley

Interface BackgroundArea

All Superinterfaces:

Area, AreaNode, GraphicArea, java.lang.Iterable<AreaNode>, javax.swing.tree.TreeNode

All Known Subinterfaces:

BlockContainerArea, InlineArea, NormalBlockArea, RegionArea, TableArea, TableCellArea

public interface BackgroundArea
extends GraphicArea

Background Areas are rectangles for which a background should be painted. They are described in the documentation of the table object in the Recommendation. They include table-header, table-footer, table-body, spanned table columns, table columns, table rows, blocks, block-containers, inlines, and regions.

See Also:

"XSL-FO Recommendation 1.0, Section 6.7.3", "XSL-FO Recommendation 1.1, Section 6.7.3"

Method Summary

Modifier and Type	Method and Description
int	prBpd() The height of the padding rectangle in which the background should be painted.
int	prIpd() The width of the padding rectangle in which the background should be painted.
int	prOriginX() The X coordinate of start-point of the padding rectangle in which the background should be painted.
int	prOriginY() The Y coordinate of start-point of the padding rectangle in which the background should be painted.
java.awt.Color	traitBackgroundColor() The color of this background.
Graphic	traitBackgroundImage() The Graphic for this background.
BackgroundRepeat	traitBackgroundRepeat() The background-repeat for the background-image (if any), indicating whether the background image repeats on the horizontal and vertical axes.

Methods inherited from interface org.axsl.galley.GraphicArea

getGraphic

Methods inherited from interface org.axsl.galley.Area

brBpd, brIpd, brOriginX, brOriginY, crBpd, crIpd, crOriginX, crOriginY, destinationName, generatedByExists, generatedByName, isLinkRoot, linkDestination, linkType, traitId

Methods inherited from interface org.axsl.galley.AreaNode

getAreaName, getChildAt, getGalley, render

Methods inherited from interface javax.swing.tree.TreeNode

children, getAllowsChildren, getChildCount, getIndex, getParent, isLeaf

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

prOriginX

int prOriginX()

The X coordinate of start-point of the padding rectangle in which the background should be painted.

Returns:

The horizontal offset.

prOriginY

int prOriginY()

The Y coordinate of start-point of the padding rectangle in which the background should be painted.

Returns:

The verical offset.

prIpd

int prIpd()

The width of the padding rectangle in which the background should be painted.

Returns:

The width.

prBpd

int prBpd()

The height of the padding rectangle in which the background should be painted.

Returns:

The horizontal offset.

traitBackgroundColor

java.awt.Color traitBackgroundColor()

The color of this background.

Returns:

The color of this background, or null if no color should be applied.

traitBackgroundImage

Graphic traitBackgroundImage()

The Graphic for this background.

Returns:

The Graphic for this background, or null if no Graphic should be applied.

traitBackgroundRepeat

BackgroundRepeat traitBackgroundRepeat()

The background-repeat for the background-image (if any), indicating whether the background image repeats on the horizontal and vertical axes.

Returns:

The BackgroundRepeat for this area.