org.apache.fop.svg.PDFTextUtil Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of fop Show documentation
Show all versions of fop Show documentation
Apache FOP (Formatting Objects Processor) is the world's first print formatter driven by XSL formatting objects (XSL-FO) and the world's first output independent formatter. It is a Java application that reads a formatting object (FO) tree and renders the resulting pages to a specified output. Output formats currently supported include PDF, PCL, PS, AFP, TIFF, PNG, SVG, XML (area tree representation), Print, AWT and TXT. The primary output target is PDF.
/*
* 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: PDFTextUtil.java 679326 2008-07-24 09:35:34Z vhennebert $ */
package org.apache.fop.svg;
import org.apache.fop.fonts.Font;
import org.apache.fop.fonts.FontInfo;
import org.apache.fop.fonts.Typeface;
/**
* Utility class for generating PDF text objects. It needs to be subclassed to add writing
* functionality (see {@link #write(String)}).
*/
public abstract class PDFTextUtil extends org.apache.fop.pdf.PDFTextUtil {
private FontInfo fontInfo;
private Font[] fonts;
private Font font;
/**
* Main constructor.
* @param fontInfo the font catalog
*/
public PDFTextUtil(FontInfo fontInfo) {
super();
this.fontInfo = fontInfo;
}
/** {@inheritDoc} */
protected void initValues() {
super.initValues();
this.font = null;
}
/**
* Sets the current fonts for the text object. For every character, the suitable font will
* be selected.
* @param fonts the new fonts
*/
public void setFonts(Font[] fonts) {
this.fonts = fonts;
}
/**
* Sets the current font for the text object.
* @param font the new font
*/
public void setFont(Font font) {
setFonts(new Font[] {font});
}
/**
* Returns the current font in use.
* @return the current font or null if no font is currently active.
*/
public Font getCurrentFont() {
return this.font;
}
/**
* Sets the current font.
* @param f the new font to use
*/
public void setCurrentFont(Font f) {
this.font = f;
}
/**
* Determines whether the font with the given name is a multi-byte font.
* @param name the name of the font
* @return true if it's a multi-byte font
*/
protected boolean isMultiByteFont(String name) {
Typeface f = (Typeface)fontInfo.getFonts().get(name);
return f.isMultiByte();
}
/**
* Writes a "Tf" command, setting a new current font.
* @param f the font to select
*/
public void writeTf(Font f) {
String fontName = f.getFontName();
float fontSize = (float)f.getFontSize() / 1000f;
updateTf(fontName, fontSize, isMultiByteFont(fontName));
}
/**
* Selects a font from the font list suitable to display the given character.
* @param ch the character
* @return the recommended Font to use
*/
public Font selectFontForChar(char ch) {
for (int i = 0, c = fonts.length; i < c; i++) {
if (fonts[i].hasChar(ch)) {
return fonts[i];
}
}
return fonts[0]; //TODO Maybe fall back to painting with shapes
}
/**
* Writes a char to the "TJ-Buffer".
* @param ch the unmapped character
*/
public void writeTJChar(char ch) {
char mappedChar = font.mapChar(ch);
writeTJMappedChar(mappedChar);
}
}