org.apache.poi.xddf.usermodel.text.XDDFTextRun Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of apache-poi-ooxml Show documentation
Show all versions of apache-poi-ooxml Show documentation
The Apache Commons Codec package contains simple encoder and decoders for
various formats such as Base64 and Hexadecimal. In addition to these
widely used encoders and decoders, the codec package also maintains a
collection of phonetic encoding utilities.
/* ====================================================================
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.xddf.usermodel.text;
import java.util.LinkedList;
import java.util.Locale;
import java.util.Optional;
import java.util.function.Function;
import java.util.function.Predicate;
import org.apache.poi.common.usermodel.fonts.FontGroup;
import org.apache.poi.ooxml.POIXMLRelation;
import org.apache.poi.ooxml.util.POIXMLUnits;
import org.apache.poi.openxml4j.opc.PackagePart;
import org.apache.poi.openxml4j.opc.PackagePartName;
import org.apache.poi.openxml4j.opc.PackageRelationship;
import org.apache.poi.openxml4j.opc.TargetMode;
import org.apache.poi.util.Beta;
import org.apache.poi.util.Internal;
import org.apache.poi.util.Units;
import org.apache.poi.xddf.usermodel.XDDFColor;
import org.apache.poi.xddf.usermodel.XDDFFillProperties;
import org.apache.poi.xddf.usermodel.XDDFLineProperties;
import org.apache.poi.xddf.usermodel.XDDFSolidFillProperties;
import org.apache.poi.xssf.usermodel.XSSFFont;
import org.openxmlformats.schemas.drawingml.x2006.main.CTRegularTextRun;
import org.openxmlformats.schemas.drawingml.x2006.main.CTTextCharacterProperties;
import org.openxmlformats.schemas.drawingml.x2006.main.CTTextField;
import org.openxmlformats.schemas.drawingml.x2006.main.CTTextLineBreak;
import org.openxmlformats.schemas.drawingml.x2006.main.STTextCapsType;
import org.openxmlformats.schemas.drawingml.x2006.main.STTextStrikeType;
import org.openxmlformats.schemas.drawingml.x2006.main.STTextUnderlineType;
@Beta
public class XDDFTextRun {
private XDDFTextParagraph _parent;
private XDDFRunProperties _properties;
private CTTextLineBreak _tlb;
private CTTextField _tf;
private CTRegularTextRun _rtr;
@Internal
protected XDDFTextRun(CTTextLineBreak run, XDDFTextParagraph parent) {
this._tlb = run;
this._parent = parent;
}
@Internal
protected XDDFTextRun(CTTextField run, XDDFTextParagraph parent) {
this._tf = run;
this._parent = parent;
}
@Internal
protected XDDFTextRun(CTRegularTextRun run, XDDFTextParagraph parent) {
this._rtr = run;
this._parent = parent;
}
public XDDFTextParagraph getParentParagraph() {
return _parent;
}
public boolean isLineBreak() {
return _tlb != null;
}
public boolean isField() {
return _tf != null;
}
public boolean isRegularRun() {
return _rtr != null;
}
public String getText() {
if (isLineBreak()) {
return "\n";
} else if (isField()) {
return _tf.getT();
} else {
return _rtr.getT();
}
}
public void setText(String text) {
if (isField()) {
_tf.setT(text);
} else if (isRegularRun()) {
_rtr.setT(text);
}
}
public void setDirty(Boolean dirty) {
getOrCreateProperties().setDirty(dirty);
}
public Boolean getDirty() {
return findDefinedProperty(
CTTextCharacterProperties::isSetDirty,
CTTextCharacterProperties::getDirty)
.orElse(null);
}
public void setSpellError(Boolean error) {
getOrCreateProperties().setSpellError(error);
}
public Boolean getSpellError() {
return findDefinedProperty(
CTTextCharacterProperties::isSetErr,
CTTextCharacterProperties::getErr)
.orElse(null);
}
public void setNoProof(Boolean noproof) {
getOrCreateProperties().setNoProof(noproof);
}
public Boolean getNoProof() {
return findDefinedProperty(
CTTextCharacterProperties::isSetNoProof,
CTTextCharacterProperties::getNoProof)
.orElse(null);
}
public void setNormalizeHeights(Boolean normalize) {
getOrCreateProperties().setNormalizeHeights(normalize);
}
public Boolean getNormalizeHeights() {
return findDefinedProperty(
CTTextCharacterProperties::isSetNormalizeH,
CTTextCharacterProperties::getNormalizeH)
.orElse(null);
}
public void setKumimoji(Boolean kumimoji) {
getOrCreateProperties().setKumimoji(kumimoji);
}
public boolean isKumimoji() {
return findDefinedProperty(
CTTextCharacterProperties::isSetKumimoji,
CTTextCharacterProperties::getKumimoji)
.orElse(false);
}
/**
* Specifies whether this run of text will be formatted as bold text.
*
* @param bold
* whether this run of text will be formatted as bold text.
*/
public void setBold(Boolean bold) {
getOrCreateProperties().setBold(bold);
}
/**
* @return whether this run of text is formatted as bold text.
*/
public boolean isBold() {
return findDefinedProperty(
CTTextCharacterProperties::isSetB,
CTTextCharacterProperties::getB)
.orElse(false);
}
/**
* @param italic
* whether this run of text is formatted as italic text.
*/
public void setItalic(Boolean italic) {
getOrCreateProperties().setItalic(italic);
}
/**
* @return whether this run of text is formatted as italic text.
*/
public boolean isItalic() {
return findDefinedProperty(
CTTextCharacterProperties::isSetI,
CTTextCharacterProperties::getI)
.orElse(false);
}
/**
* @param strike
* which strike style this run of text is formatted with.
*/
public void setStrikeThrough(StrikeType strike) {
getOrCreateProperties().setStrikeThrough(strike);
}
/**
* @return whether this run of text is formatted as striked text.
*/
public boolean isStrikeThrough() {
return findDefinedProperty(
CTTextCharacterProperties::isSetStrike,
CTTextCharacterProperties::getStrike)
.map(strike -> strike != STTextStrikeType.NO_STRIKE)
.orElse(false);
}
/**
* @return which strike style this run of text is formatted with.
*/
public StrikeType getStrikeThrough() {
return findDefinedProperty(
CTTextCharacterProperties::isSetStrike,
CTTextCharacterProperties::getStrike)
.map(StrikeType::valueOf)
.orElse(null);
}
/**
* @param underline
* which underline style this run of text is formatted with.
*/
public void setUnderline(UnderlineType underline) {
getOrCreateProperties().setUnderline(underline);
}
/**
* @return whether this run of text is formatted as underlined text.
*/
public boolean isUnderline() {
return findDefinedProperty(
CTTextCharacterProperties::isSetU,
CTTextCharacterProperties::getU)
.map(underline -> underline != STTextUnderlineType.NONE)
.orElse(false);
}
/**
* @return which underline style this run of text is formatted with.
*/
public UnderlineType getUnderline() {
return findDefinedProperty(
CTTextCharacterProperties::isSetU,
CTTextCharacterProperties::getU)
.map(UnderlineType::valueOf)
.orElse(null);
}
/**
* @param caps
* which caps style this run of text is formatted with.
*/
public void setCapitals(CapsType caps) {
getOrCreateProperties().setCapitals(caps);
}
/**
* @return whether this run of text is formatted as capitalized text.
*/
public boolean isCapitals() {
return findDefinedProperty(
CTTextCharacterProperties::isSetCap,
CTTextCharacterProperties::getCap)
.map(caps -> caps != STTextCapsType.NONE)
.orElse(false);
}
/**
* @return which caps style this run of text is formatted with.
*/
public CapsType getCapitals() {
return findDefinedProperty(
CTTextCharacterProperties::isSetCap,
CTTextCharacterProperties::getCap)
.map(CapsType::valueOf)
.orElse(null);
}
/**
* @return whether a run of text will be formatted as a subscript text.
* Default is false.
*/
public boolean isSubscript() {
return findDefinedProperty(
CTTextCharacterProperties::isSetBaseline,
CTTextCharacterProperties::xgetBaseline)
.map(POIXMLUnits::parsePercent)
.map(baseline -> baseline < 0)
.orElse(false);
}
/**
* @return whether a run of text will be formatted as a superscript text.
* Default is false.
*/
public boolean isSuperscript() {
return findDefinedProperty(
CTTextCharacterProperties::isSetBaseline,
CTTextCharacterProperties::xgetBaseline)
.map(POIXMLUnits::parsePercent)
.map(baseline -> baseline > 0)
.orElse(false);
}
/**
* Set the baseline for both the superscript and subscript fonts.
*
* The size is specified using a percentage.
* Positive values indicate superscript, negative values indicate subscript.
*
*
* @param offset
*/
public void setBaseline(Double offset) {
if (offset == null) {
getOrCreateProperties().setBaseline(null);
} else {
getOrCreateProperties().setBaseline((int) (offset * 1000));
}
}
/**
* Set whether the text in this run is formatted as superscript.
*
* The size is specified using a percentage.
*
*
* @param offset
*/
public void setSuperscript(Double offset) {
setBaseline(offset == null ? null : Math.abs(offset));
}
/**
* Set whether the text in this run is formatted as subscript.
*
* The size is specified using a percentage.
*
*
* @param offset
*/
public void setSubscript(Double offset) {
setBaseline(offset == null ? null : -Math.abs(offset));
}
public void setFillProperties(XDDFFillProperties properties) {
getOrCreateProperties().setFillProperties(properties);
}
public void setFontColor(XDDFColor color) {
XDDFSolidFillProperties props = new XDDFSolidFillProperties();
props.setColor(color);
setFillProperties(props);
}
public XDDFColor getFontColor() {
XDDFSolidFillProperties solid = findDefinedProperty(
CTTextCharacterProperties::isSetSolidFill,
CTTextCharacterProperties::getSolidFill)
.map(XDDFSolidFillProperties::new)
.orElse(new XDDFSolidFillProperties());
return solid.getColor();
}
/**
* Note: In order to get fonts to unset the property for a given font family use
* {@link XDDFFont#unsetFontForGroup(FontGroup)}
*
* @param fonts
* to set or unset on the run.
*/
public void setFonts(XDDFFont[] fonts) {
getOrCreateProperties().setFonts(fonts);
}
public XDDFFont[] getFonts() {
LinkedList list = new LinkedList<>();
findDefinedProperty(CTTextCharacterProperties::isSetCs, CTTextCharacterProperties::getCs)
.map(font -> new XDDFFont(FontGroup.COMPLEX_SCRIPT, font))
.ifPresent(list::add);
findDefinedProperty(CTTextCharacterProperties::isSetEa, CTTextCharacterProperties::getEa)
.map(font -> new XDDFFont(FontGroup.EAST_ASIAN, font))
.ifPresent(list::add);
findDefinedProperty(CTTextCharacterProperties::isSetLatin, CTTextCharacterProperties::getLatin)
.map(font -> new XDDFFont(FontGroup.LATIN, font))
.ifPresent(list::add);
findDefinedProperty(CTTextCharacterProperties::isSetSym, CTTextCharacterProperties::getSym)
.map(font -> new XDDFFont(FontGroup.SYMBOL, font))
.ifPresent(list::add);
return list.toArray(new XDDFFont[0]);
}
/**
* @param size
* font size in points. The value null unsets the
* size for this run.
*
* - Minimum inclusive =
* - 1
* - Maximum inclusive =
* - 400
*
*/
public void setFontSize(Double size) {
getOrCreateProperties().setFontSize(size);
}
public Double getFontSize() {
Integer size = findDefinedProperty(
CTTextCharacterProperties::isSetSz,
CTTextCharacterProperties::getSz)
.orElse(100 * XSSFFont.DEFAULT_FONT_SIZE); // default font size
double scale = _parent.getParentBody().getBodyProperties().getAutoFit().getFontScale() / 10_000_000.0;
return size * scale;
}
/**
* Set the kerning of characters within a text run.
*
* The value null unsets the kerning for this run.
*
*
* @param kerning
* character kerning in points.
*
* - Minimum inclusive =
* - 0
* - Maximum inclusive =
* - 4000
*
*/
public void setCharacterKerning(Double kerning) {
getOrCreateProperties().setCharacterKerning(kerning);
}
/**
*
* @return the kerning of characters within a text run,
* If this attribute is omitted then returns null.
*/
public Double getCharacterKerning() {
return findDefinedProperty(
CTTextCharacterProperties::isSetKern,
CTTextCharacterProperties::getKern)
.map(kerning -> 0.01 * kerning)
.orElse(null);
}
/**
* Set the spacing between characters within a text run.
*
* The spacing is specified in points. Positive values will cause the text to expand,
* negative values to condense.
*
*
* The value null unsets the spacing for this run.
*
*
* @param spacing
* character spacing in points.
*
* - Minimum inclusive =
* - -4000
* - Maximum inclusive =
* - 4000
*
*/
public void setCharacterSpacing(Double spacing) {
getOrCreateProperties().setCharacterSpacing(spacing);
}
/**
*
* @return the spacing between characters within a text run,
* If this attribute is omitted then returns null.
*/
public Double getCharacterSpacing() {
return findDefinedProperty(
CTTextCharacterProperties::isSetSpc,
CTTextCharacterProperties::xgetSpc)
.map(POIXMLUnits::parseLength)
.map(Units::toPoints)
.orElse(null);
}
public void setBookmark(String bookmark) {
getOrCreateProperties().setBookmark(bookmark);
}
public String getBookmark() {
return findDefinedProperty(
CTTextCharacterProperties::isSetBmk,
CTTextCharacterProperties::getBmk)
.orElse(null);
}
public XDDFHyperlink linkToExternal(String url, PackagePart localPart, POIXMLRelation relation) {
PackageRelationship rel = localPart.addExternalRelationship(url, relation.getRelation());
XDDFHyperlink link = new XDDFHyperlink(rel.getId());
getOrCreateProperties().setHyperlink(link);
return link;
}
public XDDFHyperlink linkToAction(String action) {
XDDFHyperlink link = new XDDFHyperlink("", action);
getOrCreateProperties().setHyperlink(link);
return link;
}
public XDDFHyperlink linkToInternal(String action, PackagePart localPart, POIXMLRelation relation, PackagePartName target) {
PackageRelationship rel = localPart.addRelationship(target, TargetMode.INTERNAL, relation.getRelation());
XDDFHyperlink link = new XDDFHyperlink(rel.getId(), action);
getOrCreateProperties().setHyperlink(link);
return link;
}
public XDDFHyperlink getHyperlink() {
return findDefinedProperty(
CTTextCharacterProperties::isSetHlinkClick,
CTTextCharacterProperties::getHlinkClick)
.map(XDDFHyperlink::new)
.orElse(null);
}
public XDDFHyperlink createMouseOver(String action) {
XDDFHyperlink link = new XDDFHyperlink("", action);
getOrCreateProperties().setMouseOver(link);
return link;
}
public XDDFHyperlink getMouseOver() {
return findDefinedProperty(
CTTextCharacterProperties::isSetHlinkMouseOver,
CTTextCharacterProperties::getHlinkMouseOver)
.map(XDDFHyperlink::new)
.orElse(null);
}
public void setLanguage(Locale lang) {
getOrCreateProperties().setLanguage(lang);
}
public Locale getLanguage() {
return findDefinedProperty(
CTTextCharacterProperties::isSetLang,
CTTextCharacterProperties::getLang)
.map(Locale::forLanguageTag)
.orElse(null);
}
public void setAlternativeLanguage(Locale lang) {
getOrCreateProperties().setAlternativeLanguage(lang);
}
public Locale getAlternativeLanguage() {
return findDefinedProperty(
CTTextCharacterProperties::isSetAltLang,
CTTextCharacterProperties::getAltLang)
.map(Locale::forLanguageTag)
.orElse(null);
}
public void setHighlight(XDDFColor color) {
getOrCreateProperties().setHighlight(color);
}
public XDDFColor getHighlight() {
return findDefinedProperty(
CTTextCharacterProperties::isSetHighlight,
CTTextCharacterProperties::getHighlight)
.map(XDDFColor::forColorContainer)
.orElse(null);
}
public void setLineProperties(XDDFLineProperties properties) {
getOrCreateProperties().setLineProperties(properties);
}
public XDDFLineProperties getLineProperties() {
return findDefinedProperty(
CTTextCharacterProperties::isSetLn,
CTTextCharacterProperties::getLn)
.map(XDDFLineProperties::new)
.orElse(null);
}
private Optional findDefinedProperty(Predicate isSet, Function getter) {
CTTextCharacterProperties props = getProperties();
if (props != null && isSet.test(props)) {
return Optional.ofNullable(getter.apply(props));
} else {
return _parent.findDefinedRunProperty(isSet, getter);
}
}
@Internal
protected CTTextCharacterProperties getProperties() {
if (isLineBreak() && _tlb.isSetRPr()) {
return _tlb.getRPr();
} else if (isField() && _tf.isSetRPr()) {
return _tf.getRPr();
} else if (isRegularRun() && _rtr.isSetRPr()) {
return _rtr.getRPr();
}
XDDFRunProperties defaultProperties = _parent.getDefaultRunProperties();
return (defaultProperties == null) ? null : defaultProperties.getXmlObject();
}
private XDDFRunProperties getOrCreateProperties() {
if (_properties == null) {
if (isLineBreak()) {
_properties = new XDDFRunProperties(_tlb.isSetRPr() ? _tlb.getRPr() : _tlb.addNewRPr());
} else if (isField()) {
_properties = new XDDFRunProperties(_tf.isSetRPr() ? _tf.getRPr() : _tf.addNewRPr());
} else if (isRegularRun()) {
_properties = new XDDFRunProperties(_rtr.isSetRPr() ? _rtr.getRPr() : _rtr.addNewRPr());
}
}
return _properties;
}
}