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 frame record indicates whether there is a border around the displayed text of a chart.
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 FrameRecord
71       extends Record
72   {
73       public final static short      sid                             = 0x1032;
74       private  short      field_1_borderType;
75       public final static short       BORDER_TYPE_REGULAR            = 0;
76       public final static short       BORDER_TYPE_SHADOW             = 1;
77       private  short      field_2_options;
78       private  BitField   autoSize                                    = new BitField(0x1);
79       private  BitField   autoPosition                                = new BitField(0x2);
80   
81   
82       public FrameRecord()
83       {
84   
85       }
86   
87       /**
88        * Constructs a Frame record and sets its fields appropriately.
89        *
90        * @param id    id must be 0x1032 or an exception
91        *              will be throw upon validation
92        * @param size  size the size of the data area of the record
93        * @param data  data of the record (should not contain sid/len)
94        */
95   
96       public FrameRecord(short id, short size, byte [] data)
97       {
98           super(id, size, data);
99       
100      }
101  
102      /**
103       * Constructs a Frame record and sets its fields appropriately.
104       *
105       * @param id    id must be 0x1032 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 FrameRecord(short id, short size, byte [] data, int offset)
113      {
114          super(id, size, data, offset);
115      
116      }
117  
118      /**
119       * Checks the sid matches the expected side for this record
120       *
121       * @param id   the expected sid.
122       */
123      protected void validateSid(short id)
124      {
125          if (id != sid)
126          {
127              throw new RecordFormatException("Not a Frame record");
128          }
129      }
130  
131      protected void fillFields(byte [] data, short size, int offset)
132      {
133  
134          int pos = 0;
135          field_1_borderType             = LittleEndian.getShort(data, pos + 0x0 + offset);
136          field_2_options                = LittleEndian.getShort(data, pos + 0x2 + offset);
137  
138      }
139  
140      public String toString()
141      {
142          StringBuffer buffer = new StringBuffer();
143  
144          buffer.append("[FRAME]\n");
145          buffer.append("    .borderType           = ")
146              .append("0x").append(HexDump.toHex(  getBorderType ()))
147              .append(" (").append( getBorderType() ).append(" )");
148          buffer.append(System.getProperty("line.separator")); 
149          buffer.append("    .options              = ")
150              .append("0x").append(HexDump.toHex(  getOptions ()))
151              .append(" (").append( getOptions() ).append(" )");
152          buffer.append(System.getProperty("line.separator")); 
153          buffer.append("         .autoSize                 = ").append(isAutoSize()).append('\n'); 
154          buffer.append("         .autoPosition             = ").append(isAutoPosition()).append('\n'); 
155  
156          buffer.append("[/FRAME]\n");
157          return buffer.toString();
158      }
159  
160      public int serialize(int offset, byte[] data)
161      {
162          int pos = 0;
163  
164          LittleEndian.putShort(data, 0 + offset, sid);
165          LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));
166  
167          LittleEndian.putShort(data, 4 + offset + pos, field_1_borderType);
168          LittleEndian.putShort(data, 6 + offset + pos, field_2_options);
169  
170          return getRecordSize();
171      }
172  
173      /**
174       * Size of record (exluding 4 byte header)
175       */
176      public int getRecordSize()
177      {
178          return 4  + 2 + 2;
179      }
180  
181      public short getSid()
182      {
183          return this.sid;
184      }
185  
186      public Object clone() {
187          FrameRecord rec = new FrameRecord();
188      
189          rec.field_1_borderType = field_1_borderType;
190          rec.field_2_options = field_2_options;
191          return rec;
192      }
193  
194  
195  
196  
197      /**
198       * Get the border type field for the Frame record.
199       *
200       * @return  One of 
201       *        BORDER_TYPE_REGULAR
202       *        BORDER_TYPE_SHADOW
203       */
204      public short getBorderType()
205      {
206          return field_1_borderType;
207      }
208  
209      /**
210       * Set the border type field for the Frame record.
211       *
212       * @param field_1_borderType
213       *        One of 
214       *        BORDER_TYPE_REGULAR
215       *        BORDER_TYPE_SHADOW
216       */
217      public void setBorderType(short field_1_borderType)
218      {
219          this.field_1_borderType = field_1_borderType;
220      }
221  
222      /**
223       * Get the options field for the Frame record.
224       */
225      public short getOptions()
226      {
227          return field_2_options;
228      }
229  
230      /**
231       * Set the options field for the Frame record.
232       */
233      public void setOptions(short field_2_options)
234      {
235          this.field_2_options = field_2_options;
236      }
237  
238      /**
239       * Sets the auto size field value.
240       * excel calculates the size automatically if true
241       */
242      public void setAutoSize(boolean value)
243      {
244          field_2_options = autoSize.setShortBoolean(field_2_options, value);
245      }
246  
247      /**
248       * excel calculates the size automatically if true
249       * @return  the auto size field value.
250       */
251      public boolean isAutoSize()
252      {
253          return autoSize.isSet(field_2_options);
254      }
255  
256      /**
257       * Sets the auto position field value.
258       * excel calculates the position automatically
259       */
260      public void setAutoPosition(boolean value)
261      {
262          field_2_options = autoPosition.setShortBoolean(field_2_options, value);
263      }
264  
265      /**
266       * excel calculates the position automatically
267       * @return  the auto position field value.
268       */
269      public boolean isAutoPosition()
270      {
271          return autoPosition.isSet(field_2_options);
272      }
273  
274  
275  }  // END OF CLASS
276  
277  
278  
279  
280