|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669 |
- /* ====================================================================
- 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.xslf.usermodel;
-
- import java.awt.Color;
-
- import org.apache.poi.openxml4j.exceptions.OpenXML4JRuntimeException;
- import org.apache.poi.openxml4j.opc.PackagePart;
- import org.apache.poi.sl.draw.DrawPaint;
- import org.apache.poi.sl.usermodel.PaintStyle;
- import org.apache.poi.sl.usermodel.PaintStyle.SolidPaint;
- import org.apache.poi.sl.usermodel.TextRun;
- import org.apache.poi.util.Beta;
- import org.apache.poi.xslf.model.CharacterPropertyFetcher;
- import org.apache.poi.xslf.usermodel.XSLFPropertiesDelegate.XSLFFillProperties;
- import org.apache.xmlbeans.XmlObject;
- import org.openxmlformats.schemas.drawingml.x2006.main.CTHyperlink;
- import org.openxmlformats.schemas.drawingml.x2006.main.CTRegularTextRun;
- import org.openxmlformats.schemas.drawingml.x2006.main.CTSchemeColor;
- import org.openxmlformats.schemas.drawingml.x2006.main.CTShapeStyle;
- import org.openxmlformats.schemas.drawingml.x2006.main.CTSolidColorFillProperties;
- import org.openxmlformats.schemas.drawingml.x2006.main.CTTextCharacterProperties;
- import org.openxmlformats.schemas.drawingml.x2006.main.CTTextField;
- import org.openxmlformats.schemas.drawingml.x2006.main.CTTextFont;
- import org.openxmlformats.schemas.drawingml.x2006.main.CTTextLineBreak;
- import org.openxmlformats.schemas.drawingml.x2006.main.CTTextNormalAutofit;
- import org.openxmlformats.schemas.drawingml.x2006.main.CTTextParagraphProperties;
- import org.openxmlformats.schemas.drawingml.x2006.main.STTextStrikeType;
- import org.openxmlformats.schemas.drawingml.x2006.main.STTextUnderlineType;
- import org.openxmlformats.schemas.presentationml.x2006.main.CTPlaceholder;
-
- /**
- * Represents a run of text within the containing text body. The run element is the
- * lowest level text separation mechanism within a text body.
- */
- @Beta
- public class XSLFTextRun implements TextRun {
- private final XmlObject _r;
- private final XSLFTextParagraph _p;
-
- protected XSLFTextRun(XmlObject r, XSLFTextParagraph p){
- _r = r;
- _p = p;
- if (!(r instanceof CTRegularTextRun || r instanceof CTTextLineBreak || r instanceof CTTextField)) {
- throw new OpenXML4JRuntimeException("unsupported text run of type "+r.getClass());
- }
- }
-
- XSLFTextParagraph getParentParagraph(){
- return _p;
- }
-
- @Override
- public String getRawText(){
- if (_r instanceof CTTextField) {
- return ((CTTextField)_r).getT();
- } else if (_r instanceof CTTextLineBreak) {
- return "\n";
- }
- return ((CTRegularTextRun)_r).getT();
- }
-
- String getRenderableText(){
- if (_r instanceof CTTextField) {
- CTTextField tf = (CTTextField)_r;
- XSLFSheet sheet = _p.getParentShape().getSheet();
- if ("slidenum".equals(tf.getType()) && sheet instanceof XSLFSlide) {
- return Integer.toString(((XSLFSlide)sheet).getSlideNumber());
- }
- return tf.getT();
- } else if (_r instanceof CTTextLineBreak) {
- return "\n";
- }
-
-
- String txt = ((CTRegularTextRun)_r).getT();
- TextCap cap = getTextCap();
- StringBuffer buf = new StringBuffer();
- for(int i = 0; i < txt.length(); i++) {
- char c = txt.charAt(i);
- if(c == '\t') {
- // TODO: finish support for tabs
- buf.append(" ");
- } else {
- switch (cap){
- case ALL:
- buf.append(Character.toUpperCase(c));
- break;
- case SMALL:
- buf.append(Character.toLowerCase(c));
- break;
- default:
- buf.append(c);
- }
- }
- }
-
- return buf.toString();
- }
-
- @Override
- public void setText(String text){
- if (_r instanceof CTTextField) {
- ((CTTextField)_r).setT(text);
- } else if (_r instanceof CTTextLineBreak) {
- // ignored
- return;
- } else {
- ((CTRegularTextRun)_r).setT(text);
- }
- }
-
- /**
- * Return the text run xmlbeans object.
- * Depending on the type of text run, this can be {@link CTTextField},
- * {@link CTTextLineBreak} or usually a {@link CTRegularTextRun}
- *
- * @return the xmlbeans object
- */
- public XmlObject getXmlObject(){
- return _r;
- }
-
- @Override
- public void setFontColor(Color color) {
- setFontColor(DrawPaint.createSolidPaint(color));
- }
-
- @Override
- public void setFontColor(PaintStyle color) {
- if (!(color instanceof SolidPaint)) {
- throw new IllegalArgumentException("Currently only SolidPaint is supported!");
- }
- SolidPaint sp = (SolidPaint)color;
- Color c = DrawPaint.applyColorTransform(sp.getSolidColor());
-
- CTTextCharacterProperties rPr = getRPr(true);
- CTSolidColorFillProperties fill = rPr.isSetSolidFill() ? rPr.getSolidFill() : rPr.addNewSolidFill();
-
- XSLFColor col = new XSLFColor(fill, getParentParagraph().getParentShape().getSheet().getTheme(), fill.getSchemeClr());
- col.setColor(c);
- }
-
- @Override
- public PaintStyle getFontColor(){
- final boolean hasPlaceholder = getParentParagraph().getParentShape().getPlaceholder() != null;
- CharacterPropertyFetcher<PaintStyle> fetcher = new CharacterPropertyFetcher<PaintStyle>(_p.getIndentLevel()){
- @Override
- public boolean fetch(CTTextCharacterProperties props){
- if (props == null) {
- return false;
- }
-
- XSLFShape shape = _p.getParentShape();
- CTShapeStyle style = shape.getSpStyle();
- CTSchemeColor phClr = null;
- if (style != null && style.getFontRef() != null) {
- phClr = style.getFontRef().getSchemeClr();
- }
-
- XSLFFillProperties fp = XSLFPropertiesDelegate.getFillDelegate(props);
- XSLFSheet sheet = shape.getSheet();
- PackagePart pp = sheet.getPackagePart();
- XSLFTheme theme = sheet.getTheme();
- PaintStyle ps = XSLFShape.selectPaint(fp, phClr, pp, theme, hasPlaceholder);
-
- if (ps != null) {
- setValue(ps);
- return true;
- }
-
- return false;
- }
- };
- fetchCharacterProperty(fetcher);
- return fetcher.getValue();
- }
-
- @Override
- public void setFontSize(Double fontSize){
- CTTextCharacterProperties rPr = getRPr(true);
- if(fontSize == null) {
- if (rPr.isSetSz()) {
- rPr.unsetSz();
- }
- } else {
- if (fontSize < 1.0) {
- throw new IllegalArgumentException("Minimum font size is 1pt but was " + fontSize);
- }
-
- rPr.setSz((int)(100*fontSize));
- }
- }
-
- @Override
- public Double getFontSize(){
- double scale = 1;
- CTTextNormalAutofit afit = getParentParagraph().getParentShape().getTextBodyPr().getNormAutofit();
- if(afit != null) {
- scale = (double)afit.getFontScale() / 100000;
- }
-
- CharacterPropertyFetcher<Double> fetcher = new CharacterPropertyFetcher<Double>(_p.getIndentLevel()){
- @Override
- public boolean fetch(CTTextCharacterProperties props){
- if (props != null && props.isSetSz()) {
- setValue(props.getSz()*0.01);
- return true;
- }
- return false;
- }
- };
- fetchCharacterProperty(fetcher);
- return fetcher.getValue() == null ? null : fetcher.getValue()*scale;
- }
-
- /**
- *
- * @return the spacing between characters within a text run,
- * If this attribute is omitted than a value of 0 or no adjustment is assumed.
- */
- public double getCharacterSpacing(){
-
- CharacterPropertyFetcher<Double> fetcher = new CharacterPropertyFetcher<Double>(_p.getIndentLevel()){
- @Override
- public boolean fetch(CTTextCharacterProperties props){
- if (props != null && props.isSetSpc()) {
- setValue(props.getSpc()*0.01);
- return true;
- }
- return false;
- }
- };
- fetchCharacterProperty(fetcher);
- return fetcher.getValue() == null ? 0 : fetcher.getValue();
- }
-
- /**
- * Set the spacing between characters within a text run.
- * <p>
- * The spacing is specified in points. Positive values will cause the text to expand,
- * negative values to condense.
- * </p>
- *
- * @param spc character spacing in points.
- */
- public void setCharacterSpacing(double spc){
- CTTextCharacterProperties rPr = getRPr(true);
- if(spc == 0.0) {
- if(rPr.isSetSpc()) {
- rPr.unsetSpc();
- }
- } else {
- rPr.setSpc((int)(100*spc));
- }
- }
-
- @Override
- public void setFontFamily(String typeface){
- setFontFamily(typeface, (byte)-1, (byte)-1, false);
- }
-
- public void setFontFamily(String typeface, byte charset, byte pictAndFamily, boolean isSymbol){
- CTTextCharacterProperties rPr = getRPr(true);
-
- if(typeface == null){
- if(rPr.isSetLatin()) {
- rPr.unsetLatin();
- }
- if(rPr.isSetCs()) {
- rPr.unsetCs();
- }
- if(rPr.isSetSym()) {
- rPr.unsetSym();
- }
- } else {
- if(isSymbol){
- CTTextFont font = rPr.isSetSym() ? rPr.getSym() : rPr.addNewSym();
- font.setTypeface(typeface);
- } else {
- CTTextFont latin = rPr.isSetLatin() ? rPr.getLatin() : rPr.addNewLatin();
- latin.setTypeface(typeface);
- if(charset != -1) {
- latin.setCharset(charset);
- }
- if(pictAndFamily != -1) {
- latin.setPitchFamily(pictAndFamily);
- }
- }
- }
- }
-
- @Override
- public String getFontFamily(){
- final XSLFTheme theme = _p.getParentShape().getSheet().getTheme();
-
- CharacterPropertyFetcher<String> visitor = new CharacterPropertyFetcher<String>(_p.getIndentLevel()){
- @Override
- public boolean fetch(CTTextCharacterProperties props){
- if (props != null) {
- CTTextFont font = props.getLatin();
- if (font != null) {
- String typeface = font.getTypeface();
- if("+mj-lt".equals(typeface)) {
- typeface = theme.getMajorFont();
- } else if ("+mn-lt".equals(typeface)){
- typeface = theme.getMinorFont();
- }
- setValue(typeface);
- return true;
- }
- }
- return false;
- }
- };
- fetchCharacterProperty(visitor);
-
- return visitor.getValue();
- }
-
- @Override
- public byte getPitchAndFamily(){
- // final XSLFTheme theme = _p.getParentShape().getSheet().getTheme();
-
- CharacterPropertyFetcher<Byte> visitor = new CharacterPropertyFetcher<Byte>(_p.getIndentLevel()){
- @Override
- public boolean fetch(CTTextCharacterProperties props){
- if (props != null) {
- CTTextFont font = props.getLatin();
- if (font != null) {
- setValue(font.getPitchFamily());
- return true;
- }
- }
- return false;
- }
- };
- fetchCharacterProperty(visitor);
-
- return visitor.getValue() == null ? 0 : visitor.getValue();
- }
-
- @Override
- public void setStrikethrough(boolean strike) {
- getRPr(true).setStrike(strike ? STTextStrikeType.SNG_STRIKE : STTextStrikeType.NO_STRIKE);
- }
-
- @Override
- public boolean isStrikethrough() {
- CharacterPropertyFetcher<Boolean> fetcher = new CharacterPropertyFetcher<Boolean>(_p.getIndentLevel()){
- @Override
- public boolean fetch(CTTextCharacterProperties props){
- if(props != null && props.isSetStrike()) {
- setValue(props.getStrike() != STTextStrikeType.NO_STRIKE);
- return true;
- }
- return false;
- }
- };
- fetchCharacterProperty(fetcher);
- return fetcher.getValue() == null ? false : fetcher.getValue();
- }
-
- @Override
- public boolean isSuperscript() {
- CharacterPropertyFetcher<Boolean> fetcher = new CharacterPropertyFetcher<Boolean>(_p.getIndentLevel()){
- @Override
- public boolean fetch(CTTextCharacterProperties props){
- if (props != null && props.isSetBaseline()) {
- setValue(props.getBaseline() > 0);
- return true;
- }
- return false;
- }
- };
- fetchCharacterProperty(fetcher);
- return fetcher.getValue() == null ? false : fetcher.getValue();
- }
-
- /**
- * Set the baseline for both the superscript and subscript fonts.
- * <p>
- * The size is specified using a percentage.
- * Positive values indicate superscript, negative values indicate subscript.
- * </p>
- *
- * @param baselineOffset
- */
- public void setBaselineOffset(double baselineOffset){
- getRPr(true).setBaseline((int) baselineOffset * 1000);
- }
-
- /**
- * Set whether the text in this run is formatted as superscript.
- * Default base line offset is 30%
- *
- * @see #setBaselineOffset(double)
- */
- public void setSuperscript(boolean flag){
- setBaselineOffset(flag ? 30. : 0.);
- }
-
- /**
- * Set whether the text in this run is formatted as subscript.
- * Default base line offset is -25%.
- *
- * @see #setBaselineOffset(double)
- */
- public void setSubscript(boolean flag){
- setBaselineOffset(flag ? -25.0 : 0.);
- }
-
- @Override
- public boolean isSubscript() {
- CharacterPropertyFetcher<Boolean> fetcher = new CharacterPropertyFetcher<Boolean>(_p.getIndentLevel()){
- @Override
- public boolean fetch(CTTextCharacterProperties props){
- if (props != null && props.isSetBaseline()) {
- setValue(props.getBaseline() < 0);
- return true;
- }
- return false;
- }
- };
- fetchCharacterProperty(fetcher);
- return fetcher.getValue() == null ? false : fetcher.getValue();
- }
-
- /**
- * @return whether a run of text will be formatted as a superscript text. Default is false.
- */
- @Override
- public TextCap getTextCap() {
- CharacterPropertyFetcher<TextCap> fetcher = new CharacterPropertyFetcher<TextCap>(_p.getIndentLevel()){
- @Override
- public boolean fetch(CTTextCharacterProperties props){
- if (props != null && props.isSetCap()) {
- int idx = props.getCap().intValue() - 1;
- setValue(TextCap.values()[idx]);
- return true;
- }
- return false;
- }
- };
- fetchCharacterProperty(fetcher);
- return fetcher.getValue() == null ? TextCap.NONE : fetcher.getValue();
- }
-
- @Override
- public void setBold(boolean bold){
- getRPr(true).setB(bold);
- }
-
- @Override
- public boolean isBold(){
- CharacterPropertyFetcher<Boolean> fetcher = new CharacterPropertyFetcher<Boolean>(_p.getIndentLevel()){
- @Override
- public boolean fetch(CTTextCharacterProperties props){
- if (props != null && props.isSetB()) {
- setValue(props.getB());
- return true;
- }
- return false;
- }
- };
- fetchCharacterProperty(fetcher);
- return fetcher.getValue() == null ? false : fetcher.getValue();
- }
-
- @Override
- public void setItalic(boolean italic){
- getRPr(true).setI(italic);
- }
-
- @Override
- public boolean isItalic(){
- CharacterPropertyFetcher<Boolean> fetcher = new CharacterPropertyFetcher<Boolean>(_p.getIndentLevel()){
- @Override
- public boolean fetch(CTTextCharacterProperties props){
- if (props != null && props.isSetI()) {
- setValue(props.getI());
- return true;
- }
- return false;
- }
- };
- fetchCharacterProperty(fetcher);
- return fetcher.getValue() == null ? false : fetcher.getValue();
- }
-
- @Override
- public void setUnderlined(boolean underline) {
- getRPr(true).setU(underline ? STTextUnderlineType.SNG : STTextUnderlineType.NONE);
- }
-
- @Override
- public boolean isUnderlined(){
- CharacterPropertyFetcher<Boolean> fetcher = new CharacterPropertyFetcher<Boolean>(_p.getIndentLevel()){
- @Override
- public boolean fetch(CTTextCharacterProperties props){
- if (props != null && props.isSetU()) {
- setValue(props.getU() != STTextUnderlineType.NONE);
- return true;
- }
- return false;
- }
- };
- fetchCharacterProperty(fetcher);
- return fetcher.getValue() == null ? false : fetcher.getValue();
- }
-
- /**
- * Return the character properties
- *
- * @param create if true, create an empty character properties object if it doesn't exist
- * @return the character properties or null if create was false and the properties haven't exist
- */
- protected CTTextCharacterProperties getRPr(boolean create) {
- if (_r instanceof CTTextField) {
- CTTextField tf = (CTTextField)_r;
- if (tf.isSetRPr()) {
- return tf.getRPr();
- } else if (create) {
- return tf.addNewRPr();
- }
- } else if (_r instanceof CTTextLineBreak) {
- CTTextLineBreak tlb = (CTTextLineBreak)_r;
- if (tlb.isSetRPr()) {
- return tlb.getRPr();
- } else if (create) {
- return tlb.addNewRPr();
- }
- } else {
- CTRegularTextRun tr = (CTRegularTextRun)_r;
- if (tr.isSetRPr()) {
- return tr.getRPr();
- } else if (create) {
- return tr.addNewRPr();
- }
- }
- return null;
- }
-
- @Override
- public String toString(){
- return "[" + getClass() + "]" + getRawText();
- }
-
- @Override
- public XSLFHyperlink createHyperlink(){
- XSLFHyperlink hl = getHyperlink();
- if (hl != null) {
- return hl;
- }
-
- CTTextCharacterProperties rPr = getRPr(true);
- return new XSLFHyperlink(rPr.addNewHlinkClick(), _p.getParentShape().getSheet());
- }
-
- @Override
- public XSLFHyperlink getHyperlink(){
- CTTextCharacterProperties rPr = getRPr(false);
- if (rPr == null) {
- return null;
- }
- CTHyperlink hl = rPr.getHlinkClick();
- if (hl == null) {
- return null;
- }
- return new XSLFHyperlink(hl, _p.getParentShape().getSheet());
- }
-
- private boolean fetchCharacterProperty(CharacterPropertyFetcher<?> fetcher){
- XSLFTextShape shape = _p.getParentShape();
- XSLFSheet sheet = shape.getSheet();
-
- CTTextCharacterProperties rPr = getRPr(false);
- if (rPr != null && fetcher.fetch(rPr)) {
- return true;
- }
-
- if (shape.fetchShapeProperty(fetcher)) {
- return true;
- }
-
- CTPlaceholder ph = shape.getCTPlaceholder();
- if (ph == null){
- // if it is a plain text box then take defaults from presentation.xml
- @SuppressWarnings("resource")
- XMLSlideShow ppt = sheet.getSlideShow();
- // TODO: determine master shape
- CTTextParagraphProperties themeProps = ppt.getDefaultParagraphStyle(_p.getIndentLevel());
- if (themeProps != null && fetcher.fetch(themeProps)) {
- return true;
- }
- }
-
- // TODO: determine master shape
- CTTextParagraphProperties defaultProps = _p.getDefaultMasterStyle();
- if(defaultProps != null && fetcher.fetch(defaultProps)) {
- return true;
- }
-
- return false;
- }
-
- void copy(XSLFTextRun r){
- String srcFontFamily = r.getFontFamily();
- if(srcFontFamily != null && !srcFontFamily.equals(getFontFamily())){
- setFontFamily(srcFontFamily);
- }
-
- PaintStyle srcFontColor = r.getFontColor();
- if(srcFontColor != null && !srcFontColor.equals(getFontColor())){
- setFontColor(srcFontColor);
- }
-
- double srcFontSize = r.getFontSize();
- if(srcFontSize != getFontSize()){
- setFontSize(srcFontSize);
- }
-
- boolean bold = r.isBold();
- if(bold != isBold()) {
- setBold(bold);
- }
-
- boolean italic = r.isItalic();
- if(italic != isItalic()) {
- setItalic(italic);
- }
-
- boolean underline = r.isUnderlined();
- if(underline != isUnderlined()) {
- setUnderlined(underline);
- }
-
- boolean strike = r.isStrikethrough();
- if(strike != isStrikethrough()) {
- setStrikethrough(strike);
- }
- }
-
-
- @Override
- public FieldType getFieldType() {
- if (_r instanceof CTTextField) {
- CTTextField tf = (CTTextField)_r;
- if ("slidenum".equals(tf.getType())) {
- return FieldType.SLIDE_NUMBER;
- }
- }
- return null;
- }
- }
|