From 2038b4ba5b11ef9bb3e78301b6838b410ad89bc4 Mon Sep 17 00:00:00 2001
From: Nick Burch <nick@apache.org>
Date: Mon, 12 Nov 2007 21:49:37 +0000
Subject: [PATCH] Add support for Chart Title Format records (bug #43721)

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@594307 13f79535-47bb-0310-9956-ffa450edef68
---
 src/documentation/content/xdocs/changes.xml   |   1 +
 src/documentation/content/xdocs/status.xml    |   1 +
 .../hssf/record/ChartTitleFormatRecord.java   | 146 ++++++++++++++++++
 .../apache/poi/hssf/record/RecordFactory.java |   3 +-
 .../poi/hssf/data/WithFormattedGraphTitle.xls | Bin 0 -> 14336 bytes
 .../record/TestChartTitleFormatRecord.java    |  87 +++++++++++
 6 files changed, 237 insertions(+), 1 deletion(-)
 create mode 100644 src/java/org/apache/poi/hssf/record/ChartTitleFormatRecord.java
 create mode 100644 src/testcases/org/apache/poi/hssf/data/WithFormattedGraphTitle.xls
 create mode 100644 src/testcases/org/apache/poi/hssf/record/TestChartTitleFormatRecord.java

diff --git a/src/documentation/content/xdocs/changes.xml b/src/documentation/content/xdocs/changes.xml
index f88c1582f..ca6a47525 100644
--- a/src/documentation/content/xdocs/changes.xml
+++ b/src/documentation/content/xdocs/changes.xml
@@ -36,6 +36,7 @@
 
 		<!-- Don't forget to update status.xml too! -->
         <release version="3.0.2-FINAL" date="2007-??-??">
+            <action dev="POI-DEVELOPERS" type="add">43721 - [PATCH] Support for Chart Title Format records</action>
             <action dev="POI-DEVELOPERS" type="fix">42794 - [PATCH] Fix for BOF records from things like Access</action>
             <action dev="POI-DEVELOPERS" type="fix">43648 - Fix for IntPtg and short vs int</action>
             <action dev="POI-DEVELOPERS" type="fix">43751 - [PATCH] - Fix for handling rotated text in HSSFSheet.autoSizeColumn</action>
diff --git a/src/documentation/content/xdocs/status.xml b/src/documentation/content/xdocs/status.xml
index 1dc3b60bc..2b561f554 100644
--- a/src/documentation/content/xdocs/status.xml
+++ b/src/documentation/content/xdocs/status.xml
@@ -33,6 +33,7 @@
 	<!-- Don't forget to update changes.xml too! -->
     <changes>
         <release version="3.0.2-FINAL" date="2007-??-??">
+            <action dev="POI-DEVELOPERS" type="add">43721 - [PATCH] Support for Chart Title Format records</action>
             <action dev="POI-DEVELOPERS" type="fix">42794 - [PATCH] Fix for BOF records from things like Access</action>
             <action dev="POI-DEVELOPERS" type="fix">43648 - Fix for IntPtg and short vs int</action>
             <action dev="POI-DEVELOPERS" type="fix">43751 - [PATCH] - Fix for handling rotated text in HSSFSheet.autoSizeColumn</action>
diff --git a/src/java/org/apache/poi/hssf/record/ChartTitleFormatRecord.java b/src/java/org/apache/poi/hssf/record/ChartTitleFormatRecord.java
new file mode 100644
index 000000000..a9ec81e97
--- /dev/null
+++ b/src/java/org/apache/poi/hssf/record/ChartTitleFormatRecord.java
@@ -0,0 +1,146 @@
+/* ====================================================================
+   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.
+==================================================================== */
+
+/*
+ * HSSF Chart Title Format Record Type
+ */
+package org.apache.poi.hssf.record;
+
+import org.apache.poi.util.LittleEndian;
+
+import java.util.ArrayList;
+
+/**
+ * Describes the formatting runs associated with a chart title.
+ */
+public class ChartTitleFormatRecord extends Record {
+	public static final short sid = 0x1050;
+	
+	private int 		m_recs;
+	
+	private class CTFormat {
+		private short m_offset;
+		private short m_fontIndex;
+		
+		protected CTFormat(short offset,short fontIdx){
+			m_offset = offset;
+			m_fontIndex = fontIdx;
+		}
+		
+		public short getOffset(){
+			return m_offset;
+		}
+		public void setOffset(short newOff){
+			m_offset = newOff;
+		}
+		public short getFontIndex() {
+			return m_fontIndex;
+		}
+	}
+	
+	private ArrayList m_formats;
+
+	public ChartTitleFormatRecord() {
+		super();
+	}
+
+	public ChartTitleFormatRecord(RecordInputStream in) {
+		super(in);
+	}
+
+	protected void validateSid(short id) {
+		if (id != sid)
+        {
+            throw new RecordFormatException("NOT A CHARTTITLEFORMAT RECORD");
+        }
+	}
+
+	protected void fillFields(RecordInputStream in) {
+		m_recs = in.readUShort();
+		int idx;
+		CTFormat ctf;
+		if (m_formats == null){
+			m_formats = new ArrayList(m_recs);
+		}
+		for(idx=0;idx<m_recs;idx++) {
+			ctf = new CTFormat(in.readShort(),in.readShort());
+			m_formats.add(ctf);
+		}
+	}
+
+	public int serialize(int offset, byte [] data)
+    {
+        LittleEndian.putShort(data, 0 + offset, sid);
+        LittleEndian.putShort(data, 2 + offset,
+                              ( short ) (getRecordSize() - 4));   
+        int idx;
+        CTFormat ctf;
+        LittleEndian.putShort(data, 4 + offset,(short)m_formats.size());
+        for(idx=0;idx<m_formats.size();idx++){
+        	ctf = (CTFormat)m_formats.get(idx);
+        	LittleEndian.putShort(data, 6 + (idx * 4) + offset, ctf.getOffset());
+        	LittleEndian.putShort(data, 8 + (idx * 4) + offset, ctf.getFontIndex());
+        }
+        
+        return getRecordSize();
+    }
+
+    public int getRecordSize()
+    {
+        return 4 + 2 + (4 * m_formats.size());
+    }
+    
+	public short getSid() {
+		return sid;
+	}
+	
+	public int getFormatCount() {
+		return m_formats.size();
+	}
+	
+	public void modifyFormatRun(short oldPos,short newLen) {
+		short shift = (short)0;
+		for(int idx=0;idx < m_formats.size();idx++) {
+			CTFormat ctf = (CTFormat)m_formats.get(idx);
+			if (shift != 0) {
+				ctf.setOffset((short)(ctf.getOffset() + shift));
+			} else if ((oldPos == ctf.getOffset()) && (idx < (m_formats.size() - 1))){
+				CTFormat nextCTF = (CTFormat)m_formats.get(idx + 1);
+				shift = (short)(newLen - (nextCTF.getOffset() - ctf.getOffset()));
+			} 
+		}
+	}
+	
+	public String toString()
+    {
+        StringBuffer buffer = new StringBuffer();
+
+        buffer.append("[CHARTTITLEFORMAT]\n");
+        buffer.append("    .format_runs       = ").append(m_recs)
+            .append("\n");
+        int idx;
+        CTFormat ctf;
+        for(idx=0;idx<m_formats.size();idx++){
+        	ctf = (CTFormat)m_formats.get(idx);
+        	buffer.append("       .char_offset= ").append(ctf.getOffset());
+        	buffer.append(",.fontidx= ").append(ctf.getFontIndex());
+            buffer.append("\n");
+        }
+        buffer.append("[/CHARTTITLEFORMAT]\n");
+        return buffer.toString();
+    }
+}
diff --git a/src/java/org/apache/poi/hssf/record/RecordFactory.java b/src/java/org/apache/poi/hssf/record/RecordFactory.java
index 8f7821261..398576dc7 100644
--- a/src/java/org/apache/poi/hssf/record/RecordFactory.java
+++ b/src/java/org/apache/poi/hssf/record/RecordFactory.java
@@ -74,7 +74,8 @@ public class RecordFactory
                 PaletteRecord.class, StringRecord.class, RecalcIdRecord.class, SharedFormulaRecord.class,
                 HorizontalPageBreakRecord.class, VerticalPageBreakRecord.class, 
                 WriteProtectRecord.class, FilePassRecord.class, PaneRecord.class,
-                NoteRecord.class, ObjectProtectRecord.class, ScenarioProtectRecord.class, FileSharingRecord.class
+                NoteRecord.class, ObjectProtectRecord.class, ScenarioProtectRecord.class, 
+                FileSharingRecord.class, ChartTitleFormatRecord.class
             };
     }
     private static Map           recordsMap  = recordsToMap(records);
diff --git a/src/testcases/org/apache/poi/hssf/data/WithFormattedGraphTitle.xls b/src/testcases/org/apache/poi/hssf/data/WithFormattedGraphTitle.xls
new file mode 100644
index 0000000000000000000000000000000000000000..477b1f6a154deb87de367cbb00f6418fd385d970
GIT binary patch
literal 14336
zcmeHOU2I&%6+Ux!*S@xs?6u<r5`uHP3B-Rju89h28oW+OgbM~^m*RpW$8m13o1eAT
zo0dGZ*)$;WKqU%DyhLh%O8o%=0YRk-6{n?YctEX?($cCACh7xFBo@@Fpc1y<ckW*A
z-NjDRHj$vZXLaW1oS8Fc&YYRKbMNf$e%m<r=!w;DNEKWsG5NSyCp96uL3(wNcLe-m
zk=Y<#g)~SJe1<GgXJa6167t&GS8HFHMKUJxhFJ1U{3Jq=Gr&=qmIjfbgEKSkQ06W#
zJL6t-*rGa&8|p9%$J>mQkz=4PlU1r&lZMMRd|J!BsNrU5k~x!<J3G(1*P^zd-iVdf
za^KT1rQtG!Mt-Js{-l&Iz`IYOeDUxDbajy(3DYN8nUZnYCl{AnfG)+uFS5HAxZQ#z
zN|MpliXOGZ*MN74NNRm*UFW)W-D7Q=Mq7i-Xj@DCbC~~YD)@H}dAoO17D`F2TwX5J
z)m<qEd5YQ~wxp^{RY@xqy++!lM`Vnuw7Y?3rR->{5=PrLl?bWNr=a&(YkCZ=bV(b2
zs2Z-<?uIM1yA?HhrBl9C*_hvh%Jx*XP?NpA<wn0K9q^8Fqe1=oc7w{=bh+l7H0yBx
zz36J}2eU5ebU>y5EnuCSPRCiO{9<%UU8wy3Gu?>G?v)_0XNPZx531>Hi_kk4p|>wW
zulof3AuBFUK2~Jhn6J^eDIeE(dA?R-$&1F#`9yK2u2J{OrSenVjvX1E^t_z=t*P9k
zyLECro4a4)@E9Xc8I9wYV6yp3n8-<E12OY{VdSrJha^P`L)zJz!lj78*42-m!a783
z0&=x96q*pf1X;Em!AdChtVttGOUrxMHDoE$OMqBG?0<+jAIVkFLlo;ohBNy;_p9FB
zxr9jH^z=Rtyg_d~3)Yr>2fbZhHhZWj^$<RSZb6Vt*eifYlwd_EZmCDY->IC6ovOj|
zXAsMw71>iOl7@h#y0$MtxEuZDI^T#8Dx$HEe)8UH1G@%$$CTc#^bQTbtCT#-1aJjL
z2>XE?0q10#ZBeD8TKXOhALXKk612Y2o+GO;*ISNnLs?tCt(_EEzmhsZvb9W$P;=kr
zwne)#tq)chjHHl8-K%LFqiPzp4b#rTyabFnfH~SC2^9H`#hj(QjcM{?%41vP#Y(&`
z<<YN_p!vLbiPw|<1N!tVs9(muyavB_<d-OC6@CsHtX-fjDUpUm{la5NCna8JMQo(5
z;P)4q5Li;L^=Km6hULG3_`xMUT?YjnI|>i&2K}(aP22>2dNaK7s2M=`l5wEJtfq@_
zb6a|$3bk?6vzb0_YVnLyFKO(9_kq(`Kp;EtB(MU{5ebxN+)2uuZD=$F-xJ*mPh7}1
z2IK`8Y!tu!c!tR0DdH~iklTvX0m%S+0+Hv4P25WSSzfn>-_2tkF!FYN#@>zCm=TNl
z5sTw?6C~&G^U%)!4nbEL(_TToTJqpf|JTlN2re*iUBW1B;E!=x{L55lL7;CEnla|1
zH^yXgD`$fboSW5f<y(*6P_}=V?@J;jkm=WDjx&Z<Ur3@)E9%@0%d2iV%72<Hz?s|M
zzkOQ|Fwl#uy20KNjPr;!Qu4d<s&24DTJVsaPQ6^UCYj{Ik(ke&Lfx8BPVkT%E@@+R
z(V68iv>YdBTHfrPHj+LiSA%pMOCWXF?Qk8XPZ{ZP=+~C=YaMQzgd)!B15yt;ID9IF
z^=<}jBjm(Tj;lmWL+tIK-Ab7yH@($aE?8Uu4YG;CxxiZ}g5y;snNnFZR;pQpbg4m=
zI;Q<$o7?77*F$6OL+e4Y<O;`yP`~=`q3pAP!YFY9`gTJB>UWFNtV&R;FkA^KwH4a4
zHOh`%5ZN`Kki8wUjr2K9P~%A~0?z|~gpKK8bSkWA6FNoS8PLgVMh~ii{brq2j{j!G
zk`(+WfTXNIog^Ntmf}ff8m2!Dc`>tgz8&sJ0Y9kq?=1Sj=1M(-dO;la1llr;VcBn^
z&)8k%*U;%#=*SU_mfNwg>>SGBP$(QNTLztF7#(cM_$9EPS9;%4Ck0B<Y{$O%P3((2
zadRhgWjoRbH8&$0U@=;+tY7f_M9ID@duR>LYb{p_=cDPv%Zq6o-#w5UO9C*d20<8y
z^tg2yY7pwgY(cq$VC({B@jE0Gh-p)LP%BB5jcHPRWqewfQhY%^r6<k0F?IawtR{Iu
z$2%Q}KzunLh~lsab&um`+wbc8wrfBs`$VY5MM!>(#UkNP{R-*q+}yoCc>lv&CY>j~
zZ%fC9=l<9Y+K+*7P3?RdG1sCSfb7L6kaJ`j$aU#HAY54<269A>18Jhapi&EBmI=L7
zT9gKtl!2*<Y-T32C+BXvd&1i%Y0&atZ~5T;v%fK#E_~&=e<JPs0+<m*7KkhmSs=1N
zWP!*6kp&_PL>7oF5LqCyKxBc)0`nF)*ZJQ%{p#ssU6(lzJ%aOp=Z8=6{QnLRAMo`2
zKZuy`az=po1}OIcaZg0<2lC7wocoU<y%P9CAm0Z(3FO)T6=3*%z<T5d@i}w9m&;B~
z%yhc_2PV33)1=S6?Z8yd&Fpde2Zp=+xAHHqZP2z*Wzo0=O7J~KBe435sVo7Ljq^nW
zmA*Zb-8;k2sx$hgD*SQ>+z28IL>7oF5LqCyKxBc)0+9tG3q%%(ED%{BvcPBB0zBvP
z7|ieH_$-eb6Zj7Zkl*<EO`rem;avnCk$Gn4`JJ~`dG6;KpL~Av=l6ZycH#Y4p7r@Y
zfVcR_KMQ0W!KcpxL%45~!EGB?w&6Z%PA|P+*v=bP;`T_;EBcXZGZdNC5EpntuygFh
z$i~&D41FOW->&z4_TtJ7_1GJb&pXB~y7~60$N5$~#+O2Xgbd@#&wl)P8|aYq!wP#;
zCsJ~_d&GOXi$g2g=N#hvIp6mA{!AwiqJ&(J7A8~&Pe<TC)92d%qW{`;PF}#j0JWgx
ASO5S3

literal 0
HcmV?d00001

diff --git a/src/testcases/org/apache/poi/hssf/record/TestChartTitleFormatRecord.java b/src/testcases/org/apache/poi/hssf/record/TestChartTitleFormatRecord.java
new file mode 100644
index 000000000..d9931ef7f
--- /dev/null
+++ b/src/testcases/org/apache/poi/hssf/record/TestChartTitleFormatRecord.java
@@ -0,0 +1,87 @@
+
+/* ====================================================================
+   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.hssf.record;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.InputStream;
+import java.util.ArrayList;
+
+import org.apache.poi.hssf.eventusermodel.HSSFEventFactory;
+import org.apache.poi.hssf.eventusermodel.HSSFListener;
+import org.apache.poi.hssf.eventusermodel.HSSFRequest;
+import org.apache.poi.hssf.usermodel.HSSFSheet;
+import org.apache.poi.hssf.usermodel.HSSFWorkbook;
+import org.apache.poi.poifs.filesystem.POIFSFileSystem;
+
+import junit.framework.TestCase;
+
+public class TestChartTitleFormatRecord extends TestCase
+{
+    private String _test_file_path;
+    private static final String _test_file_path_property = "HSSF.testdata.path";
+
+    public TestChartTitleFormatRecord()
+    {
+        super();
+        _test_file_path = System.getProperty( _test_file_path_property ) +
+        	File.separator + "WithFormattedGraphTitle.xls";
+    }
+
+    public void testRecord() throws Exception {
+    	POIFSFileSystem fs = new POIFSFileSystem(
+    			new FileInputStream(_test_file_path)
+    	);
+    	
+    	// Check we can open the file via usermodel
+    	HSSFWorkbook hssf = new HSSFWorkbook(fs);
+    	
+    	// Now process it through eventusermodel, and
+    	//  look out for the title records
+    	ChartTitleFormatRecordGrabber grabber =
+    		new ChartTitleFormatRecordGrabber();
+    	InputStream din = fs.createDocumentInputStream("Workbook");
+        HSSFRequest req = new HSSFRequest();
+        req.addListenerForAllRecords(grabber);
+        HSSFEventFactory factory = new HSSFEventFactory();
+        factory.processEvents(req, din);
+        din.close();
+        
+        // Should've found one
+        assertEquals(1, grabber.chartTitleFormatRecords.size());
+        // And it should be of something interesting
+        ChartTitleFormatRecord r =
+        	(ChartTitleFormatRecord)grabber.chartTitleFormatRecords.get(0);
+        assertEquals(3, r.getFormatCount());
+    }
+    
+    public static class ChartTitleFormatRecordGrabber implements HSSFListener {
+    	private ArrayList chartTitleFormatRecords = new ArrayList();
+
+		public void processRecord(Record record) {
+			if(record instanceof ChartTitleFormatRecord) {
+				chartTitleFormatRecords.add(
+						record
+				);
+			}
+		}
+    	
+    }
+}