org.axsl.areaR
Interface Area

All Superinterfaces:

AreaNode

All Known Subinterfaces:

BasicLinkArea, BeforeFloatArea, BlockContainerArea, ExternalGraphicArea, FootnoteArea, ForeignObjectArea, GeneralInlineArea, InlineArea, LeaderArea, LineArea, ListBlockArea, MainReferenceArea, NormalBlockArea, NormalFlowArea, PageArea, PageNumberArea, PageNumberCitationArea, RegionArea, RegionBodyArea, SpanArea, SVGArea, TableArea, TableCellArea, TextArea

public interface Area

extends AreaNode

Super-interface for all AreaNodes that actually occupy Area on a page.

Method Summary

int	brBPD() The block-progression-dimension of the border-rectangle for this Area.
int	brIPD() The inline-progression-dimension of the border-rectangle for this Area.
int	brOriginX() Point-of-origin is defined as the point on the page where this area "begins", the intersection of the before-edge of the rectangle with its start-edge.
int	brOriginY() See brOriginX() where point-of-origin is defined.
java.awt.geom.Rectangle2D.Float	brPoints() Returns the border rectangle measured in points (1/72 of an inch).
int	crBPD() The block-progression-dimension of the content-rectangle for this Area.
int	crIPD() The inline-progression-dimension of the content-rectangle for this Area.
int	crOriginX() See brOriginX() where point-of-origin is defined.
int	crOriginY() See brOriginX() where point-of-origin is defined.
java.lang.String	destinationName() If this Area should be defined in the output document as a destination, return the name of that destination.
boolean	generatedByExists() Indicates whether the "generated-by" trait exists.
java.lang.String	generatedByName() Returns the name of the "generated-by".
java.awt.Color	getColor() The color for this Area.
int	getProgressionDimension() Returns the actual total value, in millipoints, of the size of this area (not counting space-before, etc.) in its progression direction.
java.lang.String	linkDestination() If this Area is descended from a fo:basic-link, return the link destination (either internal-destination or external-destination).
byte	linkType() If this Area is descended from a fo:basic-link, return the link type for that link.
int	prOriginX() See brOriginX() where point-of-origin is defined.
int	prOriginY() See brOriginX() where point-of-origin is defined.
int	rrBPD() The block-progression-dimension of the render-rectangle for this Area.
int	rrIPD() The render-rectangle is usually the same as the content-rectangle, but there are times when it is convenient to adjust, within the content-rectangle, the actual rendering location.
int	rrOriginX() See brOriginX() where point-of-origin is defined.
int	rrOriginY() See brOriginX() where point-of-origin is defined.
java.awt.Color	traitBorderAfterColor() The color of the border-after.
int	traitBorderAfterWidth() The width of the border-after.
java.awt.Color	traitBorderBeforeColor() The color of the border-before.
int	traitBorderBeforeWidth() The width of the border-before.
java.awt.Color	traitBorderEndColor() The color of the border-end.
int	traitBorderEndWidth() The width of the border-end.
java.awt.Color	traitBorderStartColor() The color of the border-start.
int	traitBorderStartWidth() The width of the border-start.
short	traitOverflow() The "overflow" trait.
short	traitScaling() The "scaling" trait for this Area.

Methods inherited from interface org.axsl.areaR.AreaNode

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

Method Detail

generatedByExists

public boolean generatedByExists()

Indicates whether the "generated-by" trait exists.

Returns:

True iff the "generated-by" exists.

generatedByName

public java.lang.String generatedByName()

Returns the name of the "generated-by".

Returns:

The name of the "generated-by".

traitBorderBeforeColor

public java.awt.Color traitBorderBeforeColor()

The color of the border-before.

Returns:

The color of the border-before.

traitBorderStartColor

public java.awt.Color traitBorderStartColor()

The color of the border-start.

Returns:

The color of the border-start.

traitBorderEndColor

public java.awt.Color traitBorderEndColor()

The color of the border-end.

Returns:

The color of the border-end.

traitBorderAfterColor

public java.awt.Color traitBorderAfterColor()

The color of the border-after.

Returns:

The color of the border-after.

brIPD

public int brIPD()

The inline-progression-dimension of the border-rectangle for this Area.

Returns:

The inline-progression-dimension of the border-rectangle for this Area.

brBPD

public int brBPD()

The block-progression-dimension of the border-rectangle for this Area.

Returns:

The block-progression-dimension of the border-rectangle for this Area.

brOriginX

public int brOriginX()

Point-of-origin is defined as the point on the page where this area "begins", the intersection of the before-edge of the rectangle with its start-edge. For lr-tb writing mode, it is the upper left corner of the rectangle. For rl-tb writing mode, it is the upper right corner of the rectangle.

Returns:

The absolute cartesian X value, on the page, of the point of origin of the border-rectangle.

brOriginY

public int brOriginY()

See brOriginX() where point-of-origin is defined.

Returns:

The absolute cartesian Y value, on the page, of the point of origin of the border-rectangle.

prOriginX

public int prOriginX()

See brOriginX() where point-of-origin is defined.

Returns:

The absolute cartesian X value, on the page, of the point of origin of the padding-rectangle.

prOriginY

public int prOriginY()

See brOriginX() where point-of-origin is defined.

Returns:

The absolute cartesian Y value, on the page, of the point of origin of the padding-rectangle.

crIPD

public int crIPD()

The inline-progression-dimension of the content-rectangle for this Area.

Returns:

The inline-progression-dimension of the content-rectangle for this Area.

crBPD

public int crBPD()

The block-progression-dimension of the content-rectangle for this Area.

Returns:

The block-progression-dimension of the content-rectangle for this Area.

crOriginX

public int crOriginX()

See brOriginX() where point-of-origin is defined.

Returns:

The absolute cartesian X value, on the page, of the point of origin of the content-rectangle.

crOriginY

public int crOriginY()

See brOriginX() where point-of-origin is defined.

Returns:

The absolute cartesian Y value, on the page, of the point of origin of the content-rectangle.

rrIPD

public int rrIPD()

The render-rectangle is usually the same as the content-rectangle, but there are times when it is convenient to adjust, within the content-rectangle, the actual rendering location. Examples include centering and right-justification of items in a LineArea.

Returns:

The inline-progression-dimension of the render-rectangle for this Area.

rrBPD

public int rrBPD()

The block-progression-dimension of the render-rectangle for this Area.

Returns:

The block-progression-dimension of the render-rectangle for this Area.

rrOriginX

public int rrOriginX()

See brOriginX() where point-of-origin is defined.

Returns:

The absolute cartesian X value, on the page, of the point of origin of the render-rectangle.

rrOriginY

public int rrOriginY()

See brOriginX() where point-of-origin is defined.

Returns:

The absolute cartesian Y value, on the page, of the point of origin of the render-rectangle.

traitBorderStartWidth

public int traitBorderStartWidth()

The width of the border-start.

Returns:

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

traitBorderEndWidth

public int traitBorderEndWidth()

The width of the border-end.

Returns:

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

traitBorderBeforeWidth

public int traitBorderBeforeWidth()

The width of the border-before.

Returns:

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

traitBorderAfterWidth

public int traitBorderAfterWidth()

The width of the border-after.

Returns:

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

getColor

public java.awt.Color getColor()

The color for this Area.

Returns:

The color for this Area.

traitScaling

public short traitScaling()

The "scaling" trait for this Area.

Returns:

The "scaling" trait, one of Constants.FOVAL_UNIFORM, or Constants.FOVAL_NON_UNIFORM.

traitOverflow

public short traitOverflow()

The "overflow" trait.

Returns:

The "overflow" trait for this FO, one of Constants.FOVAL_VISIBLE, Constants.FOVAL_HIDDEN, Constants.FOVAL_SCROLL, Constants.FOVAL_ERROR_IF_OVERFLOW, or Constants.FOVAL_AUTO.

destinationName

public java.lang.String destinationName()

If this Area should be defined in the output document as a destination, return the name of that destination.

Returns:

The name of the destination associated with this Area, or null if there is none.

linkType

public byte linkType()

If this Area is descended from a fo:basic-link, return the link type for that link.

Returns:

The link type for the ancestor link, one of: Constants.BASIC_LINK_EXTERNAL, or Constants.BASIC_LINK_INTERNAL. If this area does not have an ancestor link, returns Constants.BASIC_LINK_INVALID.

linkDestination

public java.lang.String linkDestination()

If this Area is descended from a fo:basic-link, return the link destination (either internal-destination or external-destination).

Returns:

String representation of either internal-destination or external-destination.

brPoints

public java.awt.geom.Rectangle2D.Float brPoints()

Returns the border rectangle measured in points (1/72 of an inch).

Returns:

The border rectangle in points.

getProgressionDimension

public int getProgressionDimension()

Returns the actual total value, in millipoints, of the size of this area (not counting space-before, etc.) in its progression direction. This value does not include space-before, etc., but does include borders and padding. For block areas, the progression dimension is the block-progression-dimension. For inline areas, it is the inline-progression-dimension.

Returns:

The progressionDimension.