123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258 |
- /*
- * Copyright 1999-2004 The Apache Software Foundation.
- *
- * Licensed 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 org.apache.fop.area.extensions.BookmarkData;
- import org.apache.fop.fo.extensions.Outline;
-
- import java.util.ArrayList;
- import java.util.List;
- import java.util.Map;
- import java.util.HashMap;
- import java.util.Set;
- import java.util.HashSet;
- import java.util.Iterator;
-
- /**
- * Area tree for formatting objects.
- *
- * Concepts:
- * The area tree is to be as small as possible. With minimal classes
- * and data to fully represent an area tree for formatting objects.
- * The area tree needs to be simple to render and follow the spec
- * closely.
- * This area tree has the concept of page sequences.
- * Where ever possible information is discarded or optimised to
- * keep memory use low. The data is also organised to make it
- * possible for renderers to minimise their output.
- * A page can be saved if not fully resolved and once rendered
- * a page contains only size and id reference information.
- * The area tree pages are organised in a model that depends on the
- * type of renderer.
- */
- public class AreaTree {
- // allows for different models to deal with adding/rendering
- // in different situations
- private AreaTreeModel model;
- private AreaTreeControl atControl;
-
- // hashmap of arraylists containing pages with id area
- private Map idLocations = new HashMap();
- // list of id's yet to be resolved and arraylists of pages
- private Map resolve = new HashMap();
- private List treeExtensions = new ArrayList();
-
- /**
- * Constructor.
- * @param atControl the AreaTreeControl object controlling this AreaTree
- */
- public AreaTree (AreaTreeControl atControl) {
- this.atControl = atControl;
- }
-
-
- /**
- * Create a new store pages model.
- * @return StorePagesModel the new model
- */
- public static StorePagesModel createStorePagesModel() {
- return new StorePagesModel();
- }
-
- /**
- * Set the tree model to use for this area tree.
- * The different models can have different behaviour
- * when pages area added and other changes.
- * @param m the area tree model
- */
- public void setTreeModel(AreaTreeModel m) {
- model = m;
- }
-
- /**
- * Get the area tree model for this area tree.
- *
- * @return AreaTreeModel the model being used for this area tree
- */
- public AreaTreeModel getAreaTreeModel() {
- return model;
- }
-
- /**
- * Start a new page sequence.
- * This signals that a new page sequence has started in the document.
- * @param title the title of the new page sequence or null if no title
- */
- public void startPageSequence(Title title) {
- model.startPageSequence(title);
- }
-
- /**
- * Add a new page to the area tree.
- * @param page the page to add
- */
- public void addPage(PageViewport page) {
- model.addPage(page);
- }
-
- /**
- * Add an id reference pointing to a page viewport.
- * @param id the id of the reference
- * @param pv the page viewport that contains the id reference
- */
- public void addIDRef(String id, PageViewport pv) {
- List list = (List)idLocations.get(id);
- if (list == null) {
- list = new ArrayList();
- idLocations.put(id, list);
- }
- list.add(pv);
-
- Set todo = (Set)resolve.get(id);
- if (todo != null) {
- for (Iterator iter = todo.iterator(); iter.hasNext();) {
- Resolveable res = (Resolveable)iter.next();
- res.resolve(id, list);
- }
- resolve.remove(id);
- }
- }
-
- /**
- * Get the list of id references for an id.
- * @param id the id to lookup
- * @return the list of id references.
- */
- public List getIDReferences(String id) {
- return (List)idLocations.get(id);
- }
-
- /**
- * Add an unresolved object with a given id.
- * @param id the id reference that needs resolving
- * @param res the Resolveable object to resolve
- */
- public void addUnresolvedID(String id, Resolveable res) {
- Set todo = (Set)resolve.get(id);
- if (todo == null) {
- todo = new HashSet();
- resolve.put(id, todo);
- }
- todo.add(res);
- }
-
- /**
- * Add a tree extension.
- * This checks if the extension is resolveable and attempts
- * to resolve or add the resolveable ids for later resolution.
- * @param ext the tree extension to add.
- */
- public void addTreeExtension(TreeExt ext) {
- treeExtensions.add(ext);
- if (ext.isResolveable()) {
- Resolveable res = (Resolveable)ext;
- String[] ids = res.getIDs();
- for (int count = 0; count < ids.length; count++) {
- if (idLocations.containsKey(ids[count])) {
- res.resolve(ids[count], (List)idLocations.get(ids[count]));
- } else {
- Set todo = (Set)resolve.get(ids[count]);
- if (todo == null) {
- todo = new HashSet();
- resolve.put(ids[count], todo);
- }
- todo.add(ext);
- }
- }
- } else {
- handleTreeExtension(ext, TreeExt.IMMEDIATELY);
- }
- }
-
- /**
- * Handle a tree extension.
- * This sends the extension to the model for handling.
- * @param ext the tree extension to handle
- * @param when when the extension should be handled by the model
- */
- public void handleTreeExtension(TreeExt ext, int when) {
- // queue tree extension according to the when
- model.addExtension(ext, when);
- }
-
- /**
- * Signal end of document.
- * This indicates that the document is complete and any unresolved
- * reference can be dealt with.
- */
- public void endDocument() {
- for (Iterator iter = resolve.keySet().iterator(); iter.hasNext();) {
- String id = (String)iter.next();
- Set list = (Set)resolve.get(id);
- for (Iterator resIter = list.iterator(); resIter.hasNext();) {
- Resolveable res = (Resolveable)resIter.next();
- if (!res.isResolved()) {
- res.resolve(id, null);
- }
- }
- }
- model.endDocument();
- }
-
- /**
- * Create the bookmark data in the area tree.
- */
- public void addBookmarksToAreaTree() {
- if (atControl.getBookmarks() == null) {
- return;
- }
- atControl.getLogger().debug("adding bookmarks to area tree");
- BookmarkData data = new BookmarkData();
- for (int count = 0; count < atControl.getBookmarks().getOutlines().size(); count++) {
- Outline out = (Outline)(atControl.getBookmarks().getOutlines()).get(count);
- data.addSubData(createBookmarkData(out));
- }
- addTreeExtension(data);
- data.setAreaTree(this);
- }
-
- /**
- * Create and return the bookmark data for this outline.
- * This creates a bookmark data with the destination
- * and adds all the data from child outlines.
- *
- * @param outline the Outline object for which a bookmark entry should be
- * created
- * @return the new bookmark data
- */
- public BookmarkData createBookmarkData(Outline outline) {
- BookmarkData data = new BookmarkData(outline.getInternalDestination());
- data.setLabel(outline.getLabel());
- for (int count = 0; count < outline.getOutlines().size(); count++) {
- Outline out = (Outline)(outline.getOutlines()).get(count);
- data.addSubData(createBookmarkData(out));
- }
- return data;
- }
-
- public AreaTreeControl getAreaTreeControl() {
- return atControl;
- }
-
- }
|