org.apache.fop.area.BlockViewport Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/* $Id: BlockViewport.java 1642793 2014-12-02 00:29:57Z lbernardo $ */
package org.apache.fop.area;
import java.awt.Rectangle;
/**
* A BlockViewport.
* This is used for block level Viewport/reference pairs.
* The block-container creates this area.
*/
public class BlockViewport extends Block implements Viewport {
private static final long serialVersionUID = -7840580922580735157L;
// clipping for this viewport
private boolean clip;
// transform if rotated or absolute
private CTM viewportCTM;
/**
* Create a new block viewport area.
*/
public BlockViewport() {
this(false);
}
/**
* Create a new block viewport area.
* @param allowBPDUpdate true allows the BPD to be updated when children are added
*/
public BlockViewport(boolean allowBPDUpdate) {
this.allowBPDUpdate = allowBPDUpdate;
}
/**
* Set the transform of this viewport.
* If the viewport is rotated or has an absolute positioning
* this transform will do the work.
*
* @param ctm the transformation
*/
public void setCTM(CTM ctm) {
viewportCTM = ctm;
}
/**
* Get the transform of this block viewport.
*
* @return the transformation of this viewport
* or null if normally stacked without rotation
*/
public CTM getCTM() {
return viewportCTM;
}
/**
* Set the clipping for this viewport.
*
* @param cl the clipping for the viewport
*/
public void setClip(boolean cl) {
clip = cl;
}
/** {@inheritDoc} */
public boolean hasClip() {
return clip;
}
/** {@inheritDoc} */
public Rectangle getClipRectangle() {
if (clip) {
return new Rectangle(getIPD(), getBPD());
} else {
return null;
}
}
public int getEffectiveIPD() {
return getIPD();
}
}