2011-08-11 04:38:19 -04:00
|
|
|
/* ====================================================================
|
|
|
|
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;
|
2011-10-21 09:17:33 -04:00
|
|
|
import org.apache.poi.xslf.model.CharacterPropertyFetcher;
|
2011-08-11 04:38:19 -04:00
|
|
|
import org.openxmlformats.schemas.drawingml.x2006.main.CTRegularTextRun;
|
|
|
|
import org.openxmlformats.schemas.drawingml.x2006.main.CTSRgbColor;
|
2011-11-07 04:12:16 -05:00
|
|
|
import org.openxmlformats.schemas.drawingml.x2006.main.CTSchemeColor;
|
|
|
|
import org.openxmlformats.schemas.drawingml.x2006.main.CTShapeStyle;
|
2011-08-11 04:38:19 -04:00
|
|
|
import org.openxmlformats.schemas.drawingml.x2006.main.CTSolidColorFillProperties;
|
|
|
|
import org.openxmlformats.schemas.drawingml.x2006.main.CTTextCharacterProperties;
|
|
|
|
import org.openxmlformats.schemas.drawingml.x2006.main.CTTextFont;
|
2011-11-07 04:12:16 -05:00
|
|
|
import org.openxmlformats.schemas.drawingml.x2006.main.CTTextNormalAutofit;
|
2011-10-28 10:25:53 -04:00
|
|
|
import org.openxmlformats.schemas.drawingml.x2006.main.CTTextParagraphProperties;
|
2011-08-11 04:38:19 -04:00
|
|
|
import org.openxmlformats.schemas.drawingml.x2006.main.STTextStrikeType;
|
|
|
|
import org.openxmlformats.schemas.drawingml.x2006.main.STTextUnderlineType;
|
|
|
|
|
2011-11-07 04:12:16 -05:00
|
|
|
import java.awt.Color;
|
2011-08-11 04:38:19 -04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* 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;
|
2011-08-17 06:18:31 -04:00
|
|
|
private final XSLFTextParagraph _p;
|
2011-08-11 04:38:19 -04:00
|
|
|
|
2011-08-17 06:18:31 -04:00
|
|
|
XSLFTextRun(CTRegularTextRun r, XSLFTextParagraph p){
|
2011-08-11 04:38:19 -04:00
|
|
|
_r = r;
|
2011-08-17 06:18:31 -04:00
|
|
|
_p = p;
|
|
|
|
}
|
|
|
|
|
|
|
|
XSLFTextParagraph getParentParagraph(){
|
|
|
|
return _p;
|
2011-08-11 04:38:19 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
public String getText(){
|
|
|
|
return _r.getT();
|
|
|
|
}
|
|
|
|
|
|
|
|
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()});
|
|
|
|
}
|
|
|
|
|
2011-10-21 09:17:33 -04:00
|
|
|
public Color getFontColor(){
|
|
|
|
final XSLFTheme theme = _p.getParentShape().getSheet().getTheme();
|
2011-11-07 04:12:16 -05:00
|
|
|
CTShapeStyle style = _p.getParentShape().getSpStyle();
|
|
|
|
final CTSchemeColor shapeStyle = style == null ? null : style.getFontRef().getSchemeClr();
|
2011-10-21 09:17:33 -04:00
|
|
|
|
|
|
|
CharacterPropertyFetcher<Color> fetcher = new CharacterPropertyFetcher<Color>(_p.getLevel()){
|
|
|
|
public boolean fetch(CTTextCharacterProperties props){
|
|
|
|
CTSolidColorFillProperties solidFill = props.getSolidFill();
|
2011-11-07 04:12:16 -05:00
|
|
|
if(solidFill != null) {
|
|
|
|
Color c = new XSLFColor(solidFill, theme, shapeStyle).getColor();
|
2011-10-28 10:25:53 -04:00
|
|
|
setValue(c);
|
2011-10-21 09:17:33 -04:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
fetchCharacterProperty(fetcher);
|
|
|
|
return fetcher.getValue();
|
|
|
|
}
|
|
|
|
|
2011-08-11 04:38:19 -04:00
|
|
|
/**
|
|
|
|
*
|
|
|
|
* @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(){
|
2011-11-07 04:12:16 -05:00
|
|
|
double scale = 1;
|
|
|
|
CTTextNormalAutofit afit = getParentParagraph().getParentShape().getTextBodyPr().getNormAutofit();
|
|
|
|
if(afit != null) scale = (double)afit.getFontScale() / 100000;
|
|
|
|
|
2011-10-21 09:17:33 -04:00
|
|
|
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);
|
2011-11-07 04:12:16 -05:00
|
|
|
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();
|
2011-08-11 04:38:19 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2011-10-21 09:17:33 -04:00
|
|
|
* @return font family or null if not set
|
2011-08-11 04:38:19 -04:00
|
|
|
*/
|
|
|
|
public String getFontFamily(){
|
2011-10-21 09:17:33 -04:00
|
|
|
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);
|
2011-08-11 04:38:19 -04:00
|
|
|
|
2011-10-21 09:17:33 -04:00
|
|
|
return visitor.getValue();
|
2011-08-11 04:38:19 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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.
|
|
|
|
*/
|
2011-10-21 09:17:33 -04:00
|
|
|
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();
|
2011-08-11 04:38:19 -04:00
|
|
|
}
|
|
|
|
|
2011-10-28 10:25:53 -04:00
|
|
|
/**
|
|
|
|
* @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();
|
|
|
|
}
|
|
|
|
|
2011-11-07 04:12:16 -05:00
|
|
|
/**
|
|
|
|
* @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();
|
|
|
|
}
|
|
|
|
|
2011-08-11 04:38:19 -04:00
|
|
|
/**
|
|
|
|
* 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(){
|
2011-10-21 09:17:33 -04:00
|
|
|
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();
|
2011-08-11 04:38:19 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @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(){
|
2011-10-21 09:17:33 -04:00
|
|
|
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();
|
2011-08-11 04:38:19 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @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(){
|
2011-10-21 09:17:33 -04:00
|
|
|
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();
|
2011-08-11 04:38:19 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
protected CTTextCharacterProperties getRpR(){
|
|
|
|
return _r.isSetRPr() ? _r.getRPr() : _r.addNewRPr();
|
|
|
|
}
|
|
|
|
|
|
|
|
@Override
|
|
|
|
public String toString(){
|
|
|
|
return "[" + getClass() + "]" + getText();
|
|
|
|
}
|
2011-08-17 06:18:31 -04:00
|
|
|
|
|
|
|
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);
|
|
|
|
}
|
2011-10-21 09:17:33 -04:00
|
|
|
|
|
|
|
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) {
|
|
|
|
CTTextParagraphProperties defaultProps = _p.getDefaultStyle();
|
|
|
|
if(defaultProps != null) ok = fetcher.fetch(defaultProps);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return ok;
|
|
|
|
}
|
|
|
|
|
2011-10-28 10:25:53 -04:00
|
|
|
}
|