org.apache.poi.sl.draw.DrawTextParagraph Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of poi Show documentation
Show all versions of poi Show documentation
Apache POI - Java API To Access Microsoft Format Files
/* ====================================================================
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.
==================================================================== */
package org.apache.poi.sl.draw;
import static org.apache.logging.log4j.util.Unbox.box;
import java.awt.Dimension;
import java.awt.Font;
import java.awt.Graphics2D;
import java.awt.Paint;
import java.awt.font.FontRenderContext;
import java.awt.font.LineBreakMeasurer;
import java.awt.font.TextAttribute;
import java.awt.font.TextLayout;
import java.awt.geom.Rectangle2D;
import java.io.InvalidObjectException;
import java.text.AttributedCharacterIterator;
import java.text.AttributedCharacterIterator.Attribute;
import java.text.AttributedString;
import java.time.LocalDateTime;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Calendar;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.poi.common.usermodel.fonts.FontGroup;
import org.apache.poi.common.usermodel.fonts.FontGroup.FontGroupRange;
import org.apache.poi.common.usermodel.fonts.FontInfo;
import org.apache.poi.sl.usermodel.AutoNumberingScheme;
import org.apache.poi.sl.usermodel.HighlightColorSupport;
import org.apache.poi.sl.usermodel.Hyperlink;
import org.apache.poi.sl.usermodel.Insets2D;
import org.apache.poi.sl.usermodel.PaintStyle;
import org.apache.poi.sl.usermodel.PlaceableShape;
import org.apache.poi.sl.usermodel.PlaceholderDetails;
import org.apache.poi.sl.usermodel.SimpleShape;
import org.apache.poi.sl.usermodel.Slide;
import org.apache.poi.sl.usermodel.TextParagraph;
import org.apache.poi.sl.usermodel.TextParagraph.BulletStyle;
import org.apache.poi.sl.usermodel.TextParagraph.TextAlign;
import org.apache.poi.sl.usermodel.TextRun;
import org.apache.poi.sl.usermodel.TextRun.FieldType;
import org.apache.poi.sl.usermodel.TextShape;
import org.apache.poi.sl.usermodel.TextShape.TextDirection;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LocaleUtil;
import org.apache.poi.util.StringUtil;
import org.apache.poi.util.Units;
import org.w3c.dom.Text;
public class DrawTextParagraph implements Drawable {
private static final Logger LOG = LogManager.getLogger(DrawTextParagraph.class);
/** Keys for passing hyperlinks to the graphics context */
public static final XlinkAttribute HYPERLINK_HREF = new XlinkAttribute("href");
public static final XlinkAttribute HYPERLINK_LABEL = new XlinkAttribute("label");
protected TextParagraph paragraph;
double x, y;
protected List lines = new ArrayList<>();
protected String rawText;
protected DrawTextFragment bullet;
protected int autoNbrIdx;
protected boolean firstParagraph = true;
/**
* Defines an attribute used for storing the hyperlink associated with
* some renderable text.
*/
private static class XlinkAttribute extends Attribute {
XlinkAttribute(String name) {
super(name);
}
/**
* Resolves instances being deserialized to the predefined constants.
*/
@Override
protected Object readResolve() throws InvalidObjectException {
if (HYPERLINK_HREF.getName().equals(getName())) {
return HYPERLINK_HREF;
}
if (HYPERLINK_LABEL.getName().equals(getName())) {
return HYPERLINK_LABEL;
}
throw new InvalidObjectException("unknown attribute name");
}
}
public DrawTextParagraph(TextParagraph paragraph) {
this.paragraph = paragraph;
}
public void setPosition(double x, double y) {
// TODO: replace it, by applyTransform????
this.x = x;
this.y = y;
}
public double getY() {
return y;
}
/**
* Sets the auto numbering index of the handled paragraph
* @param index the auto numbering index
*/
public void setAutoNumberingIdx(int index) {
autoNbrIdx = index;
}
@Override
public void draw(Graphics2D graphics){
if (lines.isEmpty()) {
return;
}
final boolean isHSLF = isHSLF();
double penY = y;
int indentLevel = paragraph.getIndentLevel();
Double leftMargin = paragraph.getLeftMargin();
if (leftMargin == null) {
// if the marL attribute is omitted, then a value of 347663 is implied
leftMargin = Units.toPoints(347663L*indentLevel);
}
Double indent = paragraph.getIndent();
if (indent == null) {
indent = Units.toPoints(347663L*indentLevel);
}
// Double rightMargin = paragraph.getRightMargin();
// if (rightMargin == null) {
// rightMargin = 0d;
// }
//The vertical line spacing
Double spacing = paragraph.getLineSpacing();
if (spacing == null) {
spacing = 100d;
}
DrawTextFragment lastLine = null;
for(DrawTextFragment line : lines){
double penX;
if (!(isFirstParagraph() && lastLine == null)) {
// penY is now on descent line of the last text fragment
// need to substract descent height to get back to the baseline of the last fragment
// then add a multiple of the line height of the current text height
penY -= line.getLeading() + ((lastLine == null) ? 0 : lastLine.getLayout().getDescent());
if(spacing > 0) {
// If linespacing >= 0, then linespacing is a percentage of normal line height.
penY += (spacing*0.01) * line.getHeight(); // + (isHSLF ? line.getLayout().getLeading() : 0));
} else {
// negative value means absolute spacing in points
penY += -spacing;
}
penY -= line.getLayout().getAscent();
}
penX = x + leftMargin;
if (lastLine == null) {
if (!isEmptyParagraph()) {
// TODO: find out character style for empty, but bulleted/numbered lines
bullet = getBullet(graphics, line.getAttributedString().getIterator());
}
if (bullet != null) {
bullet.setPosition(isHSLF ? x+indent : x+leftMargin+indent, penY);
bullet.draw(graphics);
// don't let text overlay the bullet and advance by the bullet width
double bulletWidth = bullet.getLayout().getAdvance() + 1;
penX = x + (isHSLF ? leftMargin : Math.max(leftMargin, leftMargin+indent+bulletWidth));
}
}
Rectangle2D anchor = DrawShape.getAnchor(graphics, paragraph.getParentShape());
// Insets are already applied on DrawTextShape.drawContent
// but (outer) anchor need to be adjusted
Insets2D insets = paragraph.getParentShape().getInsets();
double leftInset = insets.left;
double rightInset = insets.right;
TextAlign ta = paragraph.getTextAlign();
if (ta == null) {
ta = TextAlign.LEFT;
}
switch (ta) {
case CENTER:
penX += (anchor.getWidth() - line.getWidth() - leftInset - rightInset - leftMargin) / 2;
break;
case RIGHT:
penX += (anchor.getWidth() - line.getWidth() - leftInset - rightInset);
break;
default:
break;
}
line.setPosition(penX, penY);
line.draw(graphics);
penY += line.getHeight();
lastLine = line;
}
y = penY - y;
}
public float getFirstLineLeading() {
return (lines.isEmpty()) ? 0 : lines.get(0).getLeading();
}
public float getFirstLineHeight() {
return (lines.isEmpty()) ? 0 : lines.get(0).getHeight();
}
public float getLastLineHeight() {
return (lines.isEmpty()) ? 0 : lines.get(lines.size()-1).getHeight();
}
public boolean isEmptyParagraph() {
return (lines.isEmpty() || StringUtil.isBlank(rawText));
}
@Override
public void applyTransform(Graphics2D graphics) {
}
@Override
public void drawContent(Graphics2D graphics) {
}
/**
* break text into lines, each representing a line of text that fits in the wrapping width
*
* @param graphics The drawing context for computing text-lengths.
*/
protected void breakText(Graphics2D graphics){
lines.clear();
DrawFactory fact = DrawFactory.getInstance(graphics);
StringBuilder text = new StringBuilder();
List attList = getAttributedString(graphics, text);
AttributedString as = new AttributedString(text.toString());
AttributedString asNoCR = new AttributedString(text.toString().replaceAll("[\\r\\n]", " "));
for (AttributedStringData asd : attList) {
as.addAttribute(asd.attribute, asd.value, asd.beginIndex, asd.endIndex);
asNoCR.addAttribute(asd.attribute, asd.value, asd.beginIndex, asd.endIndex);
}
AttributedCharacterIterator it = as.getIterator();
AttributedCharacterIterator itNoCR = asNoCR.getIterator();
LineBreakMeasurer measurer = new LineBreakMeasurer(it, graphics.getFontRenderContext());
for (;;) {
int startIndex = measurer.getPosition();
// add a pixel to compensate rounding errors
double wrappingWidth = getWrappingWidth(lines.isEmpty(), graphics) + 1;
// shape width can be smaller that the sum of insets (this was proved by a test file)
if(wrappingWidth < 0) {
wrappingWidth = 1;
}
// usually "\n" is added after a line, if it occurs before it - only possible as first char -
// we need to add an empty line
TextLayout layout;
int endIndex;
if (startIndex == 0 && text.toString().startsWith("\n")) {
layout = measurer.nextLayout((float) wrappingWidth, 1, false);
endIndex = 1;
} else {
int nextBreak = text.indexOf("\n", startIndex + 1);
if (nextBreak == -1) {
nextBreak = it.getEndIndex();
}
layout = measurer.nextLayout((float) wrappingWidth, nextBreak, true);
if (layout == null) {
// layout can be null if the entire word at the current position
// does not fit within the wrapping width. Try with requireNextWord=false.
layout = measurer.nextLayout((float) wrappingWidth, nextBreak, false);
}
if (layout == null) {
// exit if can't break any more
break;
}
endIndex = measurer.getPosition();
// skip over new line breaks (we paint 'clear' text runs not starting or ending with \n)
if (endIndex < it.getEndIndex() && text.charAt(endIndex) == '\n') {
measurer.setPosition(endIndex + 1);
}
TextAlign hAlign = paragraph.getTextAlign();
if (hAlign == TextAlign.JUSTIFY || hAlign == TextAlign.JUSTIFY_LOW) {
layout = layout.getJustifiedLayout((float) wrappingWidth);
}
}
AttributedString str = new AttributedString(itNoCR, startIndex, endIndex);
DrawTextFragment line = fact.getTextFragment(layout, str);
lines.add(line);
if(endIndex == it.getEndIndex()) {
break;
}
}
rawText = text.toString();
}
protected DrawTextFragment getBullet(Graphics2D graphics, AttributedCharacterIterator firstLineAttr) {
BulletStyle bulletStyle = paragraph.getBulletStyle();
if (bulletStyle == null) {
return null;
}
String buCharacter;
AutoNumberingScheme ans = bulletStyle.getAutoNumberingScheme();
if (ans != null) {
buCharacter = ans.format(autoNbrIdx);
} else {
buCharacter = bulletStyle.getBulletCharacter();
}
if (buCharacter == null) {
return null;
}
PlaceableShape ps = getParagraphShape();
PaintStyle fgPaintStyle = bulletStyle.getBulletFontColor();
Paint fgPaint;
if (fgPaintStyle == null) {
fgPaint = (Paint)firstLineAttr.getAttribute(TextAttribute.FOREGROUND);
} else {
fgPaint = new DrawPaint(ps).getPaint(graphics, fgPaintStyle);
}
float fontSize = (Float)firstLineAttr.getAttribute(TextAttribute.SIZE);
Double buSz = bulletStyle.getBulletFontSize();
if (buSz == null) {
buSz = 100d;
}
if (buSz > 0) {
fontSize *= (float) (buSz * 0.01);
} else {
fontSize = (float) -buSz;
}
String buFontStr = bulletStyle.getBulletFont();
if (buFontStr == null) {
buFontStr = paragraph.getDefaultFontFamily();
}
assert(buFontStr != null);
FontInfo buFont = new DrawFontInfo(buFontStr);
DrawFontManager dfm = DrawFactory.getInstance(graphics).getFontManager(graphics);
// TODO: check font group defaulting to Symbol
buFont = dfm.getMappedFont(graphics, buFont);
Map att = new HashMap<>();
att.put(TextAttribute.FOREGROUND, fgPaint);
att.put(TextAttribute.FAMILY, buFont.getTypeface());
att.put(TextAttribute.SIZE, fontSize);
att.put(TextAttribute.FONT, new Font(att));
AttributedString str = new AttributedString(dfm.mapFontCharset(graphics,buFont,buCharacter));
att.forEach(str::addAttribute);
TextLayout layout = new TextLayout(str.getIterator(), graphics.getFontRenderContext());
DrawFactory fact = DrawFactory.getInstance(graphics);
return fact.getTextFragment(layout, str);
}
protected String getRenderableText(Graphics2D graphics, TextRun tr) {
FieldType ft = tr.getFieldType();
if (ft == null) {
return getRenderableText(tr);
}
if (tr.getRawText() != null && !tr.getRawText().isEmpty()) {
switch (ft) {
case SLIDE_NUMBER: {
Slide slide = (Slide) graphics.getRenderingHint(Drawable.CURRENT_SLIDE);
return (slide == null) ? "" : Integer.toString(slide.getSlideNumber());
}
case DATE_TIME: {
PlaceholderDetails pd = ((SimpleShape) this.getParagraphShape()).getPlaceholderDetails();
// refresh internal members
pd.getPlaceholder();
String uda = pd.getUserDate();
if (uda != null) {
return uda;
}
Calendar cal = LocaleUtil.getLocaleCalendar();
LocalDateTime now = LocalDateTime.ofInstant(cal.toInstant(), cal.getTimeZone().toZoneId());
return now.format(pd.getDateFormat());
}
}
}
return "";
}
@Internal
public String getRenderableText(final TextRun tr) {
String txtSpace = tr.getRawText();
if (txtSpace == null) {
return null;
}
if (txtSpace.contains("\t")) {
txtSpace = txtSpace.replace("\t", tab2space(tr));
}
txtSpace = txtSpace.replace('\u000b', '\n');
final Locale loc = LocaleUtil.getUserLocale();
switch (tr.getTextCap()) {
case ALL:
return txtSpace.toUpperCase(loc);
case SMALL:
return txtSpace.toLowerCase(loc);
default:
return txtSpace;
}
}
/**
* Replace a tab with the effective number of white spaces.
*/
private String tab2space(TextRun tr) {
AttributedString string = new AttributedString(" ");
String fontFamily = tr.getFontFamily();
if (fontFamily == null) {
fontFamily = "Lucida Sans";
}
string.addAttribute(TextAttribute.FAMILY, fontFamily);
Double fs = tr.getFontSize();
if (fs == null) {
fs = 12d;
}
string.addAttribute(TextAttribute.SIZE, fs.floatValue());
TextLayout l = new TextLayout(string.getIterator(), new FontRenderContext(null, true, true));
// some JDK versions return 0 here
double wspace = l.getAdvance();
final int numSpaces;
Double tabSz = paragraph.getDefaultTabSize();
if (wspace <= 0) {
numSpaces = 4;
} else {
if (tabSz == null) {
tabSz = wspace*4;
}
numSpaces = (int)Math.min(Math.ceil(tabSz / wspace), 20);
}
char[] buf = new char[numSpaces];
Arrays.fill(buf, ' ');
return new String(buf);
}
/**
* Returns wrapping width to break lines in this paragraph
*
* @param firstLine whether the first line is breaking
*
* @return wrapping width in points
*/
protected double getWrappingWidth(boolean firstLine, Graphics2D graphics){
final long TAB_SIZE = 347663L;
TextShape ts = paragraph.getParentShape();
// internal margins for the text box
Insets2D insets = ts.getInsets();
double leftInset = insets.left;
double rightInset = insets.right;
int indentLevel = paragraph.getIndentLevel();
if (indentLevel == -1) {
// default to 0, if indentLevel is not set
indentLevel = 0;
}
Double leftMargin = paragraph.getLeftMargin();
if (leftMargin == null) {
// if the marL attribute is omitted, then a value of 347663 is implied
leftMargin = Units.toPoints(TAB_SIZE * indentLevel);
}
Double indent = paragraph.getIndent();
if (indent == null) {
indent = 0.;
}
Double rightMargin = paragraph.getRightMargin();
if (rightMargin == null) {
rightMargin = 0d;
}
Rectangle2D anchor = DrawShape.getAnchor(graphics, ts);
TextDirection textDir = ts.getTextDirection();
double width;
if (!ts.getWordWrap()) {
Dimension pageDim = ts.getSheet().getSlideShow().getPageSize();
// if wordWrap == false then we return the advance to the (right) border of the sheet
switch (textDir) {
default:
width = pageDim.getWidth() - anchor.getX();
break;
case VERTICAL:
width = pageDim.getHeight() - anchor.getX();
break;
case VERTICAL_270:
width = anchor.getX();
break;
}
} else {
switch (textDir) {
default:
width = anchor.getWidth() - leftInset - rightInset - leftMargin - rightMargin;
break;
case VERTICAL:
case VERTICAL_270:
width = anchor.getHeight() - leftInset - rightInset - leftMargin - rightMargin;
break;
}
if (firstLine && bullet == null) {
// indent is usually negative in XSLF
width += isHSLF() ? (leftMargin - indent) : -indent;
}
}
return width;
}
private static class AttributedStringData {
Attribute attribute;
Object value;
int beginIndex, endIndex;
AttributedStringData(Attribute attribute, Object value, int beginIndex, int endIndex) {
this.attribute = attribute;
this.value = value;
this.beginIndex = beginIndex;
this.endIndex = endIndex;
}
}
/**
* Helper method for paint style relative to bounds, e.g. gradient paint
*/
private PlaceableShape getParagraphShape() {
return paragraph.getParentShape();
}
protected List getAttributedString(Graphics2D graphics, StringBuilder text) {
if (text == null) {
text = new StringBuilder();
}
final DrawPaint dp = new DrawPaint(getParagraphShape());
DrawFontManager dfm = DrawFactory.getInstance(graphics).getFontManager(graphics);
assert(dfm != null);
final Map att = new HashMap<>();
final List attList = new ArrayList<>();
for (TextRun run : paragraph){
String runText = getRenderableText(graphics, run);
// skip empty runs
if (runText.isEmpty()) {
continue;
}
att.clear();
// user can pass an custom object to convert fonts
FontInfo fontInfo = run.getFontInfo(null);
runText = dfm.mapFontCharset(graphics, fontInfo, runText);
final int beginIndex = text.length();
text.append(runText);
final int endIndex = text.length();
PaintStyle fgPaintStyle = run.getFontColor();
Paint fgPaint = dp.getPaint(graphics, fgPaintStyle);
att.put(TextAttribute.FOREGROUND, fgPaint);
if (run instanceof HighlightColorSupport) {
// Highlight color is only supported in XSLF (PPTX) text runs.
final PaintStyle highlightPaintStyle = ((HighlightColorSupport)run).getHighlightColor();
if (highlightPaintStyle != null) {
final Paint bgPaint = dp.getPaint(graphics, highlightPaintStyle);
att.put(TextAttribute.BACKGROUND, bgPaint);
}
}
Double fontSz = run.getFontSize();
if (fontSz == null) {
fontSz = paragraph.getDefaultFontSize();
}
att.put(TextAttribute.SIZE, fontSz.floatValue());
if(run.isBold()) {
att.put(TextAttribute.WEIGHT, TextAttribute.WEIGHT_BOLD);
}
if(run.isItalic()) {
att.put(TextAttribute.POSTURE, TextAttribute.POSTURE_OBLIQUE);
}
if(run.isUnderlined()) {
att.put(TextAttribute.UNDERLINE, TextAttribute.UNDERLINE_ON);
att.put(TextAttribute.INPUT_METHOD_UNDERLINE, TextAttribute.UNDERLINE_LOW_TWO_PIXEL);
}
if(run.isStrikethrough()) {
att.put(TextAttribute.STRIKETHROUGH, TextAttribute.STRIKETHROUGH_ON);
}
if(run.isSubscript()) {
att.put(TextAttribute.SUPERSCRIPT, TextAttribute.SUPERSCRIPT_SUB);
}
if(run.isSuperscript()) {
att.put(TextAttribute.SUPERSCRIPT, TextAttribute.SUPERSCRIPT_SUPER);
}
Hyperlink hl = run.getHyperlink();
if (hl != null) {
att.put(HYPERLINK_HREF, hl.getAddress());
att.put(HYPERLINK_LABEL, hl.getLabel());
}
if (fontInfo != null) {
att.put(TextAttribute.FAMILY, fontInfo.getTypeface());
} else {
att.put(TextAttribute.FAMILY, paragraph.getDefaultFontFamily());
}
att.put(TextAttribute.FONT, new Font(att));
att.forEach((k,v) -> attList.add(new AttributedStringData(k,v,beginIndex,endIndex)));
processGlyphs(graphics, dfm, attList, beginIndex, run, runText);
}
// ensure that the paragraph contains at least one character
// We need this trick to correctly measure text
if (text.length() == 0) {
text.append(" ");
Double fontSz = paragraph.getDefaultFontSize();
att.put(TextAttribute.SIZE, fontSz.floatValue());
att.put(TextAttribute.FAMILY, paragraph.getDefaultFontFamily());
att.put(TextAttribute.FONT, new Font(att));
att.forEach((k,v) -> attList.add(new AttributedStringData(k,v,0,1)));
}
return attList;
}
/**
* Processing the glyphs is done in two steps:
*
* - 1. determine the font group - a text run can have different font groups.
*
- 2. Depending on the chars, the correct font group needs to be used
*
*
* @see Office Open XML Themes, Schemes, and Fonts
*/
private void processGlyphs(Graphics2D graphics, DrawFontManager dfm, List attList, final int beginIndex, TextRun run, String runText) {
// determine font group ranges of the textrun to focus the fallback handling only on that font group
List ttrList = FontGroup.getFontGroupRanges(runText);
int rangeBegin = 0;
for (FontGroupRange ttr : ttrList) {
FontInfo fiRun = run.getFontInfo(ttr.getFontGroup());
if (fiRun == null) {
// if the font group specific font wasn't defined, fallback to LATIN
fiRun = run.getFontInfo(FontGroup.LATIN);
}
FontInfo fiMapped = dfm.getMappedFont(graphics, fiRun);
FontInfo fiFallback = dfm.getFallbackFont(graphics, fiRun);
assert(fiFallback != null);
if (fiMapped == null) {
fiMapped = dfm.getMappedFont(graphics, new DrawFontInfo(paragraph.getDefaultFontFamily()));
}
if (fiMapped == null) {
fiMapped = fiFallback;
}
Font fontMapped = dfm.createAWTFont(graphics, fiMapped, 10, run.isBold(), run.isItalic());
Font fontFallback = dfm.createAWTFont(graphics, fiFallback, 10, run.isBold(), run.isItalic());
// check for unsupported characters and add a fallback font for these
final int rangeLen = ttr.getLength();
int partEnd = rangeBegin;
while (partEnd