KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > poi > hssf > record > VCenterRecord


1
2 /* ====================================================================
3    Copyright 2002-2004 Apache Software Foundation
4
5    Licensed under the Apache License, Version 2.0 (the "License");
6    you may not use this file except in compliance with the License.
7    You may obtain a copy of the License at
8
9        http://www.apache.org/licenses/LICENSE-2.0
10
11    Unless required by applicable law or agreed to in writing, software
12    distributed under the License is distributed on an "AS IS" BASIS,
13    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14    See the License for the specific language governing permissions and
15    limitations under the License.
16 ==================================================================== */
17         
18
19 package org.apache.poi.hssf.record;
20
21 import org.apache.poi.util.LittleEndian;
22
23 /**
24  * Title: VCenter record<P>
25  * Description: tells whether to center the sheet between vertical margins<P>
26  * REFERENCE: PG 420 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
27  * @author Andrew C. Oliver (acoliver at apache dot org)
28  * @author Jason Height (jheight at chariot dot net dot au)
29  * @version 2.0-pre
30  */
31
32 public class VCenterRecord
33     extends Record
34 {
35     public final static short sid = 0x84;
36     private short field_1_vcenter;
37
38     public VCenterRecord()
39     {
40     }
41
42     /**
43      * Constructs a VCENTER record and sets its fields appropriately.
44      *
45      * @param id id must be 0x84 or an exception will be throw upon validation
46      * @param size the size of the data area of the record
47      * @param data data of the record (should not contain sid/len)
48      */
49
50     public VCenterRecord(short id, short size, byte [] data)
51     {
52         super(id, size, data);
53     }
54
55     /**
56      * Constructs a VCENTER record and sets its fields appropriately.
57      *
58      * @param id id must be 0x84 or an exception will be throw upon validation
59      * @param size the size of the data area of the record
60      * @param data data of the record (should not contain sid/len)
61      * @param offset of the record's data
62      */
63
64     public VCenterRecord(short id, short size, byte [] data, int offset)
65     {
66         super(id, size, data, offset);
67     }
68
69     protected void validateSid(short id)
70     {
71         if (id != sid)
72         {
73             throw new RecordFormatException("NOT A VCenter RECORD");
74         }
75     }
76
77     protected void fillFields(byte [] data, short size, int offset)
78     {
79         field_1_vcenter = LittleEndian.getShort(data, 0 + offset);
80     }
81
82     /**
83      * set whether to center vertically or not
84      * @param hc vcenter or not
85      */
86
87     public void setVCenter(boolean hc)
88     {
89         if (hc == true)
90         {
91             field_1_vcenter = 1;
92         }
93         else
94         {
95             field_1_vcenter = 0;
96         }
97     }
98
99     /**
100      * get whether to center vertically or not
101      * @return vcenter or not
102      */
103
104     public boolean getVCenter()
105     {
106         return (field_1_vcenter == 1);
107     }
108
109     public String JavaDoc toString()
110     {
111         StringBuffer JavaDoc buffer = new StringBuffer JavaDoc();
112
113         buffer.append("[VCENTER]\n");
114         buffer.append(" .vcenter = ").append(getVCenter())
115             .append("\n");
116         buffer.append("[/VCENTER]\n");
117         return buffer.toString();
118     }
119
120     public int serialize(int offset, byte [] data)
121     {
122         LittleEndian.putShort(data, 0 + offset, sid);
123         LittleEndian.putShort(data, 2 + offset, ( short ) 0x2);
124         LittleEndian.putShort(data, 4 + offset, ( short ) field_1_vcenter);
125         return getRecordSize();
126     }
127
128     public int getRecordSize()
129     {
130         return 6;
131     }
132
133     public short getSid()
134     {
135         return this.sid;
136     }
137
138     public Object JavaDoc clone() {
139       VCenterRecord rec = new VCenterRecord();
140       rec.field_1_vcenter = field_1_vcenter;
141       return rec;
142     }
143 }
144
Popular Tags