org.apache.fop.fo.flow.table.TableAndCaption Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of fop Show documentation
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.
/*
* 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: TableAndCaption.java 1681384 2015-05-23 21:07:13Z adelmelle $ */
package org.apache.fop.fo.flow.table;
// XML
import org.xml.sax.Locator;
import org.apache.fop.apps.FOPException;
import org.apache.fop.fo.FONode;
import org.apache.fop.fo.FObj;
import org.apache.fop.fo.PropertyList;
import org.apache.fop.fo.ValidationException;
import org.apache.fop.fo.properties.CommonAccessibility;
import org.apache.fop.fo.properties.CommonAccessibilityHolder;
/**
* Class modelling the
* fo:table-and-caption
property.
* TODO needs implementation
*/
public class TableAndCaption extends FObj implements CommonAccessibilityHolder {
private CommonAccessibility commonAccessibility;
// The value of properties relevant for fo:table-and-caption.
// Unused but valid items, commented out for performance:
// private CommonAural commonAural;
// private CommonBorderPaddingBackground commonBorderPaddingBackground;
// private CommonMarginBlock commonMarginBlock;
// private CommonRelativePosition commonRelativePosition;
// private int breakAfter;
// private int breakBefore;
// private int captionSide;
// private int intrusionDisplace;
// private KeepProperty keepTogether;
// private KeepProperty keepWithNext;
// private KeepProperty keepWithPrevious;
// private int textAlign;
// End of property values
static boolean notImplementedWarningGiven;
/** used for FO validation */
private boolean tableCaptionFound;
private boolean tableFound;
/**
* Create a TableAndCaption instance with the given {@link FONode}
* as parent.
* @param parent FONode that is the parent of this object
*/
public TableAndCaption(FONode parent) {
super(parent);
if (!notImplementedWarningGiven) {
getFOValidationEventProducer().unimplementedFeature(this, getName(),
"fo:table-and-caption", getLocator());
// @SuppressFBWarnings("ST_WRITE_TO_STATIC_FROM_INSTANCE_METHOD")
notImplementedWarningGiven = true;
}
}
@Override
public void bind(PropertyList pList) throws FOPException {
super.bind(pList);
commonAccessibility = CommonAccessibility.getInstance(pList);
}
/**
* Make sure content model satisfied, if so then tell the
* FOEventHandler that we are at the end of the flow.
* {@inheritDoc}
*/
public void endOfNode() throws FOPException {
if (!tableFound) {
missingChildElementError("marker* table-caption? table");
}
}
/**
* {@inheritDoc}
*
XSL Content Model: marker* table-caption? table
*/
protected void validateChildNode(Locator loc, String nsURI, String localName)
throws ValidationException {
if (FO_URI.equals(nsURI)) {
if (localName.equals("marker")) {
if (tableCaptionFound) {
nodesOutOfOrderError(loc, "fo:marker", "fo:table-caption");
} else if (tableFound) {
nodesOutOfOrderError(loc, "fo:marker", "fo:table");
}
} else if (localName.equals("table-caption")) {
if (tableCaptionFound) {
tooManyNodesError(loc, "fo:table-caption");
} else if (tableFound) {
nodesOutOfOrderError(loc, "fo:table-caption", "fo:table");
} else {
tableCaptionFound = true;
}
} else if (localName.equals("table")) {
if (tableFound) {
tooManyNodesError(loc, "fo:table");
} else {
tableFound = true;
}
} else {
invalidChildError(loc, nsURI, localName);
}
}
}
/** {@inheritDoc} */
public String getLocalName() {
return "table-and-caption";
}
/**
* {@inheritDoc}
* @return {@link org.apache.fop.fo.Constants#FO_TABLE_AND_CAPTION}
*/
public int getNameId() {
return FO_TABLE_AND_CAPTION;
}
/** {@inheritDoc} */
public CommonAccessibility getCommonAccessibility() {
return commonAccessibility;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy