improved javadoc on Picture.resize()

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@892839 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Yegor Kozlov 2009-12-21 14:51:39 +00:00
parent 804c3e9d4f
commit 3969ed7e8f
5 changed files with 36 additions and 1 deletions

View File

@ -34,6 +34,7 @@
<changes>
<release version="3.7-SNAPSHOT" date="2010-??-??">
<action dev="POI-DEVELOPERS" type="fix">48415 - improved javadoc on HSSPicture.resize() </action>
<action dev="POI-DEVELOPERS" type="add">added Ant target to install artifacts in local repository </action>
<action dev="POI-DEVELOPERS" type="fix">48026 - fixed PageSettingsBlock to allow multiple HeaderFooterRecord records </action>
<action dev="POI-DEVELOPERS" type="fix">48202 - fixed CellRangeUtil.mergeCellRanges to work for adjacent cell regions </action>

View File

@ -294,7 +294,7 @@ public final class BiffViewer {
boolean noint = false;
boolean out = false;
boolean rawhex = false;
boolean header = false;
boolean header = true;
File file = null;
for (int i=0; i<nArgs; i++) {
String arg = args[i];

View File

@ -78,6 +78,11 @@ public final class HSSFPicture extends HSSFSimpleShape implements Picture {
/**
* Resize the image
* <p>
* Please note, that this method works correctly only for workbooks
* with default font size (Arial 10pt for .xls).
* If the default font is changed the resized image can be streched vertically or horizontally.
* </p>
*
* @param scale the amount by which image dimensions are multiplied relative to the original size.
* <code>resize(1.0)</code> sets the original size, <code>resize(0.5)</code> resize to 50% of the original,
@ -103,6 +108,12 @@ public final class HSSFPicture extends HSSFSimpleShape implements Picture {
/**
* Reset the image to the original size.
*
* <p>
* Please note, that this method works correctly only for workbooks
* with default font size (Arial 10pt for .xls).
* If the default font is changed the resized image can be streched vertically or horizontally.
* </p>
*/
public void resize(){
resize(1.0);

View File

@ -25,12 +25,24 @@ public interface Picture {
/**
* Reset the image to the original size.
*
* <p>
* Please note, that this method works correctly only for workbooks
* with default font size (Arial 10pt for .xls and Calibri 11pt for .xlsx).
* If the default font is changed the resized image can be streched vertically or horizontally.
* </p>
*/
void resize();
/**
* Reset the image to the original size.
*
* <p>
* Please note, that this method works correctly only for workbooks
* with default font size (Arial 10pt for .xls and Calibri 11pt for .xlsx).
* If the default font is changed the resize() procedure can be 'off'.
* </p>
*
* @param scale the amount by which image dimensions are multiplied relative to the original size.
* <code>resize(1.0)</code> sets the original size, <code>resize(0.5)</code> resize to 50% of the original,
* <code>resize(2.0)</code> resizes to 200% of the original.

View File

@ -149,6 +149,12 @@ public final class XSSFPicture extends XSSFShape implements Picture {
/**
* Reset the image to the original size.
*
* <p>
* Please note, that this method works correctly only for workbooks
* with the default font size (Calibri 11pt for .xlsx).
* If the default font is changed the resized image can be streched vertically or horizontally.
* </p>
*/
public void resize(){
resize(1.0);
@ -156,6 +162,11 @@ public final class XSSFPicture extends XSSFShape implements Picture {
/**
* Reset the image to the original size.
* <p>
* Please note, that this method works correctly only for workbooks
* with the default font size (Calibri 11pt for .xlsx).
* If the default font is changed the resized image can be streched vertically or horizontally.
* </p>
*
* @param scale the amount by which image dimensions are multiplied relative to the original size.
* <code>resize(1.0)</code> sets the original size, <code>resize(0.5)</code> resize to 50% of the original,