New feature: "Intermediate format" (IF). The IF is basically the XML dialect written by the area tree renderer (XMLRenderer). A new parser for this format allows reparsing a serialized and possibly modified area tree and rendering it to the final target format. More details on the Wiki at http://wiki.apache.org/xmlgraphics-fop/AreaTreeIntermediateXml. No advanced features have been implemented, yet, only the basic functionality. The whole change should be fully backwards-compatible WRT the outer FOP API except maybe for FOTreeBuilder.addElementMapping(), and the area tree XML which got small changes.
The area tree has been cleaned up. The serializability has been restored. The CachedRenderPagesModel works again and can, in certain situations, decrease the maximum amount of memory held at one point in time. Some adjustments were necessary in the area tree to help the work of the AreaTreeParser.
The AreaTreeParser is new and is responsible for parsing area tree XML files and adding pages to a RenderPagesModel instance. It is SAX-based and should be pretty efficient.
XMLUnit (http://xmlunit.sourceforge.net, BSD license) is a new dependency for the test code. It is used to verify the correctness of the intermediate format code. It doesn't have to be installed for the build to run through, though.
ElementMapping got a new method getDOMImplementation() which provides the DOMImplementation used to handle a subdocument of a particular namespace. For example, SVG uses Batik's SVG DOM. The AreaTreeParser needs that to properly recreate foreign objects because it can't use the mechanism of the FO tree. The default implementation returns null.
The ElementMapping instances are no longer maintained by the FOTreeBuilder, but by the newly created ElementMappingRegistry class. It is expected that the instance of this class is moved from the FOTreeBuilder and the AreaTreeParser's Handler class to the "environment class" once it is created to cut down on the startup time for each processed document.
The XMLRenderer has been slightly modified to improve the serialization/deserialization qualities of the area tree XML format.
The XMLRenderer can now mimic another renderer (see mimicRenderer(Renderer)) in order to use its font setup. That way it is made certain that the reparsed area tree will render to the final target format exactly as expected.
Fixed a bug in the XMLHandlerRegistry which did not always return the right XMLHandler for every situation.
Added a DefaultErrorListener to the util package. I've had problems with Xalan-J swallowing exceptions with its default ErrorListener, so I added a simple one for convenience and use in AreaTreeParser.
Example code for working with the AreaTreeParser can be found in examples/embedding. Documentation will follow.
git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@369753 13f79535-47bb-0310-9956-ffa450edef68
18 лет назад New feature: "Intermediate format" (IF). The IF is basically the XML dialect written by the area tree renderer (XMLRenderer). A new parser for this format allows reparsing a serialized and possibly modified area tree and rendering it to the final target format. More details on the Wiki at http://wiki.apache.org/xmlgraphics-fop/AreaTreeIntermediateXml. No advanced features have been implemented, yet, only the basic functionality. The whole change should be fully backwards-compatible WRT the outer FOP API except maybe for FOTreeBuilder.addElementMapping(), and the area tree XML which got small changes.
The area tree has been cleaned up. The serializability has been restored. The CachedRenderPagesModel works again and can, in certain situations, decrease the maximum amount of memory held at one point in time. Some adjustments were necessary in the area tree to help the work of the AreaTreeParser.
The AreaTreeParser is new and is responsible for parsing area tree XML files and adding pages to a RenderPagesModel instance. It is SAX-based and should be pretty efficient.
XMLUnit (http://xmlunit.sourceforge.net, BSD license) is a new dependency for the test code. It is used to verify the correctness of the intermediate format code. It doesn't have to be installed for the build to run through, though.
ElementMapping got a new method getDOMImplementation() which provides the DOMImplementation used to handle a subdocument of a particular namespace. For example, SVG uses Batik's SVG DOM. The AreaTreeParser needs that to properly recreate foreign objects because it can't use the mechanism of the FO tree. The default implementation returns null.
The ElementMapping instances are no longer maintained by the FOTreeBuilder, but by the newly created ElementMappingRegistry class. It is expected that the instance of this class is moved from the FOTreeBuilder and the AreaTreeParser's Handler class to the "environment class" once it is created to cut down on the startup time for each processed document.
The XMLRenderer has been slightly modified to improve the serialization/deserialization qualities of the area tree XML format.
The XMLRenderer can now mimic another renderer (see mimicRenderer(Renderer)) in order to use its font setup. That way it is made certain that the reparsed area tree will render to the final target format exactly as expected.
Fixed a bug in the XMLHandlerRegistry which did not always return the right XMLHandler for every situation.
Added a DefaultErrorListener to the util package. I've had problems with Xalan-J swallowing exceptions with its default ErrorListener, so I added a simple one for convenience and use in AreaTreeParser.
Example code for working with the AreaTreeParser can be found in examples/embedding. Documentation will follow.
git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@369753 13f79535-47bb-0310-9956-ffa450edef68
18 лет назад |
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231 |
- /*
- * 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 org.apache.fop.area.inline.InlineArea;
- import org.apache.fop.fo.Constants;
-
- import java.io.Serializable;
- import java.util.ArrayList;
- import java.util.List;
-
- /**
- * The line area.
- * This is a line area that contains inline areas.
- */
- public class LineArea extends Area {
-
- private static final long serialVersionUID = 7670235908329290684L;
-
- /**
- * this class stores information about line width and potential adjustments
- * that can be used in order to re-compute adjustement and / or indents when a
- * page-number or a page-number-citation is resolved
- */
- private final class LineAdjustingInfo implements Serializable {
-
- private static final long serialVersionUID = -6103629976229458273L;
-
- private int lineAlignment;
- private int difference;
- private int availableStretch;
- private int availableShrink;
- private double variationFactor;
- private boolean bAddedToAreaTree;
-
- private LineAdjustingInfo(int alignment, int diff,
- int stretch, int shrink) {
- lineAlignment = alignment;
- difference = diff;
- availableStretch = stretch;
- availableShrink = shrink;
- variationFactor = 1.0;
- bAddedToAreaTree = false;
- }
- }
-
- private LineAdjustingInfo adjustingInfo = null;
-
- // this class can contain the dominant char styling info
- // this means that many renderers can optimise a bit
-
- private List inlineAreas = new ArrayList();
-
- /**
- * default constructor:
- * nothing to do
- */
- public LineArea() {
- }
-
- /**
- * constructor with extra parameters:
- * a new LineAdjustingInfo object is created
- * @param alignment alignment of this line
- * @param diff difference between content width and line width
- * @param stretch the available stretch for any adjustments
- * @param shrink the available shrink for any adjustments
- */
- public LineArea(int alignment, int diff,
- int stretch, int shrink) {
- adjustingInfo = new LineAdjustingInfo(alignment, diff, stretch, shrink);
- }
-
- /**
- * Add a child area to this line area.
- *
- * @param childArea the inline child area to add
- */
- public void addChildArea(Area childArea) {
- if (childArea instanceof InlineArea) {
- addInlineArea((InlineArea)childArea);
- // set the parent area for the child area
- ((InlineArea) childArea).setParentArea(this);
- }
- }
-
- /**
- * Add an inline child area to this line area.
- *
- * @param area the inline child area to add
- */
- public void addInlineArea(InlineArea area) {
- inlineAreas.add(area);
- }
-
- /**
- * Get the inline child areas of this line area.
- *
- * @return the list of inline areas
- */
- public List getInlineAreas() {
- return inlineAreas;
- }
-
- /**
- * Get the start indent of this line area.
- * The start indent is used for offsetting the start of
- * the inline areas for alignment or other indents.
- *
- * @return the start indent value
- */
- public int getStartIndent() {
- if (hasTrait(Trait.START_INDENT)) {
- return getTraitAsInteger(Trait.START_INDENT);
- } else {
- return 0;
- }
- }
-
- /**
- * Updates the extents of the line area from its children.
- */
- public void updateExtentsFromChildren() {
- int ipd = 0;
- int bpd = 0;
- for (int i = 0, len = inlineAreas.size(); i < len; i++) {
- ipd = Math.max(ipd, ((InlineArea)inlineAreas.get(i)).getAllocIPD());
- bpd += ((InlineArea)inlineAreas.get(i)).getAllocBPD();
- }
- setIPD(ipd);
- setBPD(bpd);
- }
-
- /**
- * receive notification about the ipd variation of a descendant area
- * and perform the needed adjustment, according to the alignment;
- * in particular:
- * <ul>
- * <li>left-aligned text needs no adjustement;</li>
- * <li>right-aligned text and centered text are handled locally,
- * adjusting the indent of this LineArea;</li>
- * <li>justified text requires a more complex adjustment, as the
- * variation factor computed on the basis of the total
- * stretch and shrink of the line must be applied in every
- * descendant leaf areas (text areas and leader areas).</li>
- * </ul>
- * @param ipdVariation the difference between old and new ipd
- */
- public void handleIPDVariation(int ipdVariation) {
- switch (adjustingInfo.lineAlignment) {
- case Constants.EN_START:
- // nothing to do in this case
- break;
- case Constants.EN_CENTER:
- // re-compute indent
- addTrait(Trait.START_INDENT, new Integer(getStartIndent() - ipdVariation / 2));
- break;
- case Constants.EN_END:
- // re-compute indent
- addTrait(Trait.START_INDENT, new Integer(getStartIndent() - ipdVariation));
- break;
- case Constants.EN_JUSTIFY:
- // compute variation factor
- adjustingInfo.variationFactor *= (float) (adjustingInfo.difference - ipdVariation)
- / adjustingInfo.difference;
- adjustingInfo.difference -= ipdVariation;
- // if the LineArea has already been added to the area tree,
- // call finalize(); otherwise, wait for the LineLM to call it
- if (adjustingInfo.bAddedToAreaTree) {
- finalise();
- }
- break;
- default:
- throw new RuntimeException();
- }
- }
-
- /**
- * apply the variation factor to all descendant areas
- * and destroy the AdjustingInfo object if there are
- * no UnresolvedAreas left
- */
- public void finalise() {
- if (adjustingInfo.lineAlignment == Constants.EN_JUSTIFY) {
- // justified line: apply the variation factor
- boolean bUnresolvedAreasPresent = false;
- // recursively apply variation factor to descendant areas
- for (int i = 0, len = inlineAreas.size(); i < len; i++) {
- bUnresolvedAreasPresent |= ((InlineArea) inlineAreas.get(i))
- .applyVariationFactor(adjustingInfo.variationFactor,
- adjustingInfo.availableStretch,
- adjustingInfo.availableShrink);
- }
- if (!bUnresolvedAreasPresent) {
- // there are no more UnresolvedAreas:
- // destroy the AdjustingInfo instance
- adjustingInfo = null;
- } else {
- // this method will be called again later:
- // the first time, it is called by the LineLM,
- // afterwards it must be called by the LineArea itself
- if (!adjustingInfo.bAddedToAreaTree) {
- adjustingInfo.bAddedToAreaTree = true;
- }
- // reset the variation factor
- adjustingInfo.variationFactor = 1.0;
- }
- } else {
- // the line is not justified: the ipd variation has already
- // been handled, modifying the line indent
- }
- }
- }
-
|