org.axsl.galley
Interface Area

All Superinterfaces:

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

All Known Subinterfaces:

BackgroundArea, BeforeFloatArea, BlockContainerArea, BorderPaddingArea, ExternalGraphicArea, FootnoteArea, ForeignObjectArea, GeneralInlineArea, GraphicArea, InlineArea, LeaderArea, LineArea, ListBlockArea, MainReferenceArea, NormalBlockArea, Page, RegionArea, 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() Returns the X coordinate of the point-of-origin (intersection of before edge and start edge) of the border rectangle for this area.
int	brOriginY() Returns the Y coordinate of the point-of-origin (intersection of before edge and start edge) of the border rectangle for this area.
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() Returns the X coordinate of the point-of-origin (intersection of before edge and start edge) of the content rectangle for this area.
int	crOriginY() Returns the Y coordinate of the point-of-origin (intersection of before edge and start edge) of the content rectangle for this area.
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".
boolean	isLinkRoot() Indicates whether this Area is the root of a link area.
java.lang.String	linkDestination() If this Area is descended from a fo:basic-link, return the link destination (either internal-destination or external-destination).
LinkType	linkType() If this Area is descended from a fo:basic-link, return the link type for that link.
java.lang.String	traitId() Returns the id of this node.

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

iterator

Method Detail

generatedByExists

boolean generatedByExists()

Indicates whether the "generated-by" trait exists.

Returns:

True iff the "generated-by" exists.

generatedByName

java.lang.String generatedByName()

Returns the name of the "generated-by".

Returns:

The name of the "generated-by".

brIpd

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

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

int brOriginX()

Returns the X coordinate of the point-of-origin (intersection of before edge and start edge) of the border rectangle for this area.

Note that the border is drawn between the border rectangle and the padding rectangle. (This is in accordance with the XSL-FO Standard, 1.1, Section 4.9.4). In other words, the border is drawn inside the border rectangle, not straddling it as might be supposed. Although it might be tempting to define another rectangle that would indicate where the border should be drawn if straddling the rectangle, this is not as useful as it sounds, primarily because some borders (those with special effects like engraving or insets for example) require two rectangles to be drawn anyway.

Returns:

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

brOriginY

int brOriginY()

Returns the Y coordinate of the point-of-origin (intersection of before edge and start edge) of the border rectangle for this area.

Returns:

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

crIpd

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

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

int crOriginX()

Returns the X coordinate of the point-of-origin (intersection of before edge and start edge) of the content rectangle for this area.

Returns:

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

crOriginY

int crOriginY()

Returns the Y coordinate of the point-of-origin (intersection of before edge and start edge) of the content rectangle for this area.

Returns:

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

destinationName

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.

isLinkRoot

boolean isLinkRoot()

Indicates whether this Area is the root of a link area. For this to be true, two things must be true about the Area:

• It must be descended from a link.
• Its parent must not be descended from a link.

Typically when rendering an AreaTree, the intent of the renderer is to render a link only on the link root Area(s), that is the "outer" Area(s) that are associated with the link. This is because, by definition, all Areas inside these areas are inside them, and automatically included in the outer Area, and there is no need to create another link for them.

Returns:

True iff this Area is descended from a link and its parent is not.

linkType

LinkType 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: LinkType.EXTERNAL or LinkType.INTERNAL. If this area does not have an ancestor link, returns null.

linkDestination

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.

traitId

java.lang.String traitId()

Returns the id of this node.

Returns:

The id of this node.