| /* |
| * 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$ */ |
| package org.apache.fop.fo.flow; |
| |
| import org.apache.fop.fo.FONode; |
| import org.apache.fop.fo.PropertyList; |
| import org.apache.fop.apps.FOPException; |
| import org.xml.sax.Locator; |
| import org.xml.sax.Attributes; |
| |
| /** |
| * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_retrieve-table-marker"> |
| * <code>fo:retrieve-table-marker</code></a> formatting object. |
| */ |
| public class RetrieveTableMarker extends AbstractRetrieveMarker { |
| |
| // The value of properties relevant for fo:retrieve-table-marker. |
| private int retrievePositionWithinTable; |
| private int retrieveBoundaryWithinTable; |
| // end property values |
| |
| /** |
| * Create a new RetrieveTableMarker instance that is |
| * a child of the given {@link FONode}. |
| * |
| * @param parent the parent {@link FONode} |
| */ |
| public RetrieveTableMarker(FONode parent) { |
| super(parent); |
| } |
| |
| /** |
| * {@inheritDoc} |
| * <i>NOTE: An <code>fo:retrieve-table-marker</code> is only permitted as a descendant |
| * of an <code>fo:table-header</code> or an <code>fo:table-footer</code>.</i> |
| */ |
| public void processNode(String elementName, Locator locator, Attributes attlist, PropertyList pList) throws FOPException { |
| if (findAncestor(FO_TABLE_HEADER) < 0 |
| && findAncestor(FO_TABLE_FOOTER) < 0) { |
| invalidChildError(locator, getParent().getName(), FO_URI, getName(), |
| "rule.retrieveTableMarkerDescendantOfHeaderOrFooter"); |
| } else { |
| super.processNode(elementName, locator, attlist, pList); |
| } |
| } |
| |
| /** {@inheritDoc} */ |
| public void bind(PropertyList pList) throws FOPException { |
| super.bind(pList); |
| this.retrievePositionWithinTable |
| = pList.get(PR_RETRIEVE_POSITION_WITHIN_TABLE).getEnum(); |
| this.retrieveBoundaryWithinTable |
| = pList.get(PR_RETRIEVE_BOUNDARY_WITHIN_TABLE).getEnum(); |
| } |
| |
| /** |
| * Return the value for the <code>retrieve-position-within-table</code> |
| * property |
| * @return the value for retrieve-position-within-table; one of |
| * {@link org.apache.fop.fo.Constants#EN_FIRST_STARTING}, |
| * {@link org.apache.fop.fo.Constants#EN_FIC}, |
| * {@link org.apache.fop.fo.Constants#EN_LAST_STARTING}, |
| * {@link org.apache.fop.fo.Constants#EN_LAST_ENDING}. |
| */ |
| public int getRetrievePositionWithinTable() { |
| return this.retrievePositionWithinTable; |
| } |
| |
| /** |
| * Return the value for the <code>retrieve-boundary-within-table</code> |
| * property |
| * @return the value for retrieve-boundary-within-table; one of |
| * {@link org.apache.fop.fo.Constants#EN_TABLE}, |
| * {@link org.apache.fop.fo.Constants#EN_TABLE_FRAGMENT}, |
| * {@link org.apache.fop.fo.Constants#EN_PAGE}. |
| */ |
| public int getRetrieveBoundaryWithinTable() { |
| return this.retrieveBoundaryWithinTable; |
| } |
| |
| /** {@inheritDoc} */ |
| public String getLocalName() { |
| return "retrieve-table-marker"; |
| } |
| |
| /** |
| * {@inheritDoc} |
| * @return {@link org.apache.fop.fo.Constants#FO_RETRIEVE_TABLE_MARKER} |
| */ |
| public int getNameId() { |
| return FO_RETRIEVE_TABLE_MARKER; |
| } |
| } |