http://xmlgraphics.apache.org/fop/: Apache FOP (Formatting Objects Processor) is the world's first print formatter driven by XSL formatting objects (XSL-FO) and the world's first output independent formatter. It is a Java application that reads a formatting object (FO) tree and renders the resulting pages to a specified output. Output formats currently supported include PDF, PCL, PS, AFP, TIFF, PNG, SVG, XML (area tree representation), Print, AWT and TXT. The primary output target is PDF. (Apache Software Foundation) 
/*
 * 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: InlineLevelLayoutManager.java 1052561 2010-12-24 19:28:11Z spepping $ */

package org.apache.fop.layoutmgr.inline;

import java.util.List;

import org.apache.fop.layoutmgr.LayoutManager;
import org.apache.fop.layoutmgr.Position;


The interface for LayoutManagers which generate inline areas

/**
 * The interface for LayoutManagers which generate inline areas
 */
public interface InlineLevelLayoutManager extends LayoutManager {

    
Tell the LM to modify its data, adding a letter space
to the word fragment represented by the given elements,
and returning the corrected elements

Params:
  • oldList – the elements which must be given one more letter space
Returns:       the new elements replacing the old ones
/**
     * Tell the LM to modify its data, adding a letter space
     * to the word fragment represented by the given elements,
     * and returning the corrected elements
     *
     * @param oldList the elements which must be given one more letter space
     * @return        the new elements replacing the old ones
     */
    List addALetterSpaceTo(List oldList);

    
Tell the LM to modify its data, adding a letter space
to the word fragment represented by the given elements,
and returning the corrected elements

Params:
  • oldList – the elements which must be given one more letter space
  • depth – the depth at which the Positions for this LM in oldList are found
Returns:       the new elements replacing the old ones
/**
     * Tell the LM to modify its data, adding a letter space
     * to the word fragment represented by the given elements,
     * and returning the corrected elements
     *
     * @param oldList the elements which must be given one more letter space
     * @param depth the depth at which the Positions for this LM in oldList are found
     * @return        the new elements replacing the old ones
     */
List addALetterSpaceTo(List oldList, int depth);

    
Get the word chars corresponding to the given position.

Params:
  • pos –     the position referring to the needed word chars.
Returns:the word chars
/**
     * Get the word chars corresponding to the given position.
     *
     * @param pos     the position referring to the needed word chars.
     * @return the word chars
     */
    String getWordChars(Position pos);

    
Tell the LM to hyphenate a word

Params:
  • pos – the Position referring to the word
  • hyphContext –  the HyphContext storing hyphenation information
/**
     * Tell the LM to hyphenate a word
     *
     * @param pos the Position referring to the word
     * @param hyphContext  the HyphContext storing hyphenation information
     */
    void hyphenate(Position pos, HyphContext hyphContext);

    
Tell the LM to apply the changes due to hyphenation

Params:
  • oldList – the list of the old elements the changes refer to
Returns:       true if the LM had to change its data, false otherwise
/**
     * Tell the LM to apply the changes due to hyphenation
     *
     * @param oldList the list of the old elements the changes refer to
     * @return        true if the LM had to change its data, false otherwise
     */
    boolean applyChanges(List oldList);

    
Tell the LM to apply the changes due to hyphenation

Params:
  • oldList – the list of the old elements the changes refer to
  • depth – the depth at which the Positions for this LM in oldList are found
Returns:       true if the LM had to change its data, false otherwise
/**
     * Tell the LM to apply the changes due to hyphenation
     *
     * @param oldList the list of the old elements the changes refer to
     * @param depth the depth at which the Positions for this LM in oldList are found
     * @return        true if the LM had to change its data, false otherwise
     */
    boolean applyChanges(List oldList, int depth);

    
Get a sequence of KnuthElements representing the content
of the node assigned to the LM, after changes have been applied

Params:
  • oldList –        the elements to replace
  • alignment –      the desired text alignment
  • depth – the depth at which the Positions for this LM in oldList are found
Returns:              the updated list of KnuthElements
/**
     * Get a sequence of KnuthElements representing the content
     * of the node assigned to the LM, after changes have been applied
     * @param oldList        the elements to replace
     * @param alignment      the desired text alignment
     * @param depth the depth at which the Positions for this LM in oldList are found
     * @return               the updated list of KnuthElements
     **/
    List getChangedKnuthElements(List oldList, int alignment, int depth);

}