1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
|
/* ====================================================================
Copyright 2003-2004 Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
==================================================================== */
package org.apache.poi.hssf.usermodel;
import org.apache.poi.hssf.record.HeaderRecord;
/**
* Class to read and manipulate the header.
* <P>
* The header works by having a left, center, and right side. The total cannot
* be more that 255 bytes long. One uses this class by getting the HSSFHeader
* from HSSFSheet and then getting or setting the left, center, and right side.
* For special things (such as page numbers and date), one can use a the methods
* that return the characters used to represent these. One can also change the
* fonts by using similar methods.
* <P>
*
* @author Shawn Laubach (slaubach at apache dot org)
*/
public class HSSFHeader
{
HeaderRecord headerRecord;
String left;
String center;
String right;
/**
* Constructor. Creates a new header interface from a header record
*
* @param headerRecord Header record to create the header with
*/
protected HSSFHeader( HeaderRecord headerRecord )
{
this.headerRecord = headerRecord;
String head = headerRecord.getHeader();
while ( head != null && head.length() > 1 )
{
int pos = head.length();
switch ( head.substring( 1, 2 ).charAt( 0 ) )
{
case 'L':
if ( head.indexOf( "&C" ) >= 0 )
{
pos = Math.min( pos, head.indexOf( "&C" ) );
}
if ( head.indexOf( "&R" ) >= 0 )
{
pos = Math.min( pos, head.indexOf( "&R" ) );
}
left = head.substring( 2, pos );
head = head.substring( pos );
break;
case 'C':
if ( head.indexOf( "&L" ) >= 0 )
{
pos = Math.min( pos, head.indexOf( "&L" ) );
}
if ( head.indexOf( "&R" ) >= 0 )
{
pos = Math.min( pos, head.indexOf( "&R" ) );
}
center = head.substring( 2, pos );
head = head.substring( pos );
break;
case 'R':
if ( head.indexOf( "&C" ) >= 0 )
{
pos = Math.min( pos, head.indexOf( "&C" ) );
}
if ( head.indexOf( "&L" ) >= 0 )
{
pos = Math.min( pos, head.indexOf( "&L" ) );
}
right = head.substring( 2, pos );
head = head.substring( pos );
break;
default :
head = null;
}
}
}
/**
* Get the left side of the header.
*
* @return The string representing the left side.
*/
public String getLeft()
{
return left;
}
/**
* Sets the left string.
*
* @param newLeft The string to set as the left side.
*/
public void setLeft( String newLeft )
{
left = newLeft;
createHeaderString();
}
/**
* Get the center of the header.
*
* @return The string representing the center.
*/
public String getCenter()
{
return center;
}
/**
* Sets the center string.
*
* @param newCenter The string to set as the center.
*/
public void setCenter( String newCenter )
{
center = newCenter;
createHeaderString();
}
/**
* Get the right side of the header.
*
* @return The string representing the right side.
*/
public String getRight()
{
return right;
}
/**
* Sets the right string.
*
* @param newRight The string to set as the right side.
*/
public void setRight( String newRight )
{
right = newRight;
createHeaderString();
}
/**
* Creates the complete header string based on the left, center, and middle
* strings.
*/
private void createHeaderString()
{
headerRecord.setHeader( "&C" + ( center == null ? "" : center ) +
"&L" + ( left == null ? "" : left ) +
"&R" + ( right == null ? "" : right ) );
headerRecord.setHeaderLength( (byte) headerRecord.getHeader().length() );
}
/**
* Returns the string that represents the change in font size.
*
* @param size the new font size
* @return The special string to represent a new font size
*/
public static String fontSize( short size )
{
return "&" + size;
}
/**
* Returns the string that represents the change in font.
*
* @param font the new font
* @param style the fonts style
* @return The special string to represent a new font size
*/
public static String font( String font, String style )
{
return "&\"" + font + "," + style + "\"";
}
/**
* Returns the string representing the current page number
*
* @return The special string for page number
*/
public static String page()
{
return "&P";
}
/**
* Returns the string representing the number of pages.
*
* @return The special string for the number of pages
*/
public static String numPages()
{
return "&N";
}
/**
* Returns the string representing the current date
*
* @return The special string for the date
*/
public static String date()
{
return "&D";
}
/**
* Returns the string representing the current time
*
* @return The special string for the time
*/
public static String time()
{
return "&T";
}
/**
* Returns the string representing the current file name
*
* @return The special string for the file name
*/
public static String file()
{
return "&F";
}
/**
* Returns the string representing the current tab (sheet) name
*
* @return The special string for tab name
*/
public static String tab()
{
return "&A";
}
}
|
