org.axsl.fo.fo.prop
Interface CommonBorderPaddingBgPa

All Known Subinterfaces:

BasicLink, Block, BlockContainer, CharacterSequence, ExternalGraphic, InitialPropertySet, Inline, InlineContainer, InstreamForeignObject, Leader, ListBlock, ListItem, PageNumber, PageNumberCitation, PageNumberCitationLast, Region, RegionAfter, RegionBefore, RegionBody, RegionEnd, RegionStart, ScalingValueCitation, Table, TableAndCaption, TableBody, TableCaption, TableCell, TableColumn, TableFooter, TableHeader, TableRow, Title

public interface CommonBorderPaddingBgPa

The XSL-FO Common Border, Padding, and Background properties.

See Also:

"XSL-FO, 1.1, Section 7.8."

Method Summary

BackgroundAttachment	traitBackgroundAttachment(FoContext context) Returns the "background-attachment" trait for this FO.
java.awt.Color	traitBackgroundColor(FoContext context) Returns the "background-color" trait for this FO.
Graphic	traitBackgroundImage(FoContext context) Returns the "background-image" trait for this FO.
int	traitBackgroundPositionHorizontal(FoContext context, int paddingRectangleWidth, int backgroundImageWidth) Returns the "background-position-horizontal" trait for this FO.
int	traitBackgroundPositionVertical(FoContext context, int paddingRectangleHeight, int backgroundImageHeight) Returns the "background-position-vertical" trait for this FO.
BackgroundRepeat	traitBackgroundRepeat(FoContext context) Returns the "background-repeat" trait for this FO.
java.awt.Color	traitBorderAfterColor(FoContext context) Returns the "border-after-color" trait for this FO.
BorderStyle	traitBorderAfterStyle(FoContext context) Returns the "border-after-style" trait for this FO.
int	traitBorderAfterWidth(FoContext context) Returns the "border-after-width" trait for this FO.
java.awt.Color	traitBorderBeforeColor(FoContext context) Returns the "border-before-color" trait for this FO.
BorderStyle	traitBorderBeforeStyle(FoContext context) Returns the "border-before-style" trait for this FO.
int	traitBorderBeforeWidth(FoContext context) Returns the "border-before-width" trait for this FO.
java.awt.Color	traitBorderEndColor(FoContext context) Returns the "border-end-color" trait for this FO.
BorderStyle	traitBorderEndStyle(FoContext context) Returns the "border-end-style" trait for this FO.
int	traitBorderEndWidth(FoContext context) Returns the "border-end-width" trait for this FO.
java.awt.Color	traitBorderStartColor(FoContext context) Returns the "border-start-color" trait for this FO.
BorderStyle	traitBorderStartStyle(FoContext context) Returns the "border-start-style" trait for this FO.
int	traitBorderStartWidth(FoContext context) Returns the "border-start-width" trait for this FO.
int	traitPaddingAfter(FoContext context) Returns the "padding-after" trait for this FO.
int	traitPaddingBefore(FoContext context) Returns the "padding-before" trait for this FO.
int	traitPaddingEnd(FoContext context) Returns the "padding-end" trait for this FO.
int	traitPaddingStart(FoContext context) Returns the "padding-start" trait for this FO.

Method Detail

traitBackgroundAttachment

BackgroundAttachment traitBackgroundAttachment(FoContext context)

Returns the "background-attachment" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The "background-attachment" trait.

See Also:

"XSL-FO Standard 1.0, Section 7.7.1"

traitBackgroundColor

java.awt.Color traitBackgroundColor(FoContext context)

Returns the "background-color" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The background-color trait.

See Also:

"XSL-FO Standard 1.0, Section 7.7.2"

traitBackgroundImage

Graphic traitBackgroundImage(FoContext context)

Returns the "background-image" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The resolved background image for this FO, or null if none was specified or if the one specified cannot be resolved.

See Also:

"XSL-FO Standard 1.0, Section 7.7.3"

traitBackgroundRepeat

BackgroundRepeat traitBackgroundRepeat(FoContext context)

Returns the "background-repeat" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The background-repeat trait.

See Also:

"XSL-FO Standard 1.0, Section 7.7.4"

traitBackgroundPositionHorizontal

int traitBackgroundPositionHorizontal(FoContext context,
                                      int paddingRectangleWidth,
                                      int backgroundImageWidth)

Returns the "background-position-horizontal" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

paddingRectangleWidth - The width of the padding rectangle, used for percentage computations. (It may be tempting to think that this parameter should be in the FoContext instead of a separate parameter. However, this parameter value is used in almost all cases, and the FoContext is reserved for cases where the parameter is expected to be needed infrequently.)

backgroundImageWidth - The width, in millipoints, of the background-image.

Returns:

The length, in millipoints, that the background-image should be moved to the right, starting from the left edge of the padding-rectangle.

See Also:

"XSL-FO Standard 1.0, Section 7.7.5"

traitBackgroundPositionVertical

int traitBackgroundPositionVertical(FoContext context,
                                    int paddingRectangleHeight,
                                    int backgroundImageHeight)

Returns the "background-position-vertical" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

paddingRectangleHeight - The height of the padding rectangle, used for percentage computations. (It may be tempting to think that this parameter should be in the FoContext instead of a separate parameter. However, this parameter value is used in almost all cases, and the FoContext is reserved for cases where the parameter is expected to be needed infrequently.)

backgroundImageHeight - The height, in millipoints, of the background-image.

Returns:

The length, in millipoints, that the background-image should be moved down, starting from the top edge of the padding-rectangle.

See Also:

"XSL-FO Standard 1.0, Section 7.7.6"

traitBorderBeforeColor

java.awt.Color traitBorderBeforeColor(FoContext context)

Returns the "border-before-color" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The border-before-color.

See Also:

"XSL-FO Standard 1.0, Section 7.7.7"

traitBorderBeforeStyle

BorderStyle traitBorderBeforeStyle(FoContext context)

Returns the "border-before-style" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The border-before-style.

See Also:

"XSL-FO Standard 1.0, Section 7.7.8"

traitBorderBeforeWidth

int traitBorderBeforeWidth(FoContext context)

Returns the "border-before-width" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The size, in millipoints, of the border-before-width trait.

See Also:

"XSL-FO Standard 1.0, Section 7.7.9"

traitBorderAfterColor

java.awt.Color traitBorderAfterColor(FoContext context)

Returns the "border-after-color" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The border-after-color.

See Also:

"XSL-FO Standard 1.0, Section 7.7.10"

traitBorderAfterStyle

BorderStyle traitBorderAfterStyle(FoContext context)

Returns the "border-after-style" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The border-after-style.

See Also:

"XSL-FO Standard 1.0, Section 7.7.11"

traitBorderAfterWidth

int traitBorderAfterWidth(FoContext context)

Returns the "border-after-width" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The size, in millipoints, of the border-after-width trait.

See Also:

"XSL-FO Standard 1.0, Section 7.7.12"

traitBorderStartColor

java.awt.Color traitBorderStartColor(FoContext context)

Returns the "border-start-color" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The border-start-color.

See Also:

"XSL-FO Standard 1.0, Section 7.7.13"

traitBorderStartStyle

BorderStyle traitBorderStartStyle(FoContext context)

Returns the "border-start-style" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The border-start-style.

See Also:

"XSL-FO Standard 1.0, Section 7.7.14"

traitBorderStartWidth

int traitBorderStartWidth(FoContext context)

Returns the "border-start-width" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The size, in millipoints, of the border-start-width trait.

See Also:

"XSL-FO Standard 1.0, Section 7.7.15"

traitBorderEndColor

java.awt.Color traitBorderEndColor(FoContext context)

Returns the "border-end-color" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The border-end-color.

See Also:

"XSL-FO Standard 1.0, Section 7.7.16"

traitBorderEndStyle

BorderStyle traitBorderEndStyle(FoContext context)

Returns the "border-end-style" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The border-end-style.

See Also:

"XSL-FO Standard 1.0, Section 7.7.17"

traitBorderEndWidth

int traitBorderEndWidth(FoContext context)

Returns the "border-end-width" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The size, in millipoints, of the border-end-width trait.

See Also:

"XSL-FO Standard 1.0, Section 7.7.18"

traitPaddingBefore

int traitPaddingBefore(FoContext context)

Returns the "padding-before" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The size, in millipoints, of the padding-before trait.

See Also:

"XSL-FO Standard 1.0, Section 7.7.31"

traitPaddingAfter

int traitPaddingAfter(FoContext context)

Returns the "padding-after" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The size, in millipoints, of the padding-after trait.

See Also:

"XSL-FO Standard 1.0, Section 7.7.32"

traitPaddingStart

int traitPaddingStart(FoContext context)

Returns the "padding-start" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The size, in millipoints, of the padding-start trait.

See Also:

"XSL-FO Standard 1.0, Section 7.7.33"

traitPaddingEnd

int traitPaddingEnd(FoContext context)

Returns the "padding-end" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The size, in millipoints, of the padding-end trait.

See Also:

"XSL-FO Standard 1.0, Section 7.7.34"