org.apache.fop.render.ps.PSTranscoder Maven / Gradle / Ivy

Go to download

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.10

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: PSTranscoder.java 1297284 2012-03-05 23:29:29Z gadams $ */

package org.apache.fop.render.ps;

import org.apache.xmlgraphics.java2d.ps.AbstractPSDocumentGraphics2D;
import org.apache.xmlgraphics.java2d.ps.PSDocumentGraphics2D;

/**
 * This class enables to transcode an input to a PostScript document.
 *
 * Two transcoding hints (KEY_WIDTH and
 * KEY_HEIGHT) can be used to respectively specify the image
 * width and the image height. If only one of these keys is specified,
 * the transcoder preserves the aspect ratio of the original image.
 *
 * 
The KEY_BACKGROUND_COLOR defines the background color
 * to use for opaque image formats, or the background color that may
 * be used for image formats that support alpha channel.
 *
 * 
The KEY_AOI represents the area of interest to paint
 * in device space.
 *
 * 
Three additional transcoding hints that act on the SVG
 * processor can be specified:
 *
 * 
KEY_LANGUAGE to set the default language to use (may be
 * used by a <switch> SVG element for example),
 * KEY_USER_STYLESHEET_URI to fix the URI of a user
 * stylesheet, and KEY_PIXEL_TO_MM to specify the pixel to
 * millimeter conversion factor.
 *
 * 
This work was authored by Keiron Liddle ([email protected]).
 */
public class PSTranscoder extends AbstractPSTranscoder {

    /**
     * Constructs a new {@link PSTranscoder}.
     */
    public PSTranscoder() {
        super();
    }

    /** {@inheritDoc} */
    protected AbstractPSDocumentGraphics2D createDocumentGraphics2D() {
        return new PSDocumentGraphics2D(false);
    }

}