Author: nick
Date: Wed Aug 12 14:14:12 2015
New Revision: 1695528
URL: http://svn.apache.org/r1695528
Log:
#58220 - Improve the javadocs for XSSFFont and Font getFontHeight methods
Modified:
poi/trunk/src/java/org/apache/poi/ss/usermodel/Font.java
poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFFont.java
Modified: poi/trunk/src/java/org/apache/poi/ss/usermodel/Font.java
URL:
http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/ss/usermodel/Font.java?rev=1695528&r1=1695527&r2=1695528&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/ss/usermodel/Font.java (original)
+++ poi/trunk/src/java/org/apache/poi/ss/usermodel/Font.java Wed Aug 12
14:14:12 2015
@@ -138,20 +138,25 @@ public interface Font {
void setFontHeightInPoints(short height);
/**
- * get the font height in unit's of 1/20th of a point. Maybe you might
want to
- * use the getFontHeightInPoints which matches to the familiar 10, 12, 14
etc..
+ * Get the font height in unit's of 1/20th of a point.
+ * <p>
+ * For many users, the related {@link #getFontHeightInPoints()}
+ * will be more helpful, as that returns font heights in the
+ * more familiar points units, eg 10, 12, 14.
+
* @return short - height in 1/20ths of a point
* @see #getFontHeightInPoints()
*/
-
short getFontHeight();
/**
- * get the font height
+ * Get the font height in points.
+ * <p>
+ * This will return the same font height that is shown in Excel,
+ * such as 10 or 14 or 28.
* @return short - height in the familiar unit of measure - points
* @see #getFontHeight()
*/
-
short getFontHeightInPoints();
/**
Modified: poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFFont.java
URL:
http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFFont.java?rev=1695528&r1=1695527&r2=1695528&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFFont.java
(original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFFont.java Wed
Aug 12 14:14:12 2015
@@ -174,24 +174,42 @@ public class XSSFFont implements Font {
}
/**
- * get the font height in point.
- *
- * @return short - height in point
+ * Get the font height in unit's of 1/20th of a point.
+ * <p>
+ * For many users, the related {@link #getFontHeightInPoints()}
+ * will be more helpful, as that returns font heights in the
+ * more familiar points units, eg 10, 12, 14.
+
+ * @return short - height in 1/20ths of a point
+ * @see #getFontHeightInPoints()
*/
public short getFontHeight() {
- CTFontSize size = _ctFont.sizeOfSzArray() == 0 ? null :
_ctFont.getSzArray(0);
- if (size != null) {
- double fontHeight = size.getVal();
- return (short)(fontHeight*20);
- }
- return (short)(DEFAULT_FONT_SIZE*20);
+ return (short)(getFontHeightRaw()*20);
}
/**
+ * Get the font height in points.
+ * <p>
+ * This will return the same font height that is shown in Excel,
+ * such as 10 or 14 or 28.
+ * @return short - height in the familiar unit of measure - points
* @see #getFontHeight()
*/
public short getFontHeightInPoints() {
- return (short)(getFontHeight()/20);
+ return (short)getFontHeightRaw();
+ }
+
+ /**
+ * Return the raw font height, in points, but also
+ * including fractions.
+ */
+ private double getFontHeightRaw() {
+ CTFontSize size = _ctFont.sizeOfSzArray() == 0 ? null :
_ctFont.getSzArray(0);
+ if (size != null) {
+ double fontHeight = size.getVal();
+ return fontHeight;
+ }
+ return DEFAULT_FONT_SIZE;
}
/**
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
