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   
57   package org.apache.poi.hssf.record;
58   
59   
60   
61   import org.apache.poi.util.*;
62   
63   /**
64    * The axis size and location
65    * NOTE: This source is automatically generated please do not modify this file.  Either subclass or
66    *       remove the record in src/records/definitions.
67   
68    * @author Glen Stampoultzis (glens at apache.org)
69    */
70   public class AxisParentRecord
71       extends Record
72   {
73       public final static short      sid                             = 0x1041;
74       private  short      field_1_axisType;
75       public final static short       AXIS_TYPE_MAIN                 = 0;
76       public final static short       AXIS_TYPE_SECONDARY            = 1;
77       private  int        field_2_x;
78       private  int        field_3_y;
79       private  int        field_4_width;
80       private  int        field_5_height;
81   
82   
83       public AxisParentRecord()
84       {
85   
86       }
87   
88       /**
89        * Constructs a AxisParent record and sets its fields appropriately.
90        *
91        * @param id    id must be 0x1041 or an exception
92        *              will be throw upon validation
93        * @param size  size the size of the data area of the record
94        * @param data  data of the record (should not contain sid/len)
95        */
96   
97       public AxisParentRecord(short id, short size, byte [] data)
98       {
99           super(id, size, data);
100      }
101  
102      /**
103       * Constructs a AxisParent record and sets its fields appropriately.
104       *
105       * @param id    id must be 0x1041 or an exception
106       *              will be throw upon validation
107       * @param size  size the size of the data area of the record
108       * @param data  data of the record (should not contain sid/len)
109       * @param offset of the record's data
110       */
111  
112      public AxisParentRecord(short id, short size, byte [] data, int offset)
113      {
114          super(id, size, data, offset);
115      }
116  
117      /**
118       * Checks the sid matches the expected side for this record
119       *
120       * @param id   the expected sid.
121       */
122      protected void validateSid(short id)
123      {
124          if (id != sid)
125          {
126              throw new RecordFormatException("Not a AxisParent record");
127          }
128      }
129  
130      protected void fillFields(byte [] data, short size, int offset)
131      {
132          field_1_axisType                = LittleEndian.getShort(data, 0x0 + offset);
133          field_2_x                       = LittleEndian.getInt(data, 0x2 + offset);
134          field_3_y                       = LittleEndian.getInt(data, 0x6 + offset);
135          field_4_width                   = LittleEndian.getInt(data, 0xa + offset);
136          field_5_height                  = LittleEndian.getInt(data, 0xe + offset);
137  
138      }
139  
140      public String toString()
141      {
142          StringBuffer buffer = new StringBuffer();
143  
144          buffer.append("[AxisParent]\n");
145  
146          buffer.append("    .axisType             = ")
147              .append("0x")
148              .append(HexDump.toHex((short)getAxisType()))
149              .append(" (").append(getAxisType()).append(" )\n");
150  
151          buffer.append("    .x                    = ")
152              .append("0x")
153              .append(HexDump.toHex((int)getX()))
154              .append(" (").append(getX()).append(" )\n");
155  
156          buffer.append("    .y                    = ")
157              .append("0x")
158              .append(HexDump.toHex((int)getY()))
159              .append(" (").append(getY()).append(" )\n");
160  
161          buffer.append("    .width                = ")
162              .append("0x")
163              .append(HexDump.toHex((int)getWidth()))
164              .append(" (").append(getWidth()).append(" )\n");
165  
166          buffer.append("    .height               = ")
167              .append("0x")
168              .append(HexDump.toHex((int)getHeight()))
169              .append(" (").append(getHeight()).append(" )\n");
170  
171          buffer.append("[/AxisParent]\n");
172          return buffer.toString();
173      }
174  
175      public int serialize(int offset, byte[] data)
176      {
177          LittleEndian.putShort(data, 0 + offset, sid);
178          LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));
179  
180          LittleEndian.putShort(data, 4 + offset, field_1_axisType);
181          LittleEndian.putInt(data, 6 + offset, field_2_x);
182          LittleEndian.putInt(data, 10 + offset, field_3_y);
183          LittleEndian.putInt(data, 14 + offset, field_4_width);
184          LittleEndian.putInt(data, 18 + offset, field_5_height);
185  
186          return getRecordSize();
187      }
188  
189      /**
190       * Size of record (exluding 4 byte header)
191       */
192      public int getRecordSize()
193      {
194          return 4 + 2 + 4 + 4 + 4 + 4;
195      }
196  
197      public short getSid()
198      {
199          return this.sid;
200      }
201  
202      public Object clone() {
203        AxisParentRecord rec = new AxisParentRecord();
204        
205        rec.field_1_axisType = field_1_axisType;
206        rec.field_2_x = field_2_x;
207        rec.field_3_y = field_3_y;
208        rec.field_4_width = field_4_width;
209        rec.field_5_height = field_5_height;
210  
211        return rec;
212      }
213  
214  
215      /**
216       * Get the axis type field for the AxisParent record.
217       *
218       * @return  One of 
219       *        AXIS_TYPE_MAIN
220       *        AXIS_TYPE_SECONDARY
221       */
222      public short getAxisType()
223      {
224          return field_1_axisType;
225      }
226  
227      /**
228       * Set the axis type field for the AxisParent record.
229       *
230       * @param field_1_axisType
231       *        One of 
232       *        AXIS_TYPE_MAIN
233       *        AXIS_TYPE_SECONDARY
234       */
235      public void setAxisType(short field_1_axisType)
236      {
237          this.field_1_axisType = field_1_axisType;
238      }
239  
240      /**
241       * Get the x field for the AxisParent record.
242       */
243      public int getX()
244      {
245          return field_2_x;
246      }
247  
248      /**
249       * Set the x field for the AxisParent record.
250       */
251      public void setX(int field_2_x)
252      {
253          this.field_2_x = field_2_x;
254      }
255  
256      /**
257       * Get the y field for the AxisParent record.
258       */
259      public int getY()
260      {
261          return field_3_y;
262      }
263  
264      /**
265       * Set the y field for the AxisParent record.
266       */
267      public void setY(int field_3_y)
268      {
269          this.field_3_y = field_3_y;
270      }
271  
272      /**
273       * Get the width field for the AxisParent record.
274       */
275      public int getWidth()
276      {
277          return field_4_width;
278      }
279  
280      /**
281       * Set the width field for the AxisParent record.
282       */
283      public void setWidth(int field_4_width)
284      {
285          this.field_4_width = field_4_width;
286      }
287  
288      /**
289       * Get the height field for the AxisParent record.
290       */
291      public int getHeight()
292      {
293          return field_5_height;
294      }
295  
296      /**
297       * Set the height field for the AxisParent record.
298       */
299      public void setHeight(int field_5_height)
300      {
301          this.field_5_height = field_5_height;
302      }
303  
304  
305  }  // END OF CLASS
306  
307  
308  
309  
310