Package | Description |
---|---|
org.apache.fop.area |
FOP's area tree.
|
org.apache.fop.area.inline |
FOP's area tree: inline-level areas
|
org.apache.fop.layoutmgr |
FOP's layout engine.
|
org.apache.fop.layoutmgr.inline |
Layout managers for inline formatting objects and line building.
|
org.apache.fop.layoutmgr.list |
Layout managers for lists.
|
org.apache.fop.layoutmgr.table |
Layout managers for tables.
|
org.apache.fop.render |
Generic renderer interface.
|
org.apache.fop.render.awt |
AWT Renderer used for displaying rendered pages in Java applications.
|
org.apache.fop.render.txt |
Plain Text Renderer
|
org.apache.fop.render.xml |
Area Tree XML Renderer.
|
Modifier and Type | Class and Description |
---|---|
class |
BeforeFloat
The before-float-reference-area optionally generated by an fo:region-body.
|
class |
Block
This is the block area class.
|
class |
BlockParent
A BlockParent holds block-level areas.
|
class |
BlockViewport
A BlockViewport.
|
class |
BodyRegion
This class is a container for the areas that may be generated by
an fo:region-body.
|
class |
Footnote
The footnote-reference-area optionally generated by an fo:region-body.
|
class |
LineArea
The line area.
|
class |
MainReference
The main-reference-area generated by an fo:region-body
This object holds one or more span-reference-areas (block-areas
stacked in the block progression direction)
See fo:region-body definition in the XSL Rec for more information.
|
class |
NormalFlow
The normal-flow-reference-area class.
|
class |
RegionReference
This is a region reference area for a page regions.
|
class |
RegionViewport
Region Viewport area.
|
class |
SideFloat |
class |
Span
The span-reference-area.
|
Modifier and Type | Field and Description |
---|---|
protected List<Area> |
BlockParent.children
The children of this block parent area.
|
Modifier and Type | Method and Description |
---|---|
List<Area> |
RegionReference.getBlocks()
Get the block in this region.
|
Modifier and Type | Method and Description |
---|---|
void |
LineArea.addChildArea(Area childArea)
Add a child area to this line area.
|
void |
Area.addChildArea(Area child)
Add a child to this area.
|
void |
BlockParent.addChildArea(Area childArea)
Add a child to this area.
|
void |
RegionReference.addChildArea(Area child)
Add a child to this area.
|
Constructor and Description |
---|
LinkResolver(String id,
Area a)
Create a new link resolver.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractTextArea
Abstract base class for both TextArea and Character.
|
class |
Anchor
Anchor area for footnote or float.
|
class |
BasicLinkArea
An inline area produced by an fo:basic-link element.
|
class |
Container
Container area for inline container.
|
class |
FilledArea
Filled area.
|
class |
ForeignObject
Foreign object inline area.
|
class |
Image
Image area for external-graphic.
|
class |
InlineArea
Inline Area
This area is for all inline areas that can be placed
in a line area.
|
class |
InlineBlock
This is the inline block area class.
|
class |
InlineBlockParent
Inline block parent area.
|
class |
InlineParent
Inline parent area.
|
class |
InlineViewport
Inline viewport area.
|
class |
Leader
This is a leader inline area.
|
class |
ResolvedPageNumber
Always (pre-) resolved page number area.
|
class |
Space
Inline space area.
|
class |
SpaceArea
A space
|
class |
TextArea
A text inline area.
|
class |
UnresolvedPageNumber
Unresolvable page number area.
|
class |
WordArea
A string of characters without spaces
|
Modifier and Type | Method and Description |
---|---|
Area |
InlineViewport.getContent()
Get the content area for this viewport.
|
Area |
InlineArea.getParentArea() |
Modifier and Type | Method and Description |
---|---|
void |
Container.addChildArea(Area child) |
void |
InlineArea.addChildArea(Area childArea)
Set the parent for the child area.
|
void |
InlineParent.addChildArea(Area c) |
void |
InlineBlockParent.addChildArea(Area childArea)
Override generic Area method.
|
void |
InlineViewport.setContent(Area content)
Sets the content area.
|
void |
InlineArea.setParentArea(Area parentArea) |
void |
BasicLinkArea.setParentArea(Area parentArea) |
Constructor and Description |
---|
InlineViewport(Area child)
Create a new viewport area with the content area.
|
InlineViewport(Area child,
int bidiLevel)
Create a new viewport area with the content area.
|
Modifier and Type | Method and Description |
---|---|
Area |
MultiCaseLayoutManager.getParentArea(Area childArea) |
Area |
FlowLayoutManager.getParentArea(Area childArea)
Return an Area which can contain the passed childArea.
|
Area |
BlockLayoutManager.getParentArea(Area childArea)
Return an Area which can contain the passed childArea.
|
Area |
BlockContainerLayoutManager.getParentArea(Area childArea)
Get the parent area for children of this block container.
|
Area |
AbstractLayoutManager.getParentArea(Area childArea)
Return an Area which can contain the passed childArea.
|
Area |
LayoutManager.getParentArea(Area childArea)
Get the parent area for an area.
|
Area |
MultiSwitchLayoutManager.getParentArea(Area childArea) |
Area |
StaticContentLayoutManager.getParentArea(Area childArea)
Return an Area which can contain the passed childArea.
|
Modifier and Type | Method and Description |
---|---|
static void |
TraitSetter.addBackground(Area area,
CommonBorderPaddingBackground backProps,
PercentBaseContext context)
Add background to an area.
|
static void |
TraitSetter.addBackground(Area area,
CommonBorderPaddingBackground backProps,
PercentBaseContext context,
int ipdShift,
int bpdShift,
int referenceIPD,
int referenceBPD)
Add background to an area.
|
static void |
TraitSetter.addBorders(Area area,
CommonBorderPaddingBackground borderProps,
boolean discardBefore,
boolean discardAfter,
boolean discardStart,
boolean discardEnd,
PercentBaseContext context)
Add borders to an area.
|
static void |
TraitSetter.addBorders(Area area,
CommonBorderPaddingBackground borderProps,
PercentBaseContext context)
Deprecated.
Call the other addBorders() method and addPadding separately.
|
static void |
TraitSetter.addBreaks(Area area,
int breakBefore,
int breakAfter)
Sets the traits for breaks on an area.
|
void |
MultiCaseLayoutManager.addChildArea(Area childArea) |
void |
FlowLayoutManager.addChildArea(Area childArea)
Add child area to a the correct container, depending on its
area class.
|
void |
FootnoteBodyLayoutManager.addChildArea(Area childArea)
Add the childArea to the current area.
|
void |
FloatContentLayoutManager.addChildArea(Area childArea) |
void |
BlockLayoutManager.addChildArea(Area childArea)
Add the childArea to the current area.
|
void |
BlockContainerLayoutManager.addChildArea(Area childArea)
Add the child to the block container.
|
void |
AbstractLayoutManager.addChildArea(Area childArea)
Add a child area to the current area.
|
void |
LayoutManager.addChildArea(Area childArea)
Add the area as a child of the current area.
|
void |
BlockStackingLayoutManager.addChildArea(Area childArea)
Add the childArea to the current area.
|
void |
MultiSwitchLayoutManager.addChildArea(Area childArea) |
void |
StaticContentLayoutManager.addChildArea(Area childArea)
Add child area to a the correct container, depending on its
area class.
|
protected void |
BlockStackingLayoutManager.addChildToArea(Area childArea,
BlockParent parentArea)
Add the childArea to the passed area.
|
static void |
TraitSetter.addCollapsingBorders(Area area,
CommonBorderPaddingBackground.BorderInfo borderBefore,
CommonBorderPaddingBackground.BorderInfo borderAfter,
CommonBorderPaddingBackground.BorderInfo borderStart,
CommonBorderPaddingBackground.BorderInfo borderEnd,
boolean[] outer)
Add borders to an area for the collapsing border model in tables.
|
static void |
TraitSetter.addFontTraits(Area area,
Font font)
Adds font traits to an area
|
static void |
TraitSetter.addMargins(Area area,
CommonBorderPaddingBackground bpProps,
CommonMarginBlock marginProps,
PercentBaseContext context)
Add space to a block area.
|
static void |
TraitSetter.addMargins(Area area,
CommonBorderPaddingBackground bpProps,
int startIndent,
int endIndent,
PercentBaseContext context)
Add space to a block area.
|
static void |
TraitSetter.addPadding(Area area,
CommonBorderPaddingBackground bordProps,
boolean discardBefore,
boolean discardAfter,
boolean discardStart,
boolean discardEnd,
PercentBaseContext context)
Add padding to an area.
|
static void |
TraitSetter.addSpaceBeforeAfter(Area area,
double adjust,
MinOptMax spaceBefore,
MinOptMax spaceAfter)
Adds traits for space-before and space-after to an area.
|
static void |
TraitSetter.addStructureTreeElement(Area area,
StructureTreeElement structureTreeElement)
Sets the structure tree element associated to the given area.
|
static void |
TraitSetter.addTextDecoration(Area area,
CommonTextDecoration deco)
Adds the text-decoration traits to the area.
|
Area |
MultiCaseLayoutManager.getParentArea(Area childArea) |
Area |
FlowLayoutManager.getParentArea(Area childArea)
Return an Area which can contain the passed childArea.
|
Area |
BlockLayoutManager.getParentArea(Area childArea)
Return an Area which can contain the passed childArea.
|
Area |
BlockContainerLayoutManager.getParentArea(Area childArea)
Get the parent area for children of this block container.
|
Area |
AbstractLayoutManager.getParentArea(Area childArea)
Return an Area which can contain the passed childArea.
|
Area |
LayoutManager.getParentArea(Area childArea)
Get the parent area for an area.
|
Area |
MultiSwitchLayoutManager.getParentArea(Area childArea) |
Area |
StaticContentLayoutManager.getParentArea(Area childArea)
Return an Area which can contain the passed childArea.
|
static void |
TraitSetter.setBorderPaddingTraits(Area area,
CommonBorderPaddingBackground bpProps,
boolean isNotFirst,
boolean isNotLast,
PercentBaseContext context)
Sets border and padding traits on areas.
|
static void |
TraitSetter.setLayer(Area area,
String layer)
Sets the optional content group layer as a trait on the area.
|
static void |
TraitSetter.setProducerID(Area area,
String id)
Sets the producer's ID as a trait on the area.
|
static void |
TraitSetter.setVisibility(Area area,
int visibility) |
Modifier and Type | Method and Description |
---|---|
protected Area |
InstreamForeignObjectLM.getChildArea()
Returns the image of foreign object area to be put into
the viewport.
|
protected abstract Area |
AbstractGraphicsLayoutManager.getChildArea()
Returns the image of foreign object area to be put into
the viewport.
|
protected Area |
ExternalGraphicLayoutManager.getChildArea()
Returns the image of foreign object area to be put into
the viewport.
|
protected Area |
InlineStackingLayoutManager.getCurrentArea()
Returns the current area.
|
Area |
ContentLayoutManager.getParentArea(Area childArea)
Get the parent area for an area.
|
Area |
LeafNodeLayoutManager.getParentArea(Area childArea)
This is a leaf-node, so this method should never be called.
|
Area |
InlineContainerLayoutManager.getParentArea(Area childArea) |
Modifier and Type | Method and Description |
---|---|
void |
ContentLayoutManager.addChildArea(Area childArea)
Add the area as a child of the current area.
|
void |
LeafNodeLayoutManager.addChildArea(Area childArea)
This is a leaf-node, so this method should never be called.
|
void |
InlineContainerLayoutManager.addChildArea(Area childArea) |
void |
InlineLayoutManager.addChildArea(Area childArea)
Add a child area to the current area.
|
void |
LineLayoutManager.addChildArea(Area childArea)
Add a child area to the current area.
|
protected void |
InlineStackingLayoutManager.addSpace(Area parentArea,
MinOptMax spaceRange,
double spaceAdjust)
Adds a space to the area.
|
Area |
ContentLayoutManager.getParentArea(Area childArea)
Get the parent area for an area.
|
Area |
LeafNodeLayoutManager.getParentArea(Area childArea)
This is a leaf-node, so this method should never be called.
|
Area |
InlineContainerLayoutManager.getParentArea(Area childArea) |
protected void |
InlineStackingLayoutManager.setCurrentArea(Area area)
Set the current area.
|
Constructor and Description |
---|
ContentLayoutManager(Area area,
LayoutManager parentLM)
Constructs a new ContentLayoutManager
|
Modifier and Type | Method and Description |
---|---|
Area |
ListItemLayoutManager.getParentArea(Area childArea)
Return an Area which can contain the passed childArea.
|
Area |
ListBlockLayoutManager.getParentArea(Area childArea)
Return an Area which can contain the passed childArea.
|
Area |
ListItemContentLayoutManager.getParentArea(Area childArea)
Return an Area which can contain the passed childArea.
|
Modifier and Type | Method and Description |
---|---|
void |
ListItemLayoutManager.addChildArea(Area childArea)
Add the child.
|
void |
ListBlockLayoutManager.addChildArea(Area childArea)
Add the child area to this layout manager.
|
void |
ListItemContentLayoutManager.addChildArea(Area childArea)
Add the child to the list item area.
|
Area |
ListItemLayoutManager.getParentArea(Area childArea)
Return an Area which can contain the passed childArea.
|
Area |
ListBlockLayoutManager.getParentArea(Area childArea)
Return an Area which can contain the passed childArea.
|
Area |
ListItemContentLayoutManager.getParentArea(Area childArea)
Return an Area which can contain the passed childArea.
|
Modifier and Type | Method and Description |
---|---|
Area |
TableLayoutManager.getParentArea(Area childArea)
Return an Area which can contain the passed childArea.
|
Area |
TableAndCaptionLayoutManager.getParentArea(Area childArea)
Return an Area which can contain the passed childArea.
|
Area |
TableCellLayoutManager.getParentArea(Area childArea)
Return an Area which can contain the passed childArea.
|
Area |
TableCaptionLayoutManager.getParentArea(Area childArea)
Return an Area which can contain the passed childArea.
|
Modifier and Type | Method and Description |
---|---|
void |
TableLayoutManager.addChildArea(Area childArea)
Add the child area to this layout manager.
|
void |
TableAndCaptionLayoutManager.addChildArea(Area childArea)
Add the child to the current area.
|
void |
TableCellLayoutManager.addChildArea(Area childArea)
Add the child to the cell block area.
|
void |
TableCaptionLayoutManager.addChildArea(Area childArea)
Add the child to the caption area.
|
Area |
TableLayoutManager.getParentArea(Area childArea)
Return an Area which can contain the passed childArea.
|
Area |
TableAndCaptionLayoutManager.getParentArea(Area childArea)
Return an Area which can contain the passed childArea.
|
Area |
TableCellLayoutManager.getParentArea(Area childArea)
Return an Area which can contain the passed childArea.
|
Area |
TableCaptionLayoutManager.getParentArea(Area childArea)
Return an Area which can contain the passed childArea.
|
Modifier and Type | Method and Description |
---|---|
protected void |
AbstractPathOrientedRenderer.drawBackAndBorders(Area backgroundArea,
Area borderArea,
float startx,
float starty,
float width,
float height)
Draw the background and borders.
|
protected void |
AbstractPathOrientedRenderer.drawBackAndBorders(Area area,
float startx,
float starty,
float width,
float height)
Draw the background and borders.
|
protected void |
AbstractRenderer.drawChangeBars(Area area,
List<ChangeBar> changeBarList)
Draws all change bars associated with an area.
|
protected Font |
PrintRenderer.getFontFromArea(Area area)
Returns a Font object constructed based on the font traits in an area
|
protected String |
PrintRenderer.getInternalFontNameForArea(Area area)
Returns the internal font key for a font triplet coming from the area tree
|
protected void |
AbstractRenderer.maybeEndLayer(Area area,
boolean inNewLayer) |
protected boolean |
AbstractRenderer.maybeStartLayer(Area area) |
Modifier and Type | Method and Description |
---|---|
protected void |
AWTRenderer.drawBackAndBorders(Area area,
float startx,
float starty,
float width,
float height)
Draws the background and borders and adds a basic debug view // TODO
implement visual-debugging as standalone
Draw the background and borders.
float, float, float, float)
|
Modifier and Type | Method and Description |
---|---|
protected void |
TXTRenderer.drawBackAndBorders(Area area,
float startx,
float starty,
float width,
float height)
Draw the background and borders.
|
Modifier and Type | Method and Description |
---|---|
protected void |
XMLRenderer.addAreaAttributes(Area area)
Adds the general Area attributes.
|
protected void |
XMLRenderer.addTraitAttributes(Area area)
Adds attributes from traits of an Area.
|
Copyright © 2025 Apache Software Foundation. All rights reserved.