org.apache.fop.afp.modca.triplets.MappingOptionTriplet 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: MappingOptionTriplet.java 769445 2009-04-28 16:10:08Z vhennebert $ */

package org.apache.fop.afp.modca.triplets;

import java.io.IOException;
import java.io.OutputStream;

/**
 * Specifies the mapping of data object presentation space to object area
 */
public class MappingOptionTriplet extends AbstractTriplet {
    /**
     * the data object is placed in the upper left corner, all data must be presented
     * within the object area extents
     */
    public static final byte POSITION = 0x00;

    /**
     * the data object is placed in the upper left corner, all data that falls within
     * the object area extents will be presented but data that falls outside will not be presented
     */
    public static final byte POSITION_AND_TRIM = 0x10;

    /**
     * the data object is centred and symmetrically scaled up or down
     * while preserving aspect ratio
     */
    public static final byte SCALE_TO_FIT = 0x20;

    /**
     * the data object is centred, all data that falls within the object area extents
     * will be presented but data that falls outside will not be presented
     */
    public static final byte CENTER_AND_TRIM = 0x30;

    /** Migration mapping option: Image point-to-pel. */
    public static final byte IMAGE_POINT_TO_PEL = 0x41;

    /** Migration mapping option: Image point-to-pel with double dot. */
    public static final byte IMAGE_POINT_TO_PEL_DOUBLE_DOT = 0x42;

    /** Migration mapping option: Replicate and trim. */
    public static final byte REPLICATE_AND_TRIM = 0x50;

    /** the data object is centred, aspect ratio is not always preserved */
    public static final byte SCALE_TO_FILL = 0x60;

    /** used to map ip3i print data objects */
    public static final byte UP3I_PRINT_DATA = 0x70;

    private final byte mapValue;

    /**
     * Main constructor
     *
     * @param mapValue the mapping option to use
     */
    public MappingOptionTriplet(byte mapValue) {
        super(AbstractTriplet.MAPPING_OPTION);
        this.mapValue = mapValue;
    }

    /** {@inheritDoc} */
    public int getDataLength() {
        return 3;
    }

    /** {@inheritDoc} */
    public void writeToStream(OutputStream os) throws IOException {
        byte[] data = getData();
        data[2] = mapValue;

        os.write(data);
    }
}