Package org.apache.fop.area
Class RegionViewport
- java.lang.Object
-
- org.apache.fop.area.AreaTreeObject
-
- org.apache.fop.area.Area
-
- org.apache.fop.area.RegionViewport
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,Viewport
public class RegionViewport extends Area implements Viewport
Region Viewport area. This object represents the region-viewport-area. It has a region-reference-area as its child. These areas are described in the fo:region-body description in the XSL Recommendation.- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class org.apache.fop.area.Area
bidiLevel, bpd, CLASS_ABSOLUTE, CLASS_BEFORE_FLOAT, CLASS_FIXED, CLASS_FOOTNOTE, CLASS_MAX, CLASS_NORMAL, CLASS_SIDE_FLOAT, effectiveIPD, ipd, log, ORIENT_0, ORIENT_180, ORIENT_270, ORIENT_90, traits
-
Fields inherited from class org.apache.fop.area.AreaTreeObject
extensionAttachments, foreignAttributes
-
-
Constructor Summary
Constructors Constructor Description RegionViewport(java.awt.geom.Rectangle2D viewArea)
Create a new region-viewport-area
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
java.awt.Rectangle
getClipRectangle()
Returns the clipping rectangle of this viewport area.RegionReference
getRegionReference()
Get the region-reference-area for this region viewport.java.awt.geom.Rectangle2D
getViewArea()
Get the view area of this viewport.boolean
hasClip()
Returns true if this area will clip overflowing content.void
setClip(boolean c)
Set the clipping for this region viewport.void
setRegionReference(RegionReference reg)
Set the region-reference-area for this region viewport.void
setWritingModeTraits(WritingModeTraitsGetter wmtg)
Sets the writing mode traits for the region reference of this region viewport-
Methods inherited from class org.apache.fop.area.Area
activateEffectiveIPD, addChildArea, addTrait, getAllocBPD, getAllocIPD, getAreaClass, getBidiLevel, getBorderAndPaddingWidthAfter, getBorderAndPaddingWidthBefore, getBorderAndPaddingWidthEnd, getBorderAndPaddingWidthStart, getBPD, getEffectiveAllocIPD, getEffectiveIPD, getIPD, getSpaceAfter, getSpaceBefore, getSpaceEnd, getSpaceStart, getTrait, getTraitAsBoolean, getTraitAsInteger, getTraits, hasTrait, hasTraits, resetBidiLevel, setAreaClass, setBidiLevel, setBPD, setIPD, setTraits, toString
-
Methods inherited from class org.apache.fop.area.AreaTreeObject
addExtensionAttachment, getExtensionAttachments, getForeignAttributes, getForeignAttributeValue, hasExtensionAttachments, setExtensionAttachments, setForeignAttribute, setForeignAttributes
-
-
-
-
Method Detail
-
setRegionReference
public void setRegionReference(RegionReference reg)
Set the region-reference-area for this region viewport.- Parameters:
reg
- the child region-reference-area inside this viewport
-
getRegionReference
public RegionReference getRegionReference()
Get the region-reference-area for this region viewport.- Returns:
- the child region-reference-area inside this viewport
-
setClip
public void setClip(boolean c)
Set the clipping for this region viewport.- Parameters:
c
- the clipping value
-
hasClip
public boolean hasClip()
Returns true if this area will clip overflowing content.
-
getClipRectangle
public java.awt.Rectangle getClipRectangle()
Returns the clipping rectangle of this viewport area.- Specified by:
getClipRectangle
in interfaceViewport
- Returns:
- the clipping rectangle expressed in the viewport's coordinate system, or null if clipping is disabled
-
getViewArea
public java.awt.geom.Rectangle2D getViewArea()
Get the view area of this viewport.- Returns:
- the viewport rectangle area
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
-
setWritingModeTraits
public void setWritingModeTraits(WritingModeTraitsGetter wmtg)
Sets the writing mode traits for the region reference of this region viewport- Overrides:
setWritingModeTraits
in classArea
- Parameters:
wmtg
- a WM traits getter
-
-