|
aXSL API 0.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Area
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 |
---|
boolean generatedByExists()
java.lang.String generatedByName()
int brIpd()
int brBpd()
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.
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 crIpd()
int crBpd()
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()
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:
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.
LinkType linkType()
LinkType.EXTERNAL
or
LinkType.INTERNAL
.
If this area does not have an ancestor link, returns null.java.lang.String linkDestination()
java.lang.String traitId()
|
aXSL API 0.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This documentation was created August 8 2007 by The aXSL Group and may be freely copied. See license for details.