From 137e6f588587c27ff9d42607b9c7578ab9601286 Mon Sep 17 00:00:00 2001 From: Nick Burch Date: Wed, 2 Jan 2008 15:48:11 +0000 Subject: [PATCH] Improve the javadocs for font and fill related colourings, and add another tests to check it all works as expected git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@608132 13f79535-47bb-0310-9956-ffa450edef68 --- src/documentation/content/xdocs/changes.xml | 3 +- src/documentation/content/xdocs/status.xml | 3 +- .../poi/hssf/usermodel/HSSFCellStyle.java | 49 +++++++------ .../apache/poi/hssf/usermodel/HSSFFont.java | 2 +- .../poi/hssf/data/SimpleWithColours.xls | Bin 0 -> 6144 bytes .../poi/hssf/usermodel/TestHSSFPalette.java | 65 ++++++++++++++++++ 6 files changed, 98 insertions(+), 24 deletions(-) create mode 100755 src/testcases/org/apache/poi/hssf/data/SimpleWithColours.xls diff --git a/src/documentation/content/xdocs/changes.xml b/src/documentation/content/xdocs/changes.xml index db17e5f5a1..5a39d4d696 100644 --- a/src/documentation/content/xdocs/changes.xml +++ b/src/documentation/content/xdocs/changes.xml @@ -35,7 +35,8 @@ - + + Improve JavaDocs relating to hssf font and fill colourings 44095, 44097, 44099 - [PATCH] Support for Mid, Replace and Substitute excel functions 44055 - [PATCH] Support for getting the from field from HSMF messages 43551 - [PATCH] Support for 1904 date windowing in HSSF (previously only supported 1900 date windowing) diff --git a/src/documentation/content/xdocs/status.xml b/src/documentation/content/xdocs/status.xml index bff8b99c78..39c84096dc 100644 --- a/src/documentation/content/xdocs/status.xml +++ b/src/documentation/content/xdocs/status.xml @@ -32,7 +32,8 @@ - + + Improve JavaDocs relating to hssf font and fill colourings 44095, 44097, 44099 - [PATCH] Support for Mid, Replace and Substitute excel functions 44055 - [PATCH] Support for getting the from field from HSMF messages 43551 - [PATCH] Support for 1904 date windowing in HSSF (previously only supported 1900 date windowing) diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFCellStyle.java b/src/java/org/apache/poi/hssf/usermodel/HSSFCellStyle.java index e2725937fa..cdea9ee5be 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFCellStyle.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFCellStyle.java @@ -294,10 +294,24 @@ public class HSSFCellStyle format.setFontIndex(fontindex); } + /** + * gets the index of the font for this style + * @see org.apache.poi.hssf.usermodel.HSSFWorkbook#getFontAt(short) + */ public short getFontIndex() { return format.getFontIndex(); } + + /** + * gets the font for this style + * @param parentWorkbook The HSSFWorkbook that this style belongs to + * @see org.apache.poi.hssf.usermodel.HSSFCellStyle#getFontIndex() + * @see org.apache.poi.hssf.usermodel.HSSFWorkbook#getFontAt(short) + */ + public HSSFFont getFont(HSSFWorkbook parentWorkbook) { + return parentWorkbook.getFontAt(getFontIndex()); + } /** * set the cell's using this style to be hidden @@ -689,7 +703,6 @@ public class HSSFCellStyle * @see #BORDER_MEDIUM_DASH_DOT_DOT * @see #BORDER_SLANTED_DASH_DOT */ - public short getBorderBottom() { return format.getBorderBottom(); @@ -697,9 +710,8 @@ public class HSSFCellStyle /** * set the color to use for the left border - * @param color + * @param color The index of the color definition */ - public void setLeftBorderColor(short color) { format.setLeftBorderPaletteIdx(color); @@ -707,9 +719,9 @@ public class HSSFCellStyle /** * get the color to use for the left border - * @return color + * @see org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short) + * @param color The index of the color definition */ - public short getLeftBorderColor() { return format.getLeftBorderPaletteIdx(); @@ -717,9 +729,8 @@ public class HSSFCellStyle /** * set the color to use for the right border - * @param color + * @param color The index of the color definition */ - public void setRightBorderColor(short color) { format.setRightBorderPaletteIdx(color); @@ -727,9 +738,9 @@ public class HSSFCellStyle /** * get the color to use for the left border - * @return color + * @see org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short) + * @param color The index of the color definition */ - public short getRightBorderColor() { return format.getRightBorderPaletteIdx(); @@ -737,9 +748,8 @@ public class HSSFCellStyle /** * set the color to use for the top border - * @param color + * @param color The index of the color definition */ - public void setTopBorderColor(short color) { format.setTopBorderPaletteIdx(color); @@ -747,9 +757,9 @@ public class HSSFCellStyle /** * get the color to use for the top border - * @return color + * @see org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short) + * @param color The index of the color definition */ - public short getTopBorderColor() { return format.getTopBorderPaletteIdx(); @@ -757,9 +767,8 @@ public class HSSFCellStyle /** * set the color to use for the bottom border - * @param color + * @param color The index of the color definition */ - public void setBottomBorderColor(short color) { format.setBottomBorderPaletteIdx(color); @@ -767,9 +776,9 @@ public class HSSFCellStyle /** * get the color to use for the left border - * @return color + * @see org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short) + * @param color The index of the color definition */ - public short getBottomBorderColor() { return format.getBottomBorderPaletteIdx(); @@ -871,9 +880,9 @@ public class HSSFCellStyle /** * get the background fill color + * @see org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short) * @return fill color */ - public short getFillBackgroundColor() { short result = format.getFillBackground(); @@ -889,7 +898,6 @@ public class HSSFCellStyle * Note: Ensure Foreground color is set prior to background color. * @param bg color */ - public void setFillForegroundColor(short bg) { format.setFillForeground(bg); @@ -898,12 +906,11 @@ public class HSSFCellStyle /** * get the foreground fill color + * @see org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short) * @return fill color */ - public short getFillForegroundColor() { return format.getFillForeground(); } - } diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFFont.java b/src/java/org/apache/poi/hssf/usermodel/HSSFFont.java index 852e15ee28..cfaa5e4f48 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFFont.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFFont.java @@ -281,8 +281,8 @@ public class HSSFFont * @return color to use * @see #COLOR_NORMAL * @see #COLOR_RED + * @see org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short) */ - public short getColor() { return font.getColorPaletteIndex(); diff --git a/src/testcases/org/apache/poi/hssf/data/SimpleWithColours.xls b/src/testcases/org/apache/poi/hssf/data/SimpleWithColours.xls new file mode 100755 index 0000000000000000000000000000000000000000..ab3cdecf0b5674d10f5333244afb460443b33fb0 GIT binary patch literal 6144 zcmeHLTWpj?6h6D%-nf*uluH52Pg}OTZGl2jPy#I=K@!oXU}%D*EbVT)>9X5ww?Q6^ z>xBeGRII^l#2Dg}m!QU|iTY5Us!35}f<)s(F_`#bqC^u&3cufX{{8pT3l4x3a>y>gyo3mNvj%!`1brEWZ ze5N`-DQC6Jldqs*KJ^My8zomZM}xkQJy0a$2Fg^UAT{8UUA}OituQ0SA7g2piwf6# zcqRQ8|fp$FF^KQ^i<%&wotliVx4!iZ@l^UvKYSbEOg<2y^ex20InoJkg zTr<3IDk(=zO=(warA}65xUw~EZ%IXUnARJSGF`>LO+#C&8Z^k~0xSP7d+5e|=Hf*1 zlksVFBKf#R6j8O!%h!mpo%UpooEa6&%4>3l}B{c^ps`A1#Mhn#VI zd;VkPkEik{+m6K_XU8?u7;w6zIG$s&Es5u8TN-z1J2#%Mt;9v!vUsk!A7_$7Ud8!q zonN?8L@(K7#T!>SAmV(yWEDpnX9vXK;2@f~Bod}18UwhShh-S@0enpGC4l}g4Z<-$ zB-Nf;P#g3DCDj{-zG)^Tfxel5F6^4a326+N(l|T}KBS2R5PS8&%^ofjWcdnx8EOIP0q{us*&WZA!n2?7`9B~i{e6r9CF6t!pb>Z z3-tURm7_RAd1~vs%8r_YMsLU$3@;Z^IvDOT4h3V~hR-->Ir`3@-|sxo($uc}TIJVi{fu(r`ff%`BFm9+T*ap` za@JJ_TbPaeVfR+|-rbwG>~puy!cZ><(MW1_ zK_e)l!B$Q)YCBpQY~`j{Hxul&*f7(fubycD?>xYZf#cj`IHjcxz`L>R2YAwU19O360MCs9U?%VeFb8-Wm<_xS z(DNniKJMq=iwac^q|AaM$0`8o?ukTu`gk|>sVK$CW*OU3MKiAgHYmue&AQjpP&aluv7^4gVh&*xt_D9Yv88SIEg`XYfC6r#P6 zs4o_bgjF*B{7Wx<6F#ewT(Gp{wkJCLA#kS4ZHj>IGuURHa?SbP#LJ2~!rb6q<5|fh zXKpYbcsq0Lxm5VIs=2}Z;d=}ZXf8JQG{WE_#kJP}w z5J4t0O0GNz&mGb)2gR=u*roJA@o6k}fEUm?k`t34=&+@#_4=fLI|dm;lalxY1W~hw qbLHmzjWy~?`scYk)#qOa*