KickJava   Java API By Example, From Geeks To Geeks.

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


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: Print Gridlines Record<P>
25  * Description: whether to print the gridlines when you enjoy you spreadsheet on paper.<P>
26  * REFERENCE: PG 373 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 PrintGridlinesRecord
33     extends Record
34 {
35     public final static short sid = 0x2b;
36     private short field_1_print_gridlines;
37
38     public PrintGridlinesRecord()
39     {
40     }
41
42     /**
43      * Constructs a PrintGridlines record and sets its fields appropriately.
44      *
45      * @param id id must be 0x2b 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 PrintGridlinesRecord(short id, short size, byte [] data)
51     {
52         super(id, size, data);
53     }
54
55     /**
56      * Constructs a PrintGridlines record and sets its fields appropriately.
57      *
58      * @param id id must be 0x2b 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 data
62      */
63
64     public PrintGridlinesRecord(short id, short size, byte [] data,
65                                 int offset)
66     {
67         super(id, size, data, offset);
68     }
69
70     protected void validateSid(short id)
71     {
72         if (id != sid)
73         {
74             throw new RecordFormatException("NOT A PrintGridlines RECORD");
75         }
76     }
77
78     protected void fillFields(byte [] data, short size, int offset)
79     {
80         field_1_print_gridlines = LittleEndian.getShort(data, 0 + offset);
81     }
82
83     /**
84      * set whether or not to print the gridlines (and make your spreadsheet ugly)
85      *
86      * @param pg make spreadsheet ugly - Y/N
87      */
88
89     public void setPrintGridlines(boolean pg)
90     {
91         if (pg == true)
92         {
93             field_1_print_gridlines = 1;
94         }
95         else
96         {
97             field_1_print_gridlines = 0;
98         }
99     }
100
101     /**
102      * get whether or not to print the gridlines (and make your spreadsheet ugly)
103      *
104      * @return make spreadsheet ugly - Y/N
105      */
106
107     public boolean getPrintGridlines()
108     {
109         return (field_1_print_gridlines == 1);
110     }
111
112     public String JavaDoc toString()
113     {
114         StringBuffer JavaDoc buffer = new StringBuffer JavaDoc();
115
116         buffer.append("[PRINTGRIDLINES]\n");
117         buffer.append(" .printgridlines = ").append(getPrintGridlines())
118             .append("\n");
119         buffer.append("[/PRINTGRIDLINES]\n");
120         return buffer.toString();
121     }
122
123     public int serialize(int offset, byte [] data)
124     {
125         LittleEndian.putShort(data, 0 + offset, sid);
126         LittleEndian.putShort(data, 2 + offset, ( short ) 0x2);
127         LittleEndian.putShort(data, 4 + offset, field_1_print_gridlines);
128         return getRecordSize();
129     }
130
131     public int getRecordSize()
132     {
133         return 6;
134     }
135
136     public short getSid()
137     {
138         return this.sid;
139     }
140
141     public Object JavaDoc clone() {
142       PrintGridlinesRecord rec = new PrintGridlinesRecord();
143       rec.field_1_print_gridlines = field_1_print_gridlines;
144       return rec;
145     }
146 }
147
Popular Tags