123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523 |
- /* ====================================================================
- 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 org.apache.poi.util.Beta;
- import org.apache.poi.xslf.model.CharacterPropertyFetcher;
- import org.openxmlformats.schemas.drawingml.x2006.main.CTRegularTextRun;
- import org.openxmlformats.schemas.drawingml.x2006.main.CTSRgbColor;
- 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.CTTextFont;
- 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.drawingml.x2006.main.STSchemeColorVal;
- import org.openxmlformats.schemas.presentationml.x2006.main.CTPlaceholder;
-
- import java.awt.Color;
- import java.awt.font.FontRenderContext;
- import java.awt.font.TextLayout;
- import java.awt.font.TextAttribute;
- import java.text.AttributedString;
-
- /**
- * Represents a run of text within the containing text body. The run element is the
- * lowest level text separation mechanism within a text body.
- *
- * @author Yegor Kozlov
- */
- @Beta
- public class XSLFTextRun {
- private final CTRegularTextRun _r;
- private final XSLFTextParagraph _p;
-
- XSLFTextRun(CTRegularTextRun r, XSLFTextParagraph p){
- _r = r;
- _p = p;
- }
-
- XSLFTextParagraph getParentParagraph(){
- return _p;
- }
-
- public String getText(){
- return _r.getT();
- }
-
- String getRenderableText(){
- String txt = _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();
- }
-
- /**
- * Replace a tab with the effective number of white spaces.
- *
- * @return
- */
- private String tab2space(){
- AttributedString string = new AttributedString(" ");
- // user can pass an object to convert fonts via a rendering hint
- string.addAttribute(TextAttribute.FAMILY, getFontFamily());
-
- string.addAttribute(TextAttribute.SIZE, (float)getFontSize());
- TextLayout l = new TextLayout(string.getIterator(), new FontRenderContext(null, true, true));
- double wspace = l.getAdvance();
-
- double tabSz = _p.getDefaultTabSize();
-
- int numSpaces = (int)Math.ceil(tabSz / wspace);
- StringBuffer buf = new StringBuffer();
- for(int i = 0; i < numSpaces; i++) {
- buf.append(' ');
- }
- return buf.toString();
- }
-
- public void setText(String text){
- _r.setT(text);
- }
-
- public CTRegularTextRun getXmlObject(){
- return _r;
- }
-
- public void setFontColor(Color color){
- CTTextCharacterProperties rPr = getRpR();
- CTSolidColorFillProperties fill = rPr.isSetSolidFill() ? rPr.getSolidFill() : rPr.addNewSolidFill();
- CTSRgbColor clr = fill.isSetSrgbClr() ? fill.getSrgbClr() : fill.addNewSrgbClr();
- clr.setVal(new byte[]{(byte)color.getRed(), (byte)color.getGreen(), (byte)color.getBlue()});
-
- if(fill.isSetHslClr()) fill.unsetHslClr();
- if(fill.isSetPrstClr()) fill.unsetPrstClr();
- if(fill.isSetSchemeClr()) fill.unsetSchemeClr();
- if(fill.isSetScrgbClr()) fill.unsetScrgbClr();
- if(fill.isSetSysClr()) fill.unsetSysClr();
-
- }
-
- public Color getFontColor(){
- final XSLFTheme theme = _p.getParentShape().getSheet().getTheme();
- CTShapeStyle style = _p.getParentShape().getSpStyle();
- final CTSchemeColor phClr = style == null ? null : style.getFontRef().getSchemeClr();
-
- CharacterPropertyFetcher<Color> fetcher = new CharacterPropertyFetcher<Color>(_p.getLevel()){
- public boolean fetch(CTTextCharacterProperties props){
- CTSolidColorFillProperties solidFill = props.getSolidFill();
- if(solidFill != null) {
- boolean useCtxColor =
- (solidFill.isSetSchemeClr() && solidFill.getSchemeClr().getVal() == STSchemeColorVal.PH_CLR)
- || isFetchingFromMaster;
- Color c = new XSLFColor(solidFill, theme, useCtxColor ? phClr : null).getColor();
- setValue(c);
- return true;
- }
- return false;
- }
- };
- fetchCharacterProperty(fetcher);
- return fetcher.getValue();
- }
-
- /**
- *
- * @param fontSize font size in points.
- * The value of <code>-1</code> unsets the Sz attribyte from the underlying xml bean
- */
- public void setFontSize(double fontSize){
- CTTextCharacterProperties rPr = getRpR();
- if(fontSize == -1.0) {
- if(rPr.isSetSz()) rPr.unsetSz();
- } else {
- rPr.setSz((int)(100*fontSize));
- }
- }
-
- /**
- * @return font size in points or -1 if font size is not set.
- */
- 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.getLevel()){
- public boolean fetch(CTTextCharacterProperties props){
- if(props.isSetSz()){
- setValue(props.getSz()*0.01);
- return true;
- }
- return false;
- }
- };
- fetchCharacterProperty(fetcher);
- return fetcher.getValue() == null ? -1 : 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.getLevel()){
- public boolean fetch(CTTextCharacterProperties props){
- if(props.isSetSpc()){
- setValue(props.getSpc()*0.01);
- return true;
- }
- return false;
- }
- };
- fetchCharacterProperty(fetcher);
- return fetcher.getValue() == null ? 0 : fetcher.getValue();
- }
-
- /**
- * Specifies the typeface, or name of the font that is to be used for this text run.
- *
- * @param typeface the font to apply to this text run.
- * The value of <code>null</code> unsets the Typeface attrubute from the underlying xml.
- */
- 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();
-
- 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);
- }
- }
- }
-
- /**
- * @return font family or null if not set
- */
- public String getFontFamily(){
- final XSLFTheme theme = _p.getParentShape().getSheet().getTheme();
-
- CharacterPropertyFetcher<String> visitor = new CharacterPropertyFetcher<String>(_p.getLevel()){
- public boolean fetch(CTTextCharacterProperties props){
- 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();
- }
-
- public byte getPitchAndFamily(){
- final XSLFTheme theme = _p.getParentShape().getSheet().getTheme();
-
- CharacterPropertyFetcher<Byte> visitor = new CharacterPropertyFetcher<Byte>(_p.getLevel()){
- public boolean fetch(CTTextCharacterProperties props){
- CTTextFont font = props.getLatin();
- if(font != null){
- setValue(font.getPitchFamily());
- return true;
- }
- return false;
- }
- };
- fetchCharacterProperty(visitor);
-
- return visitor.getValue() == null ? 0 : visitor.getValue();
- }
-
- /**
- * Specifies whether a run of text will be formatted as strikethrough text.
- *
- * @param strike whether a run of text will be formatted as strikethrough text.
- */
- public void setStrikethrough(boolean strike){
- getRpR().setStrike(strike ? STTextStrikeType.SNG_STRIKE : STTextStrikeType.NO_STRIKE);
- }
-
- /**
- * @return whether a run of text will be formatted as strikethrough text. Default is false.
- */
- public boolean isStrikethrough() {
- CharacterPropertyFetcher<Boolean> fetcher = new CharacterPropertyFetcher<Boolean>(_p.getLevel()){
- public boolean fetch(CTTextCharacterProperties props){
- if(props.isSetStrike()){
- setValue(props.getStrike() != STTextStrikeType.NO_STRIKE);
- 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.
- */
- public boolean isSuperscript() {
- CharacterPropertyFetcher<Boolean> fetcher = new CharacterPropertyFetcher<Boolean>(_p.getLevel()){
- public boolean fetch(CTTextCharacterProperties props){
- if(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.
- */
- public boolean isSubscript() {
- CharacterPropertyFetcher<Boolean> fetcher = new CharacterPropertyFetcher<Boolean>(_p.getLevel()){
- public boolean fetch(CTTextCharacterProperties props){
- if(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.
- */
- public TextCap getTextCap() {
- CharacterPropertyFetcher<TextCap> fetcher = new CharacterPropertyFetcher<TextCap>(_p.getLevel()){
- public boolean fetch(CTTextCharacterProperties props){
- if(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();
- }
-
- /**
- * 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){
- getRpR().setB(bold);
- }
-
- /**
- * @return whether this run of text is formatted as bold text
- */
- public boolean isBold(){
- CharacterPropertyFetcher<Boolean> fetcher = new CharacterPropertyFetcher<Boolean>(_p.getLevel()){
- public boolean fetch(CTTextCharacterProperties props){
- if(props.isSetB()){
- setValue(props.getB());
- return true;
- }
- return false;
- }
- };
- fetchCharacterProperty(fetcher);
- return fetcher.getValue() == null ? false : fetcher.getValue();
- }
-
- /**
- * @param italic whether this run of text is formatted as italic text
- */
- public void setItalic(boolean italic){
- getRpR().setI(italic);
- }
-
- /**
- * @return whether this run of text is formatted as italic text
- */
- public boolean isItalic(){
- CharacterPropertyFetcher<Boolean> fetcher = new CharacterPropertyFetcher<Boolean>(_p.getLevel()){
- public boolean fetch(CTTextCharacterProperties props){
- if(props.isSetI()){
- setValue(props.getI());
- return true;
- }
- return false;
- }
- };
- fetchCharacterProperty(fetcher);
- return fetcher.getValue() == null ? false : fetcher.getValue();
- }
-
- /**
- * @param underline whether this run of text is formatted as underlined text
- */
- public void setUnderline(boolean underline){
- getRpR().setU(underline ? STTextUnderlineType.SNG : STTextUnderlineType.NONE);
- }
-
- /**
- * @return whether this run of text is formatted as underlined text
- */
- public boolean isUnderline(){
- CharacterPropertyFetcher<Boolean> fetcher = new CharacterPropertyFetcher<Boolean>(_p.getLevel()){
- public boolean fetch(CTTextCharacterProperties props){
- if(props.isSetU()){
- setValue(props.getU() != STTextUnderlineType.NONE);
- return true;
- }
- return false;
- }
- };
- fetchCharacterProperty(fetcher);
- return fetcher.getValue() == null ? false : fetcher.getValue();
- }
-
- protected CTTextCharacterProperties getRpR(){
- return _r.isSetRPr() ? _r.getRPr() : _r.addNewRPr();
- }
-
- @Override
- public String toString(){
- return "[" + getClass() + "]" + getText();
- }
-
- public XSLFHyperlink createHyperlink(){
- XSLFHyperlink link = new XSLFHyperlink(_r.getRPr().addNewHlinkClick(), this);
- return link;
- }
-
- public XSLFHyperlink getHyperlink(){
- if(!_r.getRPr().isSetHlinkClick()) return null;
-
-
- return new XSLFHyperlink(_r.getRPr().getHlinkClick(), this);
- }
-
- private boolean fetchCharacterProperty(CharacterPropertyFetcher fetcher){
- boolean ok = false;
-
- if(_r.isSetRPr()) ok = fetcher.fetch(_r.getRPr());
-
- if(!ok) {
- XSLFTextShape shape = _p.getParentShape();
- ok = shape.fetchShapeProperty(fetcher);
- if(!ok){
- CTPlaceholder ph = shape.getCTPlaceholder();
- if(ph == null){
- // if it is a plain text box then take defaults from presentation.xml
- XMLSlideShow ppt = shape.getSheet().getSlideShow();
- CTTextParagraphProperties themeProps = ppt.getDefaultParagraphStyle(_p.getLevel());
- if(themeProps != null) {
- fetcher.isFetchingFromMaster = true;
- ok = fetcher.fetch(themeProps);
- }
- } else {
- // defaults for placeholders are defined in the slide master
- CTTextParagraphProperties defaultProps = _p.getDefaultMasterStyle();
- if(defaultProps != null) {
- fetcher.isFetchingFromMaster = true;
- ok = fetcher.fetch(defaultProps);
- }
- }
- }
- }
-
- return ok;
- }
-
- void copy(XSLFTextRun r){
- String srcFontFamily = r.getFontFamily();
- if(srcFontFamily != null && !srcFontFamily.equals(getFontFamily())){
- setFontFamily(srcFontFamily);
- }
-
- Color 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.isUnderline();
- if(underline != isUnderline()) setUnderline(underline);
-
- boolean strike = r.isStrikethrough();
- if(strike != isStrikethrough()) setStrikethrough(strike);
- }
- }
|