org.apache.fop.render.rtf.rtflib.rtfdoc.RtfPage 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: RtfPage.java 1805173 2017-08-16 10:50:04Z ssteiner $ */
package org.apache.fop.render.rtf.rtflib.rtfdoc;
/*
* This file is part of the RTF library of the FOP project, which was originally
* created by Bertrand Delacretaz [email protected] and by other
* contributors to the jfor project (www.jfor.org), who agreed to donate jfor to
* the FOP project.
*/
import java.io.IOException;
import java.io.Writer;
/**
* Specifies rtf control words. Is the container for page attributes.
* Overrides okToWriteRtf.
*
* This work was authored by Christopher Scott ([email protected]).
*/
public class RtfPage
extends RtfContainer {
private final RtfAttributes attrib;
/**RtfPage attributes*/
/** constant for page width */
public static final String PAGE_WIDTH = "paperw";
/** constant for page height */
public static final String PAGE_HEIGHT = "paperh";
/** constant for landscape format */
public static final String LANDSCAPE = "landscape";
/** constant for top margin */
public static final String MARGIN_TOP = "margt";
/** constant for bottom margin */
public static final String MARGIN_BOTTOM = "margb";
/** constant for left margin */
public static final String MARGIN_LEFT = "margl";
/** constant for right margin */
public static final String MARGIN_RIGHT = "margr";
/** constant for header position */
public static final String HEADERY = "headery";
/** constant for footer position */
public static final String FOOTERY = "footery";
/** constant for itap level */
public static final String ITAP = "itap";
/** String array of RtfPage attributes */
public static final String[] PAGE_ATTR = new String[]{
PAGE_WIDTH, PAGE_HEIGHT, LANDSCAPE, MARGIN_TOP, MARGIN_BOTTOM,
MARGIN_LEFT, MARGIN_RIGHT, HEADERY, FOOTERY, ITAP
};
/** RtfPage creates new page attributes with the parent container, the writer
and the attributes*/
RtfPage(RtfPageArea parent, Writer w, RtfAttributes attrs) throws IOException {
super((RtfContainer)parent, w);
attrib = attrs;
}
/**
* RtfPage writes the attributes the attributes contained in the string
* PAGE_ATTR, if not null
* @throws IOException for I/O problems
*/
protected void writeRtfContent() throws IOException {
writeAttributes(attrib, PAGE_ATTR);
if (attrib != null) {
Object widthRaw = attrib.getValue(PAGE_WIDTH);
Object heightRaw = attrib.getValue(PAGE_HEIGHT);
if ((widthRaw instanceof Integer) && (heightRaw instanceof Integer)
&& (Integer) widthRaw > (Integer) heightRaw) {
writeControlWord(LANDSCAPE);
}
}
}
/**
* RtfPage - attributes accessor
* @return attributes
*/
public RtfAttributes getAttributes() {
return attrib;
}
/**
* RtfPage - is overwritten here because page attributes have no content
* only attributes. RtfContainer is defined not to write when empty.
* Therefore must make this true to print.
* @return true
*/
protected boolean okToWriteRtf() {
return true;
}
}