From 65144ee10186261dd26344fd730bca29d380384d Mon Sep 17 00:00:00 2001 From: Nick Burch Date: Thu, 14 Aug 2008 21:57:00 +0000 Subject: [PATCH] Merged revisions 638786-638802,638805-638811,638813-638814,638816-639230,639233-639241,639243-639253,639255-639486,639488-639601,639603-639835,639837-639917,639919-640056,640058-640710,640712-641156,641158-641184,641186-641795,641797-641798,641800-641933,641935-641963,641965-641966,641968-641995,641997-642230,642232-642562,642564-642565,642568-642570,642572-642573,642576-642736,642739-642877,642879,642881-642890,642892-642903,642905-642945,642947-643624,643626-643653,643655-643669,643671,643673-643830,643832-643833,643835-644342,644344-644472,644474-644508,644510-645347,645349-645351,645353-645559,645561-645565,645568-645951,645953-646193,646195-646311,646313-646404,646406-646665,646667-646853,646855-646869,646871-647151,647153-647185,647187-647277,647279-647566,647568-647573,647575,647578-647711,647714-647737,647739-647823,647825-648155,648157-648202,648204-648273,648275,648277-648302,648304-648333,648335-648588,648590-648622,648625-648673,648675-649141,649144,649146-649556,649558-649795,649799,649801-649910,649912-649913,649915-650128,650131-650132,650134-650137,650140-650914,650916-651991,651993-652284,652286-652287,652289,652291,652293-652297,652299-652328,652330-652425,652427-652445,652447-652560,652562-652933,652935,652937-652993,652995-653116,653118-653124,653126-653483,653487-653519,653522-653550,653552-653607,653609-653667,653669-653674,653676-653814,653817-653830,653832-653891,653893-653944,653946-654055,654057-654355,654357-654365,654367-654648,654651-655215,655217-655277,655279-655281,655283-655911,655913-656212,656214,656216-656251,656253-656698,656700-656756,656758-656892,656894-657135,657137-657165,657168-657179,657181-657354,657356-657357,657359-657701,657703-657874,657876-658032,658034-658284,658286,658288-658301,658303-658307,658309-658321,658323-658335,658337-658348,658351,658353-658832,658834-658983,658985,658987-659066,659068-659402,659404-659428,659430-659451,659453-659454,659456-659461,659463-659477,659479-659524,659526-659571,659574,659576-660255,660257-660262,660264-660279,660281-660343,660345-660473,660475-660827,660829-660833,660835-660888,660890-663321,663323-663435,663437-663764,663766-663854,663856-664219,664221-664489,664494-664514,664516-668013,668015-668142,668144-668152,668154,668156-668256,668258,668260-669139,669141-669455,669457-669657,669659-669808,669810-670189,670191-671321,671323-672229,672231-672549,672551-672552,672554-672561,672563-672566,672568,672571-673049,673051-673852,673854-673862,673864-673986,673988-673996,673998-674347,674349-674890,674892-674910,674912-674936,674938-674952,674954-675078,675080-675085,675087-675217,675219-675660,675662-675670,675672-675716,675718-675726,675728-675733,675735-675775,675777-675782,675784,675786-675791,675794-675852,675854-676200,676202,676204,676206-676220,676222-676309,676311-676456,676458-676994,676996-677027,677030-677040,677042-677056,677058-677375,677377-677968,677970-677971,677973,677975-677994,677996-678286,678288-678538,678540-680393,680395-680469,680471-680529,680531-680852,680854-681529,681531-681571,681573-682224,682226,682228,682231-682281,682283-682335,682337-682507,682509,682512-682517,682519-682532,682534-682619,682622-682777,682779-682998,683000-683019,683021-683022,683024-683080,683082-683092,683094-683095,683097-683127,683129-683131,683133-683166,683168-683698,683700-683705,683707-683757,683759-683787,683789-683870,683872-683879,683881-683900,683902-684066,684068-684074,684076-684222,684224-684254,684257-684281,684283-684286,684288-684292,684294-684298,684300-684301,684303-684308,684310-684317,684320,684323-684335,684337-684348,684350-684354,684356-684361,684363-684369,684371-684453,684455-684883,684885-684937,684940-684958,684960-684970,684972-684985,684987-685053,685055-685063,685065-685259,685261-685262,685264-685266,685268-685282,685285-686053 via svnmerge from https://svn.apache.org/repos/asf/poi/trunk ........ r686036 | nick | 2008-08-14 21:50:06 +0100 (Thu, 14 Aug 2008) | 1 line Refactor header/footer stuff to remove duplication ........ r686046 | nick | 2008-08-14 22:25:16 +0100 (Thu, 14 Aug 2008) | 1 line Fix bug #45623 - Support stripping HSSF header and footer fields (eg page number) out of header and footer text if required ........ r686053 | nick | 2008-08-14 22:41:01 +0100 (Thu, 14 Aug 2008) | 1 line More for bug #45623 - Support for additional HSSF header and footer fields, including bold and full file path ........ git-svn-id: https://svn.apache.org/repos/asf/poi/branches/ooxml@686057 13f79535-47bb-0310-9956-ffa450edef68 --- src/documentation/content/xdocs/changes.xml | 4 +- src/documentation/content/xdocs/status.xml | 4 +- .../apache/poi/hssf/usermodel/HSSFFooter.java | 178 +--------- .../apache/poi/hssf/usermodel/HSSFHeader.java | 211 +----------- .../poi/hssf/usermodel/HeaderFooter.java | 305 +++++++++++++++++- .../hssf/usermodel/TestHSSFHeaderFooter.java | 51 ++- 6 files changed, 363 insertions(+), 390 deletions(-) diff --git a/src/documentation/content/xdocs/changes.xml b/src/documentation/content/xdocs/changes.xml index 04547c7a91..09fcd8574b 100644 --- a/src/documentation/content/xdocs/changes.xml +++ b/src/documentation/content/xdocs/changes.xml @@ -59,7 +59,9 @@ Created a common interface for handling Excel files, irrespective of if they are .xls or .xlsx - 45622 - Support stripping HWPF fields (eg macros) out of text, via Range.stripFields(text) + 45623 - Support for additional HSSF header and footer fields, including bold and full file path + 45623 - Support stripping HSSF header and footer fields (eg page number) out of header and footer text if required + 45622 - Support stripping HWPF fields (eg macros) out of text, via Range.stripFields(text) New HPSF based TextExtractor for document metadata, org.apache.poi.hpsf.extractor.HPSFPropertiesExtractor Properly update the array of Slide's text runs in HSLF when new text shapes are added 45590 - Fix for Header/footer extraction for .ppt files saved in Office 2007 diff --git a/src/documentation/content/xdocs/status.xml b/src/documentation/content/xdocs/status.xml index a75dc2837a..282ee631e4 100644 --- a/src/documentation/content/xdocs/status.xml +++ b/src/documentation/content/xdocs/status.xml @@ -56,7 +56,9 @@ Created a common interface for handling Excel files, irrespective of if they are .xls or .xlsx - 45622 - Support stripping HWPF fields (eg macros) out of text, via Range.stripFields(text) + 45623 - Support for additional HSSF header and footer fields, including bold and full file path + 45623 - Support stripping HSSF header and footer fields (eg page number) out of header and footer text if required + 45622 - Support stripping HWPF fields (eg macros) out of text, via Range.stripFields(text) New HPSF based TextExtractor for document metadata, org.apache.poi.hpsf.extractor.HPSFPropertiesExtractor Properly update the array of Slide's text runs in HSLF when new text shapes are added 45590 - Fix for Header/footer extraction for .ppt files saved in Office 2007 diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFFooter.java b/src/java/org/apache/poi/hssf/usermodel/HSSFFooter.java index d85f1b60e3..4b84dd2f1a 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFFooter.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFFooter.java @@ -33,63 +33,16 @@ import org.apache.poi.ss.usermodel.Footer; *

* @author Shawn Laubach (slaubach at apache dot org) */ -public class HSSFFooter implements Footer, HeaderFooter { - FooterRecord footerRecord; - String left; - String center; - String right; +public class HSSFFooter extends HeaderFooter implements Footer { + private FooterRecord footerRecord; /** * Constructor. Creates a new footer interface from a footer record * @param footerRecord Footer record to create the footer with */ protected HSSFFooter(FooterRecord footerRecord) { - this.footerRecord = footerRecord; - String foot = footerRecord.getFooter(); - while (foot != null && foot.length() > 1) { - int pos = foot.length(); - switch (foot.substring(1, 2).charAt(0)) { - case 'L' : - if (foot.indexOf("&C") >= 0) { - pos = Math.min(pos, foot.indexOf("&C")); - } - if (foot.indexOf("&R") >= 0) { - pos = Math.min(pos, foot.indexOf("&R")); - } - left = foot.substring(2, pos); - foot = foot.substring(pos); - break; - case 'C' : - if (foot.indexOf("&L") >= 0) { - pos = Math.min(pos, foot.indexOf("&L")); - } - if (foot.indexOf("&R") >= 0) { - pos = Math.min(pos, foot.indexOf("&R")); - } - center = foot.substring(2, pos); - foot = foot.substring(pos); - break; - case 'R' : - if (foot.indexOf("&C") >= 0) { - pos = Math.min(pos, foot.indexOf("&C")); - } - if (foot.indexOf("&L") >= 0) { - pos = Math.min(pos, foot.indexOf("&L")); - } - right = foot.substring(2, pos); - foot = foot.substring(pos); - break; - default : foot = null; - } - } - } - - /** - * Get the left side of the footer. - * @return The string representing the left side. - */ - public String getLeft() { - return left; + super(footerRecord.getFooter()); + this.footerRecord = footerRecord; } /** @@ -101,14 +54,6 @@ public class HSSFFooter implements Footer, HeaderFooter { createFooterString(); } - /** - * Get the center of the footer. - * @return The string representing the center. - */ - public String getCenter() { - return center; - } - /** * Sets the center string. * @param newCenter The string to set as the center. @@ -118,14 +63,6 @@ public class HSSFFooter implements Footer, HeaderFooter { createFooterString(); } - /** - * Get the right side of the footer. - * @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. @@ -146,112 +83,5 @@ public class HSSFFooter implements Footer, HeaderFooter { "&R" + (right == null ? "" : right)); footerRecord.setFooterLength((byte)footerRecord.getFooter().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"; - } - - /** - * Returns the string representing the start underline - * - * @return The special string for start underline - */ - public static String startUnderline() - { - return "&U"; - } - - /** - * Returns the string representing the end underline - * - * @return The special string for end underline - */ - public static String endUnderline() - { - return "&U"; - } - - /** - * Returns the string representing the start double underline - * - * @return The special string for start double underline - */ - public static String startDoubleUnderline() - { - return "&E"; - } - - /** - * Returns the string representing the end double underline - * - * @return The special string for end double underline - */ - public static String endDoubleUnderline() - { - return "&E"; - } } diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFHeader.java b/src/java/org/apache/poi/hssf/usermodel/HSSFHeader.java index 535b70efa1..76bfdbd86b 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFHeader.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFHeader.java @@ -33,78 +33,17 @@ import org.apache.poi.ss.usermodel.Header; * * @author Shawn Laubach (slaubach at apache dot org) */ -public class HSSFHeader implements Header, HeaderFooter -{ - - HeaderRecord headerRecord; - String left; - String center; - String right; +public class HSSFHeader extends HeaderFooter implements Header { + private HeaderRecord headerRecord; /** * Constructor. Creates a new header interface from a header record * * @param headerRecord Header record to create the header with */ - protected HSSFHeader( HeaderRecord headerRecord ) - { + protected HSSFHeader( HeaderRecord headerRecord ) { + super(headerRecord.getHeader()); 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; } /** @@ -118,16 +57,6 @@ public class HSSFHeader implements Header, HeaderFooter createHeaderString(); } - /** - * Get the center of the header. - * - * @return The string representing the center. - */ - public String getCenter() - { - return center; - } - /** * Sets the center string. * @@ -139,16 +68,6 @@ public class HSSFHeader implements Header, HeaderFooter createHeaderString(); } - /** - * Get the right side of the header. - * - * @return The string representing the right side. - */ - public String getRight() - { - return right; - } - /** * Sets the right string. * @@ -172,127 +91,5 @@ public class HSSFHeader implements Header, HeaderFooter 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"; - } - - /** - * Returns the string representing the start underline - * - * @return The special string for start underline - */ - public static String startUnderline() - { - return "&U"; - } - - /** - * Returns the string representing the end underline - * - * @return The special string for end underline - */ - public static String endUnderline() - { - return "&U"; - } - - /** - * Returns the string representing the start double underline - * - * @return The special string for start double underline - */ - public static String startDoubleUnderline() - { - return "&E"; - } - - /** - * Returns the string representing the end double underline - * - * @return The special string for end double underline - */ - public static String endDoubleUnderline() - { - return "&E"; - } } diff --git a/src/java/org/apache/poi/hssf/usermodel/HeaderFooter.java b/src/java/org/apache/poi/hssf/usermodel/HeaderFooter.java index 44dfd79567..499cda7920 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HeaderFooter.java +++ b/src/java/org/apache/poi/hssf/usermodel/HeaderFooter.java @@ -16,9 +16,310 @@ ==================================================================== */ package org.apache.poi.hssf.usermodel; +import java.util.ArrayList; + /** - * Common interface for {@link HSSFHeader} and + * Common class for {@link HSSFHeader} and * {@link HSSFFooter}. */ -public interface HeaderFooter extends org.apache.poi.ss.usermodel.HeaderFooter { +public abstract class HeaderFooter implements org.apache.poi.ss.usermodel.HeaderFooter { + protected String left; + protected String center; + protected String right; + + private boolean stripFields = false; + + protected HeaderFooter(String text) { + while (text != null && text.length() > 1) { + int pos = text.length(); + switch (text.substring(1, 2).charAt(0)) { + case 'L' : + if (text.indexOf("&C") >= 0) { + pos = Math.min(pos, text.indexOf("&C")); + } + if (text.indexOf("&R") >= 0) { + pos = Math.min(pos, text.indexOf("&R")); + } + left = text.substring(2, pos); + text = text.substring(pos); + break; + case 'C' : + if (text.indexOf("&L") >= 0) { + pos = Math.min(pos, text.indexOf("&L")); + } + if (text.indexOf("&R") >= 0) { + pos = Math.min(pos, text.indexOf("&R")); + } + center = text.substring(2, pos); + text = text.substring(pos); + break; + case 'R' : + if (text.indexOf("&C") >= 0) { + pos = Math.min(pos, text.indexOf("&C")); + } + if (text.indexOf("&L") >= 0) { + pos = Math.min(pos, text.indexOf("&L")); + } + right = text.substring(2, pos); + text = text.substring(pos); + break; + default: + text = null; + } + } + } + + /** + * Get the left side of the header or footer. + * @return The string representing the left side. + */ + public String getLeft() { + if(stripFields) + return stripFields(left); + return left; + } + public abstract void setLeft( String newLeft ); + + /** + * Get the center of the header or footer. + * @return The string representing the center. + */ + public String getCenter() { + if(stripFields) + return stripFields(center); + return center; + } + public abstract void setCenter( String newCenter ); + + /** + * Get the right side of the header or footer. + * @return The string representing the right side. + */ + public String getRight() { + if(stripFields) + return stripFields(right); + return right; + } + public abstract void setRight( String newRight ); + + + /** + * 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, one of regular, italic, bold, italic bold or bold italic + * @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 PAGE_FIELD.sequence; + } + + /** + * Returns the string representing the number of pages. + * + * @return The special string for the number of pages + */ + public static String numPages() { + return NUM_PAGES_FIELD.sequence; + } + + /** + * Returns the string representing the current date + * + * @return The special string for the date + */ + public static String date() { + return DATE_FIELD.sequence; + } + + /** + * Returns the string representing the current time + * + * @return The special string for the time + */ + public static String time() { + return TIME_FIELD.sequence; + } + + /** + * Returns the string representing the current file name + * + * @return The special string for the file name + */ + public static String file() { + return FILE_FIELD.sequence; + } + + /** + * Returns the string representing the current tab (sheet) name + * + * @return The special string for tab name + */ + public static String tab() { + return SHEET_NAME_FIELD.sequence; + } + + /** + * Returns the string representing the start bold + * + * @return The special string for start bold + */ + public static String startBold() { + return BOLD_FIELD.sequence; + } + + /** + * Returns the string representing the end bold + * + * @return The special string for end bold + */ + public static String endBold() { + return BOLD_FIELD.sequence; + } + + /** + * Returns the string representing the start underline + * + * @return The special string for start underline + */ + public static String startUnderline() { + return UNDERLINE_FIELD.sequence; + } + + /** + * Returns the string representing the end underline + * + * @return The special string for end underline + */ + public static String endUnderline() { + return UNDERLINE_FIELD.sequence; + } + + /** + * Returns the string representing the start double underline + * + * @return The special string for start double underline + */ + public static String startDoubleUnderline() { + return DOUBLE_UNDERLINE_FIELD.sequence; + } + + /** + * Returns the string representing the end double underline + * + * @return The special string for end double underline + */ + public static String endDoubleUnderline() { + return DOUBLE_UNDERLINE_FIELD.sequence; + } + + + /** + * Removes any fields (eg macros, page markers etc) + * from the string. + * Normally used to make some text suitable for showing + * to humans, and the resultant text should not normally + * be saved back into the document! + */ + public static String stripFields(String text) { + int pos; + + // Firstly, do the easy ones which are static + for(int i=0; i -1) { + text = text.substring(0, pos) + + text.substring(pos+seq.length()); + } + } + + // Now do the tricky, dynamic ones + text = text.replaceAll("\\&\\d+", ""); + text = text.replaceAll("\\&\".*?,.*?\"", ""); + + // All done + return text; + } + + + /** + * Are fields currently being stripped from + * the text that this {@link HeaderStories} returns? + * Default is false, but can be changed + */ + public boolean areFieldsStripped() { + return stripFields; + } + /** + * Should fields (eg macros) be stripped from + * the text that this class returns? + * Default is not to strip. + * @param stripFields + */ + public void setAreFieldsStripped(boolean stripFields) { + this.stripFields = stripFields; + } + + + public static final Field SHEET_NAME_FIELD = new Field("&A"); + public static final Field DATE_FIELD = new Field("&D"); + public static final Field FILE_FIELD = new Field("&F"); + public static final Field FULL_FILE_FIELD = new Field("&Z"); + public static final Field PAGE_FIELD = new Field("&P"); + public static final Field TIME_FIELD = new Field("&T"); + public static final Field NUM_PAGES_FIELD = new Field("&N"); + + public static final Field PICTURE_FIELD = new Field("&P"); + + public static final PairField BOLD_FIELD = new PairField("&B"); // PAID + public static final PairField ITALIC_FIELD = new PairField("&I"); + public static final PairField STRIKETHROUGH_FIELD = new PairField("&S"); + public static final PairField SUBSCRIPT_FIELD = new PairField("&Y"); + public static final PairField SUPERSCRIPT_FIELD = new PairField("&X"); + public static final PairField UNDERLINE_FIELD = new PairField("&U"); + public static final PairField DOUBLE_UNDERLINE_FIELD = new PairField("&E"); + + /** + * Represents a special field in a header or footer, + * eg the page number + */ + public static class Field { + private static ArrayList ALL_FIELDS = new ArrayList(); + /** The character sequence that marks this field */ + public final String sequence; + private Field(String sequence) { + this.sequence = sequence; + ALL_FIELDS.add(this); + } + } + /** + * A special field that normally comes in a pair, eg + * turn on underline / turn off underline + */ + public static class PairField extends Field { + private PairField(String sequence) { + super(sequence); + } + } } diff --git a/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFHeaderFooter.java b/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFHeaderFooter.java index ddc9535553..caa75633b0 100644 --- a/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFHeaderFooter.java +++ b/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFHeaderFooter.java @@ -17,11 +17,6 @@ package org.apache.poi.hssf.usermodel; -import java.io.ByteArrayInputStream; -import java.io.ByteArrayOutputStream; -import java.io.File; -import java.io.FileInputStream; - import junit.framework.TestCase; import org.apache.poi.hssf.HSSFTestDataSamples; @@ -49,6 +44,52 @@ public final class TestHSSFHeaderFooter extends TestCase { assertEquals("Top Center", head.getCenter()); assertEquals("Top Right", head.getRight()); } + + public void testSpecialChars() { + assertEquals("&U", HSSFHeader.startUnderline()); + assertEquals("&U", HSSFHeader.endUnderline()); + assertEquals("&P", HSSFHeader.page()); + + assertEquals("&22", HSSFFooter.fontSize((short)22)); + assertEquals("&\"Arial,bold\"", HSSFFooter.font("Arial", "bold")); + } + + public void testStripFields() { + String simple = "I am a test header"; + String withPage = "I am a&P test header"; + String withLots = "I&A am&N a&P test&T header&U"; + String withFont = "I&22 am a&\"Arial,bold\" test header"; + String withOtherAnds = "I am a&P test header&&"; + String withOtherAnds2 = "I am a&P test header&a&b"; + + assertEquals(simple, HSSFHeader.stripFields(simple)); + assertEquals(simple, HSSFHeader.stripFields(withPage)); + assertEquals(simple, HSSFHeader.stripFields(withLots)); + assertEquals(simple, HSSFHeader.stripFields(withFont)); + assertEquals(simple + "&&", HSSFHeader.stripFields(withOtherAnds)); + assertEquals(simple + "&a&b", HSSFHeader.stripFields(withOtherAnds2)); + + // Now test the default strip flag + HSSFWorkbook wb = HSSFTestDataSamples.openSampleWorkbook("EmbeddedChartHeaderTest.xls"); + HSSFSheet s = wb.getSheetAt( 0 ); + HSSFHeader head = s.getHeader(); + + assertEquals("Top Left", head.getLeft()); + assertEquals("Top Center", head.getCenter()); + assertEquals("Top Right", head.getRight()); + + head.setLeft("Top &P&F&D Left"); + assertEquals("Top &P&F&D Left", head.getLeft()); + assertFalse(head.areFieldsStripped()); + + head.setAreFieldsStripped(true); + assertEquals("Top Left", head.getLeft()); + assertTrue(head.areFieldsStripped()); + + // Now even more complex + head.setCenter("HEADER TEXT &P&N&D&T&Z&F&F&A&G"); + assertEquals("HEADER TEXT &G", head.getCenter()); + } /** * Tests that get header retreives the proper values.