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    * preceeds and identifies a frame as belonging to the plot area.
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 Andrew C. Oliver (acoliver at apache.org)
69    */
70   public class PlotAreaRecord
71       extends Record
72   {
73       public final static short      sid                             = 0x1035;
74   
75   
76       public PlotAreaRecord()
77       {
78   
79       }
80   
81       /**
82        * Constructs a PlotArea record and sets its fields appropriately.
83        *
84        * @param id    id must be 0x1035 or an exception
85        *              will be throw upon validation
86        * @param size  size the size of the data area of the record
87        * @param data  data of the record (should not contain sid/len)
88        */
89   
90       public PlotAreaRecord(short id, short size, byte [] data)
91       {
92           super(id, size, data);
93       }
94   
95       /**
96        * Constructs a PlotArea record and sets its fields appropriately.
97        *
98        * @param id    id must be 0x1035 or an exception
99        *              will be throw upon validation
100       * @param size  size the size of the data area of the record
101       * @param data  data of the record (should not contain sid/len)
102       * @param offset of the record's data
103       */
104  
105      public PlotAreaRecord(short id, short size, byte [] data, int offset)
106      {
107          super(id, size, data, offset);
108      }
109  
110      /**
111       * Checks the sid matches the expected side for this record
112       *
113       * @param id   the expected sid.
114       */
115      protected void validateSid(short id)
116      {
117          if (id != sid)
118          {
119              throw new RecordFormatException("Not a PlotArea record");
120          }
121      }
122  
123      protected void fillFields(byte [] data, short size, int offset)
124      {
125  
126      }
127  
128      public String toString()
129      {
130          StringBuffer buffer = new StringBuffer();
131  
132          buffer.append("[PlotArea]\n");
133  
134          buffer.append("[/PlotArea]\n");
135          return buffer.toString();
136      }
137  
138      public int serialize(int offset, byte[] data)
139      {
140          LittleEndian.putShort(data, 0 + offset, sid);
141          LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));
142  
143  
144          return getRecordSize();
145      }
146  
147      /**
148       * Size of record (exluding 4 byte header)
149       */
150      public int getRecordSize()
151      {
152          return 4 ;
153      }
154  
155      public short getSid()
156      {
157          return this.sid;
158      }
159  
160  
161  
162  }  // END OF CLASS
163  
164  
165  
166  
167