[github-117] Add getStyleWithName() to XWPFStyles. This closes #117

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1836649 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
PJ Fanning 2018-07-25 17:21:58 +00:00
parent 2b3c415909
commit c4290ae2be
5 changed files with 64 additions and 32 deletions

View File

@ -1333,15 +1333,14 @@ public class XWPFParagraph implements IBodyElement, IRunBody, ISDTContents, Para
} }
/** /**
* This method provides a style to the paragraph * Set the style ID for the paragraph
* This is useful when, e.g. an Heading style has to be assigned
* *
* @param newStyle * @param styleId ID (not name) of the style to set for the paragraph, e.g. "Heading1" (not "Heading 1").
*/ */
public void setStyle(String newStyle) { public void setStyle(String styleId) {
CTPPr pr = getCTPPr(); CTPPr pr = getCTPPr();
CTString style = pr.getPStyle() != null ? pr.getPStyle() : pr.addNewPStyle(); CTString style = pr.getPStyle() != null ? pr.getPStyle() : pr.addNewPStyle();
style.setVal(newStyle); style.setVal(styleId);
} }
/** /**

View File

@ -56,33 +56,7 @@ import org.openxmlformats.schemas.drawingml.x2006.picture.CTPicture;
import org.openxmlformats.schemas.drawingml.x2006.picture.CTPictureNonVisual; import org.openxmlformats.schemas.drawingml.x2006.picture.CTPictureNonVisual;
import org.openxmlformats.schemas.drawingml.x2006.wordprocessingDrawing.CTAnchor; import org.openxmlformats.schemas.drawingml.x2006.wordprocessingDrawing.CTAnchor;
import org.openxmlformats.schemas.drawingml.x2006.wordprocessingDrawing.CTInline; import org.openxmlformats.schemas.drawingml.x2006.wordprocessingDrawing.CTInline;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTBr; import org.openxmlformats.schemas.wordprocessingml.x2006.main.*;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTColor;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTDrawing;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTEmpty;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFFCheckBox;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFldChar;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFonts;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdnRef;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTHpsMeasure;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTOnOff;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTPTab;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTR;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTRPr;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTRuby;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTRubyContent;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSignedHpsMeasure;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSignedTwipsMeasure;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTText;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTUnderline;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTVerticalAlignRun;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.STBrClear;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.STBrType;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.STFldCharType;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.STHighlightColor;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.STOnOff;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.STUnderline;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.STVerticalAlignRun;
import org.w3c.dom.NodeList; import org.w3c.dom.NodeList;
import org.w3c.dom.Text; import org.w3c.dom.Text;
import org.xml.sax.InputSource; import org.xml.sax.InputSource;
@ -1121,6 +1095,22 @@ public class XWPFRun implements ISDTContents, IRunElement, CharacterRun {
public List<XWPFPicture> getEmbeddedPictures() { public List<XWPFPicture> getEmbeddedPictures() {
return pictures; return pictures;
} }
/**
* Set the style ID for the run.
*
* @param styleId ID (not name) of the style to set for the run, e.g. "BoldItalic" (not "Bold Italic").
*/
public void setStyle(String styleId) {
CTRPr pr = getCTR().getRPr();
if (null == pr) {
pr = getCTR().addNewRPr();
}
CTString style = pr.getRStyle() != null ? pr.getRStyle() : pr.addNewRStyle();
style.setVal(styleId);
}
/** /**
* Returns the string version of the text and the phonetic string * Returns the string version of the text and the phonetic string

View File

@ -323,4 +323,21 @@ public class XWPFStyles extends POIXMLDocumentPart {
public XWPFLatentStyles getLatentStyles() { public XWPFLatentStyles getLatentStyles() {
return latentStyles; return latentStyles;
} }
/**
* Get the style with the specified name, if any.
*
* @param styleName The name of the style to get, e.g., "Heading 1"
* @return {@link XWPFStyle} with the specified name, or null if not found.
*/
public XWPFStyle getStyleWithName(String styleName) {
XWPFStyle style = null;
for (XWPFStyle cand : listStyle) {
if (styleName.equals(cand.getName())) {
style = cand;
break;
}
}
return style;
}
} }

View File

@ -673,4 +673,18 @@ public class TestXWPFRun {
document.close(); document.close();
} }
@Test
public void testSetStyleId() throws IOException {
XWPFDocument document = XWPFTestDataSamples.openSampleDocument("SampleDoc.docx");
final XWPFRun run = document.createParagraph().createRun();
String styleId = "bolditalic";
run.setStyle(styleId);
String candStyleId = run.getCTR().getRPr().getRStyle().getVal();
assertNotNull("Expected to find a run style ID", candStyleId);
assertEquals(styleId, candStyleId);
}
} }

View File

@ -219,4 +219,16 @@ public final class TestXWPFStyles {
doc.close(); doc.close();
} }
@Test
public void testGetStyleByName() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("SampleDoc.docx");
XWPFStyles styles = doc.getStyles();
assertNotNull(styles);
String styleName = "Normal Table";
XWPFStyle style = styles.getStyleWithName(styleName);
assertNotNull("Expected to find style \"" + styleName + "\"", style);
assertEquals(styleName, style.getName());
}
} }