org.apache.fop.area

Class RegionViewport

Implemented Interfaces:
Cloneable, Serializable

public class RegionViewport
extends Area
implements Cloneable

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.

Field Summary

Fields inherited from class org.apache.fop.area.Area

BT, CLASS_ABSOLUTE, CLASS_BEFORE_FLOAT, CLASS_FIXED, CLASS_FOOTNOTE, CLASS_MAX, CLASS_NORMAL, CLASS_SIDE_FLOAT, LR, ORIENT_0, ORIENT_180, ORIENT_270, ORIENT_90, RL, TB, bpd, ipd, log, props

Fields inherited from class org.apache.fop.area.AreaTreeObject

foreignAttributes

Constructor Summary

RegionViewport(Rectangle2D viewArea)
Create a new region-viewport-area

Method Summary

Object
clone()
Clone this region viewport.
RegionReference
getRegionReference()
Get the region-reference-area for this region viewport.
Rectangle2D
getViewArea()
Get the view area of this viewport.
boolean
isClip()
void
setClip(boolean c)
Set the clipping for this region viewport.
void
setRegionReference(RegionReference reg)
Set the region-reference-area for this region viewport.

Methods inherited from class org.apache.fop.area.Area

addChildArea, addTrait, addTrait, getAllocBPD, getAllocIPD, getAreaClass, getBPD, getBooleanTrait, getBorderAndPaddingWidthAfter, getBorderAndPaddingWidthBefore, getBorderAndPaddingWidthEnd, getBorderAndPaddingWidthStart, getIPD, getSpaceAfter, getSpaceBefore, getSpaceEnd, getSpaceStart, getTrait, getTraitAsInteger, getTraits, hasTrait, hasTraits, setAreaClass, setBPD, setIPD, toString

Methods inherited from class org.apache.fop.area.AreaTreeObject

getForeignAttributeValue, getForeignAttributes, setForeignAttribute, setForeignAttributes

Constructor Details

RegionViewport

public RegionViewport(Rectangle2D viewArea)
Create a new region-viewport-area
Parameters:
viewArea - the view area of this viewport

Method Details

clone

public Object clone()
Clone this region viewport. Used when creating a copy from the page master.
Returns:
a new copy of this region viewport

getRegionReference

public RegionReference getRegionReference()
Get the region-reference-area for this region viewport.
Returns:
the child region-reference-area inside this viewport

getViewArea

public Rectangle2D getViewArea()
Get the view area of this viewport.
Returns:
the viewport rectangle area

isClip

public boolean isClip()
Returns:
true if the viewport should be clipped.

setClip

public void setClip(boolean c)
Set the clipping for this region viewport.
Parameters:
c - the clipping value

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

Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.