org.apache.fop.fo.flow.Inline Maven / Gradle / Ivy
/*
* 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: Inline.java 1657867 2015-02-06 15:40:36Z ssteiner $ */
package org.apache.fop.fo.flow;
import org.xml.sax.Locator;
import org.apache.fop.apps.FOPException;
import org.apache.fop.datatypes.Length;
import org.apache.fop.fo.FONode;
import org.apache.fop.fo.PropertyList;
import org.apache.fop.fo.ValidationException;
/**
* Class modelling the
* fo:inline formatting object.
*/
public class Inline extends InlineLevel {
// The value of properties relevant for fo:inline.
// See also superclass InlineLevel
private Length alignmentAdjust;
private int alignmentBaseline;
private Length baselineShift;
private int dominantBaseline;
// Unused but valid items, commented out for performance:
// private CommonRelativePosition commonRelativePosition;
// private LengthRangeProperty blockProgressionDimension;
// private Length height;
// private LengthRangeProperty inlineProgressionDimension;
// private Length width;
// private int wrapOption;
// End of property values
// used for FO validation
private boolean blockOrInlineItemFound;
private boolean canHaveBlockLevelChildren = true;
private String abbreviation;
/**
* Base constructor
*
* @param parent {@link FONode} that is the parent of this object
*/
public Inline(FONode parent) {
super(parent);
}
/** {@inheritDoc} */
public void bind(PropertyList pList) throws FOPException {
super.bind(pList);
alignmentAdjust = pList.get(PR_ALIGNMENT_ADJUST).getLength();
alignmentBaseline = pList.get(PR_ALIGNMENT_BASELINE).getEnum();
baselineShift = pList.get(PR_BASELINE_SHIFT).getLength();
dominantBaseline = pList.get(PR_DOMINANT_BASELINE).getEnum();
if (getUserAgent().isAccessibilityEnabled()) {
abbreviation = pList.get(PR_X_ABBREVIATION).getString();
}
}
/** {@inheritDoc} */
public void startOfNode() throws FOPException {
super.startOfNode();
/* Check to see if this node can have block-level children.
* See validateChildNode() below.
*/
int lvlLeader = findAncestor(FO_LEADER);
int lvlFootnote = findAncestor(FO_FOOTNOTE);
int lvlInCntr = findAncestor(FO_INLINE_CONTAINER);
if (lvlLeader > 0) {
if (lvlInCntr < 0
|| (lvlInCntr > 0 && lvlInCntr > lvlLeader)) {
canHaveBlockLevelChildren = false;
}
} else if (lvlFootnote > 0) {
if (lvlInCntr < 0 || lvlInCntr > lvlFootnote) {
canHaveBlockLevelChildren = false;
}
}
getFOEventHandler().startInline(this);
}
/** {@inheritDoc} */
public void endOfNode() throws FOPException {
super.endOfNode();
getFOEventHandler().endInline(this);
}
/**
* {@inheritDoc}
*
XSL Content Model: marker* (#PCDATA|%inline;|%block;)*
*
Additionally: " An fo:inline that is a descendant of an fo:leader
* or fo:footnote may not have block-level children, unless it has a
* nearer ancestor that is an fo:inline-container." (paraphrased)
*/
protected void validateChildNode(Locator loc, String nsURI, String localName)
throws ValidationException {
if (FO_URI.equals(nsURI)) {
if (localName.equals("marker")) {
if (blockOrInlineItemFound) {
nodesOutOfOrderError(loc, "fo:marker",
"(#PCDATA|%inline;|%block;)");
}
} else if (!isBlockOrInlineItem(nsURI, localName)) {
invalidChildError(loc, nsURI, localName);
} else if (!canHaveBlockLevelChildren && isBlockItem(nsURI, localName)
&& !isNeutralItem(nsURI, localName)) {
invalidChildError(loc, getName(), nsURI, localName, "rule.inlineContent");
} else {
blockOrInlineItemFound = true;
}
}
}
/** @return the "alignment-adjust" property */
public Length getAlignmentAdjust() {
return alignmentAdjust;
}
/** @return the "alignment-baseline" property */
public int getAlignmentBaseline() {
return alignmentBaseline;
}
/** @return the "baseline-shift" property */
public Length getBaselineShift() {
return baselineShift;
}
/** @return the "dominant-baseline" property */
public int getDominantBaseline() {
return dominantBaseline;
}
/** {@inheritDoc} */
public String getLocalName() {
return "inline";
}
/**
* {@inheritDoc}
* @return {@link org.apache.fop.fo.Constants#FO_INLINE}
*/
public int getNameId() {
return FO_INLINE;
}
public String getAbbreviation() {
return abbreviation;
}
}