org.apache.fop.render.afp.extensions.AFPInvokeMediumMapElement 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: AFPInvokeMediumMapElement.java 1465599 2013-04-08 11:51:52Z vhennebert $ */

package org.apache.fop.render.afp.extensions;

import org.apache.fop.apps.FOPException;
import org.apache.fop.fo.Constants;
import org.apache.fop.fo.FONode;
import org.apache.fop.fo.extensions.ExtensionAttachment;

/**
 * This class represents an AFP-specific extension element to embed Invoke Medium Map (IMM)
 * fields at the beginning of a page group or just prior to a Page. The element is optional
 * and expected as a direct child of an fo:page-sequence or fo:simple-page-master
 */
public class AFPInvokeMediumMapElement extends AbstractAFPExtensionObject {

    /**
     * Constructs the AFP extension object (called by Maker).
     * @param parent the parent formatting object
     */
    public AFPInvokeMediumMapElement(FONode parent) {
        super(parent, AFPElementMapping.INVOKE_MEDIUM_MAP);
    }

    /** {@inheritDoc} */
    public void startOfNode() throws FOPException {
        super.startOfNode();
        if (parent.getNameId() != Constants.FO_PAGE_SEQUENCE
                && parent.getNameId() != Constants.FO_SIMPLE_PAGE_MASTER) {

            invalidChildError(getLocator(), parent.getName(), getNamespaceURI(), getName(),
                "rule.childOfPageSequence");
        }
    }

    /** {@inheritDoc} */
    protected ExtensionAttachment instantiateExtensionAttachment() {
        return new AFPInvokeMediumMap();
    }
}