org.apache.fop.complexscripts.fonts.GlyphPositioning Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of fop Show documentation

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.

There is a newer version: 2.9

Show newest version

/*
 * 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.complexscripts.fonts;

// CSOFF: LineLengthCheck

/**
 * The GlyphPositioning interface is implemented by a glyph positioning subtable
 * that supports the determination of glyph positioning information based on script and
 * language of the corresponding character content.
 *
 * This work was originally authored by Glenn Adams ([email protected]).
 */
public interface GlyphPositioning {

    /**
     * Perform glyph positioning at the current index, mutating the positioning state object as required.
     * Only the context associated with the current index is processed.
     * @param ps glyph positioning state object
     * @return true if the glyph subtable applies, meaning that the current context matches the
     * associated input context glyph coverage table; note that returning true does not mean any position
     * adjustment occurred; it only means that no further glyph subtables for the current lookup table
     * should be applied.
     */
    boolean position(GlyphPositioningState ps);

}