From: Nick Burch Date: Sun, 21 Feb 2016 21:17:23 +0000 (+0000) Subject: Patch from Jim King from bug #57989 - XSSFChart support for setting chart titles... X-Git-Tag: REL_3_14_FINAL~21 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=b1d13db902da75c16b52e98ace2a49b9b5367c2f;p=poi.git Patch from Jim King from bug #57989 - XSSFChart support for setting chart titles, plus get+set unit tests git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1731566 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFChart.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFChart.java index 27f1e996ec..f6d6834615 100644 --- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFChart.java +++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFChart.java @@ -51,8 +51,13 @@ import org.openxmlformats.schemas.drawingml.x2006.chart.CTPageMargins; import org.openxmlformats.schemas.drawingml.x2006.chart.CTPlotArea; import org.openxmlformats.schemas.drawingml.x2006.chart.CTPrintSettings; import org.openxmlformats.schemas.drawingml.x2006.chart.CTTitle; +import org.openxmlformats.schemas.drawingml.x2006.chart.CTTx; import org.openxmlformats.schemas.drawingml.x2006.chart.CTValAx; import org.openxmlformats.schemas.drawingml.x2006.chart.ChartSpaceDocument; +import org.openxmlformats.schemas.drawingml.x2006.main.CTRegularTextRun; +import org.openxmlformats.schemas.drawingml.x2006.main.CTTextBody; +import org.openxmlformats.schemas.drawingml.x2006.main.CTTextField; +import org.openxmlformats.schemas.drawingml.x2006.main.CTTextParagraph; import org.w3c.dom.NodeList; import org.w3c.dom.Text; @@ -282,6 +287,55 @@ public final class XSSFChart extends POIXMLDocumentPart implements Chart, ChartA return new XSSFRichTextString(text.toString()); } + /** + * Sets the title text. + */ + public void setTitle(String newTitle) { + CTTitle ctTitle; + if (chart.isSetTitle()) { + ctTitle = chart.getTitle(); + } else { + ctTitle = chart.addNewTitle(); + } + + CTTx tx; + if (ctTitle.isSetTx()) { + tx = ctTitle.getTx(); + } else { + tx = ctTitle.addNewTx(); + } + + if (tx.isSetStrRef()) { + tx.unsetStrRef(); + } + + CTTextBody rich; + if (tx.isSetRich()) { + rich = tx.getRich(); + } else { + rich = tx.addNewRich(); + rich.addNewBodyPr(); // body properties must exist (but can be empty) + } + + CTTextParagraph para; + if (rich.sizeOfPArray() > 0) { + para = rich.getPArray(0); + } else { + para = rich.addNewP(); + } + + if (para.sizeOfRArray() > 0) { + CTRegularTextRun run = para.getRArray(0); + run.setT(newTitle); + } else if (para.sizeOfFldArray() > 0) { + CTTextField fld = para.getFldArray(0); + fld.setT(newTitle); + } else { + CTRegularTextRun run = para.addNewR(); + run.setT(newTitle); + } + } + public XSSFChartLegend getOrCreateLegend() { return new XSSFChartLegend(this); } diff --git a/src/ooxml/testcases/org/apache/poi/xssf/usermodel/charts/TestXSSFChartTitle.java b/src/ooxml/testcases/org/apache/poi/xssf/usermodel/charts/TestXSSFChartTitle.java new file mode 100644 index 0000000000..de05749300 --- /dev/null +++ b/src/ooxml/testcases/org/apache/poi/xssf/usermodel/charts/TestXSSFChartTitle.java @@ -0,0 +1,132 @@ +/* ==================================================================== + 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.xssf.usermodel.charts; + +import junit.framework.TestCase; +import org.apache.poi.ss.usermodel.*; +import org.apache.poi.ss.usermodel.charts.*; +import org.apache.poi.ss.util.CellRangeAddress; +import org.apache.poi.xssf.XSSFTestDataSamples; +import org.apache.poi.xssf.usermodel.*; + +import java.util.List; + +/** + * Test get/set chart title. + */ +public class TestXSSFChartTitle extends TestCase { + private Workbook createWorkbookWithChart() { + Workbook wb = new XSSFWorkbook(); + Sheet sheet = wb.createSheet("linechart"); + final int NUM_OF_ROWS = 3; + final int NUM_OF_COLUMNS = 10; + + // Create a row and put some cells in it. Rows are 0 based. + Row row; + Cell cell; + for (int rowIndex = 0; rowIndex < NUM_OF_ROWS; rowIndex++) { + row = sheet.createRow((short) rowIndex); + for (int colIndex = 0; colIndex < NUM_OF_COLUMNS; colIndex++) { + cell = row.createCell((short) colIndex); + cell.setCellValue(colIndex * (rowIndex + 1)); + } + } + + Drawing drawing = sheet.createDrawingPatriarch(); + ClientAnchor anchor = drawing.createAnchor(0, 0, 0, 0, 0, 5, 10, 15); + + Chart chart = drawing.createChart(anchor); + ChartLegend legend = chart.getOrCreateLegend(); + legend.setPosition(LegendPosition.TOP_RIGHT); + + LineChartData data = chart.getChartDataFactory().createLineChartData(); + + // Use a category axis for the bottom axis. + ChartAxis bottomAxis = chart.getChartAxisFactory().createCategoryAxis(AxisPosition.BOTTOM); + ValueAxis leftAxis = chart.getChartAxisFactory().createValueAxis(AxisPosition.LEFT); + leftAxis.setCrosses(AxisCrosses.AUTO_ZERO); + + ChartDataSource xs = DataSources.fromNumericCellRange(sheet, new CellRangeAddress(0, 0, 0, NUM_OF_COLUMNS - 1)); + ChartDataSource ys1 = DataSources.fromNumericCellRange(sheet, new CellRangeAddress(1, 1, 0, NUM_OF_COLUMNS - 1)); + ChartDataSource ys2 = DataSources.fromNumericCellRange(sheet, new CellRangeAddress(2, 2, 0, NUM_OF_COLUMNS - 1)); + + data.addSeries(xs, ys1); + data.addSeries(xs, ys2); + + chart.plot(data, bottomAxis, leftAxis); + + return wb; + } + + /** + * Gets the first chart from the named sheet in the workbook. + */ + private XSSFChart getChartFromWorkbook(Workbook wb, String sheetName) { + Sheet sheet = wb.getSheet(sheetName); + if (sheet instanceof XSSFSheet) { + XSSFSheet xsheet = (XSSFSheet) sheet; + XSSFDrawing drawing = xsheet.getDrawingPatriarch(); + if (drawing != null) { + List charts = drawing.getCharts(); + if (charts != null && charts.size() > 0) { + return charts.get(0); + } + } + } + return null; + } + + public void testNewChart() { + Workbook wb = createWorkbookWithChart(); + XSSFChart chart = getChartFromWorkbook(wb, "linechart"); + assertNotNull(chart); + assertNull(chart.getTitle()); + final String myTitle = "My chart title"; + chart.setTitle(myTitle); + XSSFRichTextString queryTitle = chart.getTitle(); + assertNotNull(queryTitle); + assertEquals(myTitle, queryTitle.toString()); + } + + public void testExistingChartWithTitle() { + Workbook wb = XSSFTestDataSamples.openSampleWorkbook("chartTitle_withTitle.xlsx"); + XSSFChart chart = getChartFromWorkbook(wb, "Sheet1"); + assertNotNull(chart); + XSSFRichTextString originalTitle = chart.getTitle(); + assertNotNull(originalTitle); + final String myTitle = "My chart title"; + assertFalse(myTitle.equals(originalTitle.toString())); + chart.setTitle(myTitle); + XSSFRichTextString queryTitle = chart.getTitle(); + assertNotNull(queryTitle); + assertEquals(myTitle, queryTitle.toString()); + } + + public void testExistingChartNoTitle() { + Workbook wb = XSSFTestDataSamples.openSampleWorkbook("chartTitle_noTitle.xlsx"); + XSSFChart chart = getChartFromWorkbook(wb, "Sheet1"); + assertNotNull(chart); + assertNull(chart.getTitle()); + final String myTitle = "My chart title"; + chart.setTitle(myTitle); + XSSFRichTextString queryTitle = chart.getTitle(); + assertNotNull(queryTitle); + assertEquals(myTitle, queryTitle.toString()); + } + +} diff --git a/test-data/spreadsheet/chartTitle_noTitle.xlsx b/test-data/spreadsheet/chartTitle_noTitle.xlsx new file mode 100644 index 0000000000..48daae4ee5 Binary files /dev/null and b/test-data/spreadsheet/chartTitle_noTitle.xlsx differ diff --git a/test-data/spreadsheet/chartTitle_withTitle.xlsx b/test-data/spreadsheet/chartTitle_withTitle.xlsx new file mode 100644 index 0000000000..680579d00a Binary files /dev/null and b/test-data/spreadsheet/chartTitle_withTitle.xlsx differ