moparisthebest/poi
1
0
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

Javadoc fixes and cleanup.

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@353600 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Glen Stampoultzis 2004-09-19 02:44:52 +00:00
parent 1823459ab0
commit 47d6d559c9
1 changed files with 204 additions and 163 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

367
src/java/org/apache/poi/hssf/usermodel/HSSFHeader.java
View File

@ -28,188 +28,229 @@ import org.apache.poi.hssf.record.HeaderRecord;
* 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 extends Object {
public class HSSFHeader
{
HeaderRecord headerRecord;
String left;
String center;
String right;
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;
}
/**
* 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;
}
/**
* Get the left side of the header.
*
* @return The string representing the left side.
*/
public String getLeft()
{
return left;
}
/**
* Sets the left string.
* @newLeft The string to set as the left side.
*/
public void setLeft(String newLeft) {
left = newLeft;
createHeaderString();
}
/**
* 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;
}
/**
* Get the center of the header.
*
* @return The string representing the center.
*/
public String getCenter()
{
return center;
}
/**
* Sets the center string.
* @newLeft The string to set as the center.
*/
public void setCenter(String newCenter) {
center = newCenter;
createHeaderString();
}
/**
* 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;
}
/**
* Get the right side of the header.
*
* @return The string representing the right side.
*/
public String getRight()
{
return right;
}
/**
* Sets the right string.
* @newLeft The string to set as the right side.
*/
public void setRight(String newRight) {
right = newRight;
createHeaderString();
}
/**
* 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());
}
/**
* 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 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 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 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 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 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 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 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";
}
/**
* Returns the string representing the current tab (sheet) name
*
* @return The special string for tab name
*/
public static String tab()
{
return "&A";
}
}