1    
2    /* ====================================================================
3     * The Apache Software License, Version 1.1
4     *
5     * Copyright (c) 2002 The Apache Software Foundation.  All rights
6     * reserved.
7     *
8     * Redistribution and use in source and binary forms, with or without
9     * modification, are permitted provided that the following conditions
10    * are met:
11    *
12    * 1. Redistributions of source code must retain the above copyright
13    *    notice, this list of conditions and the following disclaimer.
14    *
15    * 2. Redistributions in binary form must reproduce the above copyright
16    *    notice, this list of conditions and the following disclaimer in
17    *    the documentation and/or other materials provided with the
18    *    distribution.
19    *
20    * 3. The end-user documentation included with the redistribution,
21    *    if any, must include the following acknowledgment:
22    *       "This product includes software developed by the
23    *        Apache Software Foundation (http://www.apache.org/)."
24    *    Alternately, this acknowledgment may appear in the software itself,
25    *    if and wherever such third-party acknowledgments normally appear.
26    *
27    * 4. The names "Apache" and "Apache Software Foundation" and
28    *    "Apache POI" must not be used to endorse or promote products
29    *    derived from this software without prior written permission. For
30    *    written permission, please contact apache@apache.org.
31    *
32    * 5. Products derived from this software may not be called "Apache",
33    *    "Apache POI", nor may "Apache" appear in their name, without
34    *    prior written permission of the Apache Software Foundation.
35    *
36    * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37    * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38    * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39    * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40    * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41    * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42    * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43    * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44    * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45    * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46    * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47    * SUCH DAMAGE.
48    * ====================================================================
49    *
50    * This software consists of voluntary contributions made by many
51    * individuals on behalf of the Apache Software Foundation.  For more
52    * information on the Apache Software Foundation, please see
53    * <http://www.apache.org/>.
54    */
55   
56   package org.apache.poi.hssf.record;
57   
58   import org.apache.poi.util.LittleEndian;
59   import org.apache.poi.util.BitField;
60   
61   /**
62    * Class ChartFormatRecord
63    *
64    *
65    * @author Glen Stampoultzis (glens at apache.org)
66    * @version %I%, %G%
67    */
68   
69   public class ChartFormatRecord
70       extends Record
71   {
72       public static final short sid = 0x1014;
73   
74       // ignored?
75       private int               field1_x_position;   // lower left
76       private int               field2_y_position;   // lower left
77       private int               field3_width;
78       private int               field4_height;
79       private short             field5_grbit;
80       private BitField          varyDisplayPattern = new BitField(0x01);
81   
82       public ChartFormatRecord()
83       {
84       }
85   
86       /**
87        * Constructs a ChartFormatRecord record and sets its fields appropriately.
88        *
89        * @param id    id must equal the sid or an exception will be throw upon validation
90        * @param size  the size of the data area of the record
91        * @param data  data of the record (should not contain sid/len)
92        */
93   
94       public ChartFormatRecord(short id, short size, byte [] data)
95       {
96           super(id, size, data);
97       }
98   
99       /**
100       * Constructs a ChartFormatRecord record and sets its fields appropriately.
101       *
102       * @param id    id must equal the sid or an exception will be throw upon validation
103       * @param size  the size of the data area of the record
104       * @param data  data of the record (should not contain sid/len)
105       * @param offset of the record's data
106       */
107  
108      public ChartFormatRecord(short id, short size, byte [] data, int offset)
109      {
110          super(id, size, data, offset);
111      }
112  
113      protected void validateSid(short id)
114      {
115          if (id != sid)
116          {
117              throw new RecordFormatException("NOT A CHARTFORMAT RECORD");
118          }
119      }
120  
121      protected void fillFields(byte [] data, short size, int offset)
122      {
123          field1_x_position = LittleEndian.getInt(data, 0 + offset);
124          field2_y_position = LittleEndian.getInt(data, 4 + offset);
125          field3_width      = LittleEndian.getInt(data, 8 + offset);
126          field4_height     = LittleEndian.getInt(data, 12 + offset);
127          field5_grbit      = LittleEndian.getShort(data, 16 + offset);
128      }
129  
130      public String toString()
131      {
132          StringBuffer buffer = new StringBuffer();
133  
134          buffer.append("[CHARTFORMAT]\n");
135          buffer.append("    .xPosition       = ").append(getXPosition())
136              .append("\n");
137          buffer.append("    .yPosition       = ").append(getYPosition())
138              .append("\n");
139          buffer.append("    .width           = ").append(getWidth())
140              .append("\n");
141          buffer.append("    .height          = ").append(getHeight())
142              .append("\n");
143          buffer.append("    .grBit           = ")
144              .append(Integer.toHexString(field5_grbit)).append("\n");
145          buffer.append("[/CHARTFORMAT]\n");
146          return buffer.toString();
147      }
148  
149      public int serialize(int offset, byte [] data)
150      {
151          LittleEndian.putShort(data, 0 + offset, sid);
152          LittleEndian.putShort(data, 2 + offset,
153                                (( short ) 22));   // 22 byte length
154          LittleEndian.putInt(data, 4 + offset, getXPosition());
155          LittleEndian.putInt(data, 8 + offset, getYPosition());
156          LittleEndian.putInt(data, 12 + offset, getWidth());
157          LittleEndian.putInt(data, 16 + offset, getHeight());
158          LittleEndian.putShort(data, 20 + offset, field5_grbit);
159          return getRecordSize();
160      }
161  
162      public int getRecordSize()
163      {
164          return 22;
165      }
166  
167      public short getSid()
168      {
169          return this.sid;
170      }
171  
172      public int getXPosition()
173      {
174          return field1_x_position;
175      }
176  
177      public void setXPosition(int xPosition)
178      {
179          this.field1_x_position = xPosition;
180      }
181  
182      public int getYPosition()
183      {
184          return field2_y_position;
185      }
186  
187      public void setYPosition(int yPosition)
188      {
189          this.field2_y_position = yPosition;
190      }
191  
192      public int getWidth()
193      {
194          return field3_width;
195      }
196  
197      public void setWidth(int width)
198      {
199          this.field3_width = width;
200      }
201  
202      public int getHeight()
203      {
204          return field4_height;
205      }
206  
207      public void setHeight(int height)
208      {
209          this.field4_height = height;
210      }
211  
212      public boolean getVaryDisplayPattern()
213      {
214          return varyDisplayPattern.isSet(field5_grbit);
215      }
216  
217      public void setVaryDisplayPattern(boolean value)
218      {
219          field5_grbit = varyDisplayPattern.setShortBoolean(field5_grbit,
220                  value);
221      }
222  }
223