org.axsl.areaR
Interface BackgroundArea

All Superinterfaces:

AreaNode, GraphicArea

All Known Subinterfaces:

BlockContainerArea, InlineArea, NormalBlockArea, RegionArea, RegionBodyArea, TableCellArea

public interface BackgroundArea

extends GraphicArea

Background Areas are rectangles for which a background should be painted. They are described in XSL-FO 1.0, Section 6.7.3. They include table-header, table-footer, table-body, spanned table columns, table columns, table rows, blocks, block-containers, inlines, and regions.

Method Summary

boolean	backgroundRepeatX() Indicates whether the background-image (if any) repeats along the horizontal axis.
boolean	backgroundRepeatY() Indicates whether the background-image (if any) repeats along the vertical axis.
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.

Methods inherited from interface org.axsl.areaR.GraphicArea

getGraphic

Methods inherited from interface org.axsl.areaR.AreaNode

ancestorLineAreaOut, getAreaName, getChildren, getFontConsumer, getParentOut, render, traitColor, traitFontStyle, traitFontWeight, traitId, traitInternalDestination

Method Detail

prOriginX

public int prOriginX()

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

Returns:

The horizontal offset.

prOriginY

public int prOriginY()

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

Returns:

The verical offset.

prIPD

public int prIPD()

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

Returns:

The width.

prBPD

public int prBPD()

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

Returns:

The horizontal offset.

traitBackgroundColor

public java.awt.Color traitBackgroundColor()

The color of this background.

Returns:

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

traitBackgroundImage

public Graphic traitBackgroundImage()

The Graphic for this background.

Returns:

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

backgroundRepeatX

public boolean backgroundRepeatX()

Indicates whether the background-image (if any) repeats along the horizontal axis.

Returns:

True iff the background-image repeats along the horizontal axis (left-to-right).

backgroundRepeatY

public boolean backgroundRepeatY()

Indicates whether the background-image (if any) repeats along the vertical axis.

Returns:

True iff the background-image repeats along the vertical axis (top-to-bottom).