blob: 623b50de7208d9ec1392fdf9bf4940db41c04d7d [file] [log] [blame]
/*
* 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;
/**
* A single-page-master-reference formatting 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;
/**
* @see org.apache.fop.fo.FONode#FONode(FONode)
*/
public SinglePageMasterReference(FONode parent) {
super(parent);
this.state = FIRST;
}
/**
* @see org.apache.fop.fo.FObj#bind(PropertyList)
*/
public void bind(PropertyList pList) throws FOPException {
masterReference = pList.get(PR_MASTER_REFERENCE).getString();
if (masterReference == null || masterReference.equals("")) {
missingPropertyError("master-reference");
}
}
/**
* @see org.apache.fop.fo.FONode#startOfNode
*/
protected void startOfNode() throws FOPException {
PageSequenceMaster pageSequenceMaster = (PageSequenceMaster) parent;
pageSequenceMaster.addSubsequenceSpecifier(this);
}
/**
* @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String)
* XSL Content Model: empty
*/
protected void validateChildNode(Locator loc, String nsURI, String localName)
throws ValidationException {
invalidChildError(loc, nsURI, localName);
}
/** @see org.apache.fop.fo.pagination.SubSequenceSpecifier */
public String getNextPageMasterName(boolean isOddPage,
boolean isFirstPage,
boolean isLastPage,
boolean isEmptyPage) {
if (this.state == FIRST) {
this.state = DONE;
return masterReference;
} else {
return null;
}
}
/** @see org.apache.fop.fo.pagination.SubSequenceSpecifier#reset() */
public void reset() {
this.state = FIRST;
}
/** @see org.apache.fop.fo.pagination.SubSequenceSpecifier#goToPrevious() */
public boolean goToPrevious() {
if (state == FIRST) {
return false;
} else {
this.state = FIRST;
return true;
}
}
/** @see org.apache.fop.fo.pagination.SubSequenceSpecifier#hasPagePositionLast() */
public boolean hasPagePositionLast() {
return false;
}
/** @see org.apache.fop.fo.FONode#getLocalName() */
public String getLocalName() {
return "single-page-master-reference";
}
/** @see org.apache.fop.fo.FObj#getNameId() */
public int getNameId() {
return FO_SINGLE_PAGE_MASTER_REFERENCE;
}
}