123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163 |
- /*
- * 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$ */
-
- package org.apache.fop.area;
-
- import java.util.ArrayList;
- import java.util.List;
-
- import org.apache.fop.fo.pagination.Region;
-
- /**
- * This is a region reference area for a page regions.
- * This area is the direct child of a region-viewport-area. It is cloneable
- * so the page master can make copies from the original page and regions.
- */
- public class RegionReference extends Area {
-
- private static final long serialVersionUID = -298980963268244238L;
-
- private int regionClass;
- private String regionName;
- private CTM ctm;
-
- // the list of block areas from the static flow
- private ArrayList<Area> blocks = new ArrayList<Area>();
-
- /** the parent {@link RegionViewport} for this object */
- protected RegionViewport regionViewport;
-
- /**
- * Create a new region reference area.
- *
- * @param regionFO the region.
- * @param parent the viewport for this region.
- */
- public RegionReference(Region regionFO, RegionViewport parent) {
- this(regionFO.getNameId(), regionFO.getRegionName(), parent);
- }
-
- /**
- * Create a new region reference area.
- *
- * @param regionClass the region class (as returned by Region.getNameId())
- * @param regionName the name of the region (as returned by Region.getRegionName())
- * @param parent the viewport for this region.
- */
- public RegionReference(int regionClass, String regionName, RegionViewport parent) {
- this.regionClass = regionClass;
- this.regionName = regionName;
- addTrait(Trait.IS_REFERENCE_AREA, Boolean.TRUE);
- regionViewport = parent;
- }
-
- /** {@inheritDoc} */
- @Override
- public void addChildArea(Area child) {
- blocks.add(child);
- }
-
- /**
- * Set the Coordinate Transformation Matrix which transforms content
- * coordinates in this region reference area which are specified in
- * terms of "start" and "before" into coordinates in a system which
- * is positioned in "absolute" directions (with origin at lower left of
- * the region reference area.
- *
- * @param ctm the current transform to position this region
- */
- public void setCTM(CTM ctm) {
- this.ctm = ctm;
- }
-
- /**
- * @return Returns the parent RegionViewport.
- */
- public RegionViewport getRegionViewport() {
- return regionViewport;
- }
-
- /**
- * Get the current transform of this region.
- *
- * @return ctm the current transform to position this region
- */
- public CTM getCTM() {
- return this.ctm;
- }
-
- /**
- * Get the block in this region.
- *
- * @return the list of blocks in this region
- */
- public List<Area> getBlocks() {
- return blocks;
- }
-
- /**
- * Get the region class of this region.
- *
- * @return the region class
- */
- public int getRegionClass() {
- return this.regionClass;
- }
-
- /** @return the region name */
- public String getRegionName() {
- return this.regionName;
- }
-
- /**
- * Add a block area to this region reference area.
- *
- * @param block the block area to add
- */
- public void addBlock(Block block) {
- addChildArea(block);
- }
-
- /**
- * indicates whether the main reference area has any child areas added to it
- *
- * @return whether the main reference area has any child areas added to it
- */
- public boolean isEmpty() {
- return true;
- }
-
- /** {@inheritDoc} */
- public Object clone() throws CloneNotSupportedException {
- RegionReference rr = (RegionReference) super.clone();
- rr.blocks = (ArrayList) blocks.clone();
- return rr;
- }
-
- /** {@inheritDoc} */
- @Override
- public String toString() {
- StringBuffer sb = new StringBuffer(super.toString());
- sb.append(" {regionName=").append(regionName);
- sb.append(", regionClass=").append(regionClass);
- sb.append(", ctm=").append(ctm);
- sb.append("}");
- return sb.toString();
- }
- }
|