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