org.docx4j.model.structure.PageDimensions Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of docx4j-core Show documentation
Show all versions of docx4j-core Show documentation
docx4j is a library which helps you to work with the Office Open
XML file format as used in docx
documents, pptx presentations, and xlsx spreadsheets.
/*
* Copyright 2009, Plutext Pty Ltd.
*
* This file is part of docx4j.
docx4j is licensed 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.
*/
package org.docx4j.model.structure;
import java.math.BigInteger;
import org.docx4j.Docx4jProperties;
import org.docx4j.jaxb.Context;
import org.docx4j.wml.CTColumns;
import org.docx4j.wml.STPageOrientation;
import org.docx4j.wml.SectPr;
import org.docx4j.wml.SectPr.PgMar;
import org.docx4j.wml.SectPr.PgSz;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Wraps PgSz (Page size) and PgMar (margin settings).
* - gives you an easy way to set these;
* - performs a few useful calculations
*
* Used in SectionWrapper, to store the dimensions
* of a page for a section; can also be used to
* store a set of page dimensions which aren't
* associated with any section.
*
* @author jharrop
*
*/
public class PageDimensions {
protected static Logger log = LoggerFactory.getLogger(PageDimensions.class);
public PageDimensions() {
pgSz = Context.getWmlObjectFactory().createSectPrPgSz();
setPgSize();
pgMar = Context.getWmlObjectFactory().createSectPrPgMar();
setMargins();
}
/**
* @since 2.7
*/
public PageDimensions(PgSz pgSz, PgMar pgMar) {
init(pgSz, pgMar, null);
}
/**
* @since 2.7
*/
public PageDimensions(SectPr sectPr) {
if (sectPr==null) {
init(null, null, null);
} else {
init(sectPr.getPgSz(), sectPr.getPgMar(), sectPr.getCols());
}
}
private void init(PgSz pgSz, PgMar pgMar, CTColumns cols) {
if (pgSz == null) {
log.info("No pgSz in this section; defaulting.");
this.pgSz = Context.getWmlObjectFactory().createSectPrPgSz();
setPgSize();
} else {
this.pgSz = pgSz;
}
if (pgMar ==null) {
log.info("No pgMar in this section; defaulting.");
this.pgMar = Context.getWmlObjectFactory().createSectPrPgMar();
setMargins();
} else {
this.pgMar = pgMar;
}
if (cols == null) {
log.info("No cols in this section; defaulting.");
this.cols = Context.getWmlObjectFactory().createCTColumns();
} else {
this.cols = cols;
}
}
private CTColumns cols;
private PgSz pgSz;
/**
* @since 2.7
*/
public PgSz getPgSz() {
return pgSz;
}
/**
* @since 2.7
*/
public void setPgSz(PgSz pgSz) {
this.pgSz = pgSz;
}
@Deprecated
public PgSz createPgSize() {
return pgSz;
}
private PgMar pgMar;
/**
* @since 2.7
*/
public PgMar getPgMar() {
return pgMar;
}
/**
* @since 2.7
*/
public void setPgMar(PgMar pgMar) {
this.pgMar = pgMar;
}
@Deprecated
public PgMar createPgMar() {
return pgMar;
}
/**
* set Margins from docx4j.properties
*
* @since 2.8
*/
public void setMargins() {
String margin= Docx4jProperties.getProperties().getProperty("docx4j.PageMargins", "NORMAL");
setMargins(MarginsWellKnown.valueOf(margin));
// if (margin.equals("normal")) {
// setMargins(MarginsWellKnown.NORMAL);
// } else if (margin.equals("narrow")) {
// setMargins(MarginsWellKnown.NARROW);
// } else if (margin.equals("moderate")) {
// setMargins(MarginsWellKnown.MODERATE);
// } else if (margin.equals("wide")) {
// setMargins(MarginsWellKnown.WIDE);
// } else {
// log.warn("Unknown margin setting " + margin + "in docx4j.properties");
// setMargins(MarginsWellKnown.NORMAL);
// }
}
/**
* @since 2.7
*/
public void setMargins(MarginsWellKnown m ) {
// NORMAL("normal"), //