Apache
/
poi
mirror of https://github.com/apache/poi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

#58220 - Improve the javadocs for XSSFFont and Font getFontHeight methods 

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1695528 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Nick Burch 2015-08-12 14:14:12 +00:00
parent ef47d1833d
commit e7886797e8
2 changed files with 38 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/java/org/apache/poi/ss/usermodel/Font.java
View File

@ -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();
/**

38
src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFFont.java
View File

@ -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;
}
/**