org.jpedal.objects.PdfResources Maven / Gradle / Ivy
The newest version!
/*
* ===========================================
* Java Pdf Extraction Decoding Access Library
* ===========================================
*
* Project Info: http://www.idrsolutions.com
* Help section for developers at http://www.idrsolutions.com/java-pdf-library-support/
*
* (C) Copyright 1997-2013, IDRsolutions and Contributors.
*
* This file is part of JPedal
*
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* ---------------
* PdfResources.java
* ---------------
*/
package org.jpedal.objects;
import org.jpedal.exception.PdfException;
import org.jpedal.io.PdfObjectReader;
import org.jpedal.objects.layers.PdfLayerList;
import org.jpedal.objects.outlines.OutlineData;
import org.jpedal.objects.raw.PdfDictionary;
import org.jpedal.objects.raw.PdfObject;
import org.jpedal.parser.PdfStreamDecoder;
import org.jpedal.parser.ValueTypes;
import org.jpedal.utils.LogWriter;
import org.w3c.dom.Document;
//
//
public class PdfResources {
public static final int AcroFormObj = 1;
public static final int GlobalResources = 2;
public static final int StructTreeRootObj = 3;
public static final int MarkInfoObj = 4;
PdfLayerList layers;
/** objects read from root */
private PdfObject metadataObj = null, acroFormObj = null, globalResources, PropertiesObj = null, structTreeRootObj = null, OCProperties = null,
markInfoObj = null, OutlinesObj = null;
//
/**
* store outline data extracted from pdf
*/
private OutlineData outlineData = null;
//
/**
* initialise OC Content and other items before Page decoded but after Resources read
*
* @param current
* @param currentPdfFile
*/
public void setupResources(PdfStreamDecoder current, boolean alwaysCheck, PdfObject Resources, int pageNumber, PdfObjectReader currentPdfFile)
throws PdfException {
if (this.globalResources != null) {
current.readResources(this.globalResources, true);
PdfObject propObj = this.globalResources.getDictionary(PdfDictionary.Properties);
if (propObj != null) this.PropertiesObj = propObj;
}
/** read the resources for the page */
if (Resources != null) {
current.readResources(Resources, true);
PdfObject propObj = Resources.getDictionary(PdfDictionary.Properties);
if (propObj != null) this.PropertiesObj = propObj;
}
/**
* layers
*/
if (this.OCProperties != null && (this.layers == null || pageNumber != this.layers.getOCpageNumber() || alwaysCheck)) {
currentPdfFile.checkResolved(this.OCProperties);
if (this.layers == null) this.layers = new PdfLayerList();
this.layers.init(this.OCProperties, this.PropertiesObj, currentPdfFile, pageNumber);
}
current.setObjectValue(ValueTypes.PdfLayerList, this.layers);
}
public PdfObject getPdfObject(int key) {
PdfObject obj = null;
switch (key) {
case AcroFormObj:
obj = this.acroFormObj;
break;
case GlobalResources:
obj = this.globalResources;
break;
case MarkInfoObj:
obj = this.markInfoObj;
break;
case StructTreeRootObj:
obj = this.structTreeRootObj;
break;
}
return obj;
}
public void setPdfObject(int key, PdfObject obj) {
switch (key) {
case GlobalResources:
this.globalResources = obj;
break;
}
}
public void flush() {
this.globalResources = null;
}
public void flushObjects() {
// flush objects held
this.metadataObj = null;
this.acroFormObj = null;
this.markInfoObj = null;
this.PropertiesObj = null;
this.OCProperties = null;
this.structTreeRootObj = null;
this.OutlinesObj = null;
this.layers = null;
}
/**
* flag to show if PDF document contains an outline
*/
final public boolean hasOutline() {
return this.OutlinesObj != null;
}
public void setValues(PdfObject pdfObject, PdfObjectReader currentPdfFile) {
currentPdfFile.checkResolved(pdfObject);
this.metadataObj = pdfObject.getDictionary(PdfDictionary.Metadata);
this.acroFormObj = pdfObject.getDictionary(PdfDictionary.AcroForm);
currentPdfFile.checkResolved(this.acroFormObj);
this.markInfoObj = pdfObject.getDictionary(PdfDictionary.MarkInfo);
this.structTreeRootObj = pdfObject.getDictionary(PdfDictionary.StructTreeRoot);
this.OCProperties = pdfObject.getDictionary(PdfDictionary.OCProperties);
this.OutlinesObj = pdfObject.getDictionary(PdfDictionary.Outlines);
//
// set up outlines
this.outlineData = null;
//
}
//
/**
* provide direct access to outlineData object
*
* @return OutlineData
*/
public OutlineData getOutlineData() {
return this.outlineData;
}
public Document getOutlineAsXML(PdfObjectReader currentPdfFile, int pageCount) {
if (this.outlineData == null && this.OutlinesObj != null) {
try {
currentPdfFile.checkResolved(this.OutlinesObj);
this.outlineData = new OutlineData(pageCount);
this.outlineData.readOutlineFileMetadata(this.OutlinesObj, currentPdfFile);
}
catch (Exception e) {
if (LogWriter.isOutput()) LogWriter.writeLog("Exception " + e + " accessing outline ");
this.outlineData = null;
}
}
if (this.outlineData != null) return this.outlineData.getList();
else return null;
}
//
public PdfFileInformation getMetaData(PdfObjectReader currentPdfFile) {
if (currentPdfFile != null) {
/** Information object holds information from file */
return new PdfFileInformation().readPdfFileMetadata(this.metadataObj, currentPdfFile);
}
else return null;
}
public boolean isForm() {
return this.acroFormObj != null;
}
public PdfLayerList getPdfLayerList() {
return this.layers;
}
}