net.sf.jasperreports.engine.util.JRStyledText Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jasperreports Show documentation
Show all versions of jasperreports Show documentation
Free Java Reporting Library
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2023 Cloud Software Group, Inc. All rights reserved.
* http://www.jaspersoft.com
*
* Unless you have purchased a commercial license agreement from Jaspersoft,
* the following license terms apply:
*
* This program is part of JasperReports.
*
* JasperReports 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 3 of the License, or
* (at your option) any later version.
*
* JasperReports 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 JasperReports. If not, see FONT_ATTRS = new HashSet<>();
static
{
FONT_ATTRS.add(TextAttribute.FAMILY);
FONT_ATTRS.add(JRTextAttribute.FONT_INFO);
FONT_ATTRS.add(TextAttribute.WEIGHT);
FONT_ATTRS.add(TextAttribute.POSTURE);
FONT_ATTRS.add(TextAttribute.SIZE);
FONT_ATTRS.add(TextAttribute.SUPERSCRIPT);
}
/**
*
*/
private StringBuilder sbuffer;
private String text;
private List runs = Collections.emptyList();
private AttributedString attributedString;
private AttributedString awtAttributedString;
private Map globalAttributes;
private Locale locale;
/**
*
*/
public JRStyledText()
{
this(null);
}
/**
*
*/
public JRStyledText(Locale locale)
{
this.locale = locale;
}
public JRStyledText(Locale locale, String text)
{
this.locale = locale;
this.text = text;
}
public JRStyledText(Locale locale, String text, Map globalAttributes)
{
this.locale = locale;
this.text = text;
this.globalAttributes = globalAttributes;
this.runs = Collections.singletonList(new Run(globalAttributes, 0, text.length()));
}
public JRStyledText(Locale locale, String text, Map globalAttributes, List runs)
{
this.locale = locale;
this.text = text;
this.globalAttributes = globalAttributes;
this.runs = runs;
}
private void ensureBuffer()
{
if (sbuffer == null)
{
sbuffer = text == null ? new StringBuilder() : new StringBuilder(text);
}
text = null;
}
private void ensureText()
{
if (text == null)
{
text = sbuffer == null ? "" : sbuffer.toString();
}
sbuffer = null;
}
/**
*
*/
public void append(String text)
{
ensureBuffer();
sbuffer.append(text);
attributedString = null;
awtAttributedString = null;
}
/**
*
*/
public void addRun(Run run)
{
int currentSize = runs.size();
if (currentSize == 0)
{
runs = Collections.singletonList(run);
}
else
{
if (currentSize == 1 && !(runs instanceof ArrayList))
{
List newRuns = new ArrayList<>();
newRuns.add(runs.get(0));
runs = newRuns;
}
runs.add(run);
}
attributedString = null;
awtAttributedString = null;
}
/**
*
*/
public int length()
{
return text == null ? (sbuffer == null ? 0 : sbuffer.length()) : text.length();
}
/**
*
*/
public String getText()
{
ensureText();
return text;
}
/**
*
*/
public Locale getLocale()
{
return locale;
}
/**
*
*/
public AttributedString getAttributedString()
{
if (attributedString == null)
{
ensureText();
attributedString = new AttributedString(text);
for(int i = runs.size() - 1; i >= 0; i--)
{
Run run = runs.get(i);
if (run.startIndex != run.endIndex && run.attributes != null)
{
attributedString.addAttributes(run.attributes, run.startIndex, run.endIndex);
}
}
}
return attributedString;
}
public void consumeText(StyledTextRunConsumer consumer)
{
if (globalAttributes != null && runs.size() == 1)
{
consumer.accept(0, length(), globalAttributes, getText());
return;
}
AttributedCharacterIterator iterator = getAttributedString().getIterator();
int runLimit = 0;
int length = length();
while (runLimit < length && (runLimit = iterator.getRunLimit()) <= length)
{
int runStart = iterator.getIndex();
Map attributes = iterator.getAttributes();
String runText = text.substring(runStart, runLimit);
consumer.accept(runStart, runLimit, attributes, runText);
iterator.setIndex(runLimit);
}
}
/**
* Returns an attributed string that contains the AWT font attribute, as the font is actually loaded.
*/
public AttributedString getAwtAttributedString(JasperReportsContext jasperReportsContext, boolean ignoreMissingFont)
{
if (awtAttributedString == null)
{
ensureText();
awtAttributedString = new AttributedString(text);
for(int i = runs.size() - 1; i >= 0; i--)
{
Run run = runs.get(i);
if (run.startIndex != run.endIndex && run.attributes != null)
{
awtAttributedString.addAttributes(run.attributes, run.startIndex, run.endIndex);
}
// if (
// run.startIndex != run.endIndex
// && run.attributes != null
// && !run.attributes.isEmpty()
// )
// {
// for (Iterator it = run.attributes.entrySet().iterator(); it.hasNext();)
// {
// Map.Entry entry = (Map.Entry) it.next();
// AttributedCharacterIterator.Attribute attribute =
// (AttributedCharacterIterator.Attribute) entry.getKey();
// if (!(attribute instanceof JRTextAttribute))
// {
// Object value = entry.getValue();
// awtAttributedString.addAttribute(attribute, value, run.startIndex, run.endIndex);
// }
// }
// }
}
AttributedCharacterIterator iterator = awtAttributedString.getIterator();
int runLimit = 0;
AffineTransform atrans = null;
while(runLimit < iterator.getEndIndex() && (runLimit = iterator.getRunLimit(FONT_ATTRS)) <= iterator.getEndIndex())
{
Map attrs = iterator.getAttributes();
AwtFontAttribute fontAttribute = AwtFontAttribute.fromAttributes(attrs);
FontUtil fontUtil = FontUtil.getInstance(jasperReportsContext);
Font awtFont = fontUtil.getAwtFontFromBundles(
fontAttribute,
((TextAttribute.WEIGHT_BOLD.equals(attrs.get(TextAttribute.WEIGHT))?Font.BOLD:Font.PLAIN)
|(TextAttribute.POSTURE_OBLIQUE.equals(attrs.get(TextAttribute.POSTURE))?Font.ITALIC:Font.PLAIN)),
(Float)attrs.get(TextAttribute.SIZE),
locale,
ignoreMissingFont
);
if (awtFont == null)
{
// The font was not found in any of the font extensions, so it is expected that the TextAttribute.FAMILY attribute
// will be used by AWT. In that case, we want make sure the font family name is available to the JVM.
fontUtil.checkAwtFont(fontAttribute.getFamily(), ignoreMissingFont);
}
else
{
if (AWT_SUPERSCRIPT_FIX_ENABLED && atrans != null)
{
double y = atrans.getTranslateY();
atrans = new AffineTransform();
atrans.translate(0, - y);
awtFont = awtFont.deriveFont(atrans);
atrans = null;
}
Integer superscript = (Integer)attrs.get(TextAttribute.SUPERSCRIPT);
if (TextAttribute.SUPERSCRIPT_SUPER.equals(superscript))
{
atrans = new AffineTransform();
atrans.scale(2 / 3d, 2 / 3d);
atrans.translate(0, - awtFont.getSize() / 2f);
awtFont = awtFont.deriveFont(atrans);
}
else if (TextAttribute.SUPERSCRIPT_SUB.equals(superscript))
{
atrans = new AffineTransform();
atrans.scale(2 / 3d, 2 / 3d);
atrans.translate(0, awtFont.getSize() / 2f);
awtFont = awtFont.deriveFont(atrans);
}
awtAttributedString.addAttribute(TextAttribute.FONT, awtFont, iterator.getIndex(), runLimit);
}
iterator.setIndex(runLimit);
}
}
return awtAttributedString;
}
/**
*
*/
public List getRuns()
{
return runs;
}
/**
*
*/
public static class Run implements Cloneable
{
/**
*
*/
public Map attributes;
public int startIndex;
public int endIndex;
/**
*
*/
public Run(Map attributes, int startIndex, int endIndex)
{
this.attributes = attributes;
this.startIndex = startIndex;
this.endIndex = endIndex;
}
@Override
protected Object clone()
{
return cloneRun();
}
/**
* Clones this object.
*
* @return a clone of this object
*/
public Run cloneRun()
{
try
{
Run clone = (Run) super.clone();
clone.attributes = cloneAttributesMap(attributes);
return clone;
}
catch (CloneNotSupportedException e)
{
// never
throw new JRRuntimeException(e);
}
}
}
public void setGlobalAttributes(Map attributes)
{
this.globalAttributes = attributes;
addRun(new Run(attributes, 0, length()));
}
public Map getGlobalAttributes()
{
return globalAttributes;
}
@Override
protected Object clone() throws CloneNotSupportedException
{
// TODO Auto-generated method stub
return super.clone();
}
protected static Map cloneAttributesMap(Map attributes)
{
return attributes == null ? null : new HashMap<>(attributes);
}
/**
* Clones this object.
*
* @return a clone of this object
*/
public JRStyledText cloneText()
{
try
{
JRStyledText clone = (JRStyledText) super.clone();
clone.globalAttributes = cloneAttributesMap(globalAttributes);
int runsCount = runs.size();
if (runsCount == 0)
{
clone.runs = Collections.emptyList();
}
else if (runsCount == 1)
{
clone.runs = Collections.singletonList(runs.get(0).cloneRun());
}
else
{
clone.runs = new ArrayList<>(runsCount);
for (Iterator it = runs.iterator(); it.hasNext();)
{
Run run = it.next();
Run runClone = run.cloneRun();
clone.runs.add(runClone);
}
}
return clone;
}
catch (CloneNotSupportedException e)
{
// never
throw new JRRuntimeException(e);
}
}
/**
* Inserts a string at specified positions in the styled text.
*
*
* The string is inserted in the style runs located at the insertion
* positions. If a style run finished right before the insertion position,
* the string will be part of this run (but not of the runs that start
* right after the insertion position).
*
* @param str the string to insert
* @param offsets the incremental offsets of the positions at which to
* insert the string
*/
public void insert(String str, short[] offsets)
{
int insertLength = str.length();
int currentLength = length();
//new buffer to do the insertion
StringBuilder newText = new StringBuilder(currentLength + insertLength * offsets.length); //NOPMD
char[] buffer = null;
int offset = 0;
for (int i = 0; i < offsets.length; i++)
{
int charCount = offsets[i];
int prevOffset = offset;
offset += offsets[i];
//append chunk of text
if (buffer == null || buffer.length < charCount)
{
buffer = new char[charCount];
}
getChars(prevOffset, offset, buffer, 0);
newText.append(buffer, 0, charCount);
//append inserted text
newText.append(str);
//adjust runs
//TODO optimize this?
for (Iterator it = runs.iterator(); it.hasNext();)
{
Run run = it.next();
if (run.startIndex >= offset)
{
//inserted before run
run.startIndex += insertLength;
run.endIndex += insertLength;
}
else if (run.endIndex >= offset)
{
//inserted in the middle or immediately after a run
//the inserted text is included in the run
run.endIndex += insertLength;
}
}
}
//append remaining text
int charCount = currentLength - offset;
if (buffer == null || buffer.length < charCount)
{
buffer = new char[charCount];
}
getChars(offset, currentLength, buffer, 0);
newText.append(buffer, 0, charCount);
//overwrite with the inserted buffer
sbuffer = newText;
text = null;
attributedString = null;
awtAttributedString = null;
}
private void getChars(int srcBegin, int srcEnd, char[] dst, int dstBegin)
{
if (text != null)
{
text.getChars(srcBegin, srcEnd, dst, dstBegin);
}
else if (sbuffer != null)
{
sbuffer.getChars(srcBegin, srcEnd, dst, dstBegin);
}
else if (srcBegin < srcEnd)
{
// should not happen
throw
new JRRuntimeException(
EXCEPTION_MESSAGE_KEY_CANNOT_COPY_CHARACTERS,
new Object[]{srcBegin, srcEnd});
}
}
}