| /* |
| * 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.pagination; |
| |
| // 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; |
| |
| /** |
| * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_single-page-master-reference"> |
| * <code>fo:single-page-master-reference</code></a> object. |
| * This is a reference for a single page. It returns the |
| * master name only once until reset. |
| */ |
| public class SinglePageMasterReference extends FObj |
| implements SubSequenceSpecifier { |
| |
| // The value of properties relevant for fo:single-page-master-reference. |
| private String masterReference; |
| // End of property values |
| |
| private static final int FIRST = 0; |
| private static final int DONE = 1; |
| |
| private int state; |
| |
| /** |
| * Creates a new SinglePageMasterReference instance that is |
| * a child of the given {@link FONode}. |
| * @param parent {@link FONode} that is the parent of this object |
| */ |
| public SinglePageMasterReference(FONode parent) { |
| super(parent); |
| this.state = FIRST; |
| } |
| |
| /** {@inheritDoc} */ |
| public void bind(PropertyList pList) throws FOPException { |
| masterReference = pList.get(PR_MASTER_REFERENCE).getString(); |
| |
| if (masterReference == null || masterReference.equals("")) { |
| missingPropertyError("master-reference"); |
| } |
| } |
| |
| /** {@inheritDoc} */ |
| protected void startOfNode() throws FOPException { |
| PageSequenceMaster pageSequenceMaster = (PageSequenceMaster) parent; |
| pageSequenceMaster.addSubsequenceSpecifier(this); |
| } |
| |
| /** |
| * {@inheritDoc} |
| * <br>XSL Content Model: empty |
| */ |
| protected void validateChildNode(Locator loc, String nsURI, String localName) |
| throws ValidationException { |
| if (FO_URI.equals(nsURI)) { |
| invalidChildError(loc, nsURI, localName); |
| } |
| } |
| |
| /** {@inheritDoc} */ |
| public String getNextPageMasterName(boolean isOddPage, |
| boolean isFirstPage, |
| boolean isLastPage, |
| boolean isBlankPage) { |
| if (this.state == FIRST) { |
| this.state = DONE; |
| return masterReference; |
| } else { |
| return null; |
| } |
| } |
| |
| /** {@inheritDoc} */ |
| public void reset() { |
| this.state = FIRST; |
| } |
| |
| /** {@inheritDoc} */ |
| public boolean goToPrevious() { |
| if (state == FIRST) { |
| return false; |
| } else { |
| this.state = FIRST; |
| return true; |
| } |
| } |
| |
| /** {@inheritDoc} */ |
| public boolean hasPagePositionLast() { |
| return false; |
| } |
| |
| /** {@inheritDoc} */ |
| public boolean hasPagePositionOnly() { |
| return false; |
| } |
| |
| /** {@inheritDoc} */ |
| public String getLocalName() { |
| return "single-page-master-reference"; |
| } |
| |
| /** |
| * {@inheritDoc} |
| * @return {@link org.apache.fop.fo.Constants#FO_SINGLE_PAGE_MASTER_REFERENCE} |
| */ |
| public int getNameId() { |
| return FO_SINGLE_PAGE_MASTER_REFERENCE; |
| } |
| |
| } |
| |