mirror of https://github.com/apache/poi.git
Bugzilla 54070: Patch for typos in comments, javadoc and documentation
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1404642 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
parent
37609e6550
commit
b5b1f94e24
|
@ -70,7 +70,7 @@ workbooks then you need to have the following jars in your path:</p>
|
||||||
<typedef resource="org/apache/poi/ss/excelant/antlib.xml" classpathref="excelant.path" />
|
<typedef resource="org/apache/poi/ss/excelant/antlib.xml" classpathref="excelant.path" />
|
||||||
]]></source>
|
]]></source>
|
||||||
<p>
|
<p>
|
||||||
Where excelant.path referes to the classpath with POI jars.
|
Where excelant.path refers to the classpath with POI jars.
|
||||||
Using this approach the provided extensions will live in the default namespace. Note that the default task/typenames (evaluate, test) may be too generic and should either be explicitly overridden or used with a namespace.
|
Using this approach the provided extensions will live in the default namespace. Note that the default task/typenames (evaluate, test) may be too generic and should either be explicitly overridden or used with a namespace.
|
||||||
</p>
|
</p>
|
||||||
<ul><li>Similar, but assigning a namespace URI:</li></ul>
|
<ul><li>Similar, but assigning a namespace URI:</li></ul>
|
||||||
|
|
|
@ -1437,7 +1437,7 @@ Examples:
|
||||||
CreationHelper createHelper = wb.getCreationHelper();
|
CreationHelper createHelper = wb.getCreationHelper();
|
||||||
|
|
||||||
//cell style for hyperlinks
|
//cell style for hyperlinks
|
||||||
//by default hypelrinks are blue and underlined
|
//by default hyperlinks are blue and underlined
|
||||||
CellStyle hlink_style = wb.createCellStyle();
|
CellStyle hlink_style = wb.createCellStyle();
|
||||||
Font hlink_font = wb.createFont();
|
Font hlink_font = wb.createFont();
|
||||||
hlink_font.setUnderline(Font.U_SINGLE);
|
hlink_font.setUnderline(Font.U_SINGLE);
|
||||||
|
|
|
@ -33,7 +33,7 @@ public class HyperlinkExample {
|
||||||
CreationHelper createHelper = wb.getCreationHelper();
|
CreationHelper createHelper = wb.getCreationHelper();
|
||||||
|
|
||||||
//cell style for hyperlinks
|
//cell style for hyperlinks
|
||||||
//by default hypelrinks are blue and underlined
|
//by default hyperlinks are blue and underlined
|
||||||
CellStyle hlink_style = wb.createCellStyle();
|
CellStyle hlink_style = wb.createCellStyle();
|
||||||
Font hlink_font = wb.createFont();
|
Font hlink_font = wb.createFont();
|
||||||
hlink_font.setUnderline(Font.U_SINGLE);
|
hlink_font.setUnderline(Font.U_SINGLE);
|
||||||
|
|
|
@ -21,7 +21,7 @@ package org.apache.poi.common.usermodel;
|
||||||
*/
|
*/
|
||||||
public interface Hyperlink {
|
public interface Hyperlink {
|
||||||
/**
|
/**
|
||||||
* Link to a existing file or web page
|
* Link to an existing file or web page
|
||||||
*/
|
*/
|
||||||
public static final int LINK_URL = 1;
|
public static final int LINK_URL = 1;
|
||||||
|
|
||||||
|
@ -42,14 +42,14 @@ public interface Hyperlink {
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Hypelink address. Depending on the hyperlink type it can be URL, e-mail, patrh to a file, etc.
|
* Hyperlink address. Depending on the hyperlink type it can be URL, e-mail, path to a file, etc.
|
||||||
*
|
*
|
||||||
* @return the address of this hyperlink
|
* @return the address of this hyperlink
|
||||||
*/
|
*/
|
||||||
public String getAddress();
|
public String getAddress();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Hypelink address. Depending on the hyperlink type it can be URL, e-mail, patrh to a file, etc.
|
* Hyperlink address. Depending on the hyperlink type it can be URL, e-mail, path to a file, etc.
|
||||||
*
|
*
|
||||||
* @param address the address of this hyperlink
|
* @param address the address of this hyperlink
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -27,7 +27,7 @@ import org.apache.poi.ss.usermodel.Hyperlink;
|
||||||
public class HSSFHyperlink implements Hyperlink {
|
public class HSSFHyperlink implements Hyperlink {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Link to a existing file or web page
|
* Link to an existing file or web page
|
||||||
*/
|
*/
|
||||||
public static final int LINK_URL = 1;
|
public static final int LINK_URL = 1;
|
||||||
|
|
||||||
|
@ -52,7 +52,7 @@ public class HSSFHyperlink implements Hyperlink {
|
||||||
protected HyperlinkRecord record = null;
|
protected HyperlinkRecord record = null;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* If we create a new hypelrink remember its type
|
* If we create a new hyperlink remember its type
|
||||||
*/
|
*/
|
||||||
protected int link_type;
|
protected int link_type;
|
||||||
|
|
||||||
|
@ -176,7 +176,7 @@ public class HSSFHyperlink implements Hyperlink {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Hypelink address. Depending on the hyperlink type it can be URL, e-mail, path to a file, etc.
|
* Hyperlink address. Depending on the hyperlink type it can be URL, e-mail, path to a file, etc.
|
||||||
*
|
*
|
||||||
* @return the address of this hyperlink
|
* @return the address of this hyperlink
|
||||||
*/
|
*/
|
||||||
|
@ -190,7 +190,7 @@ public class HSSFHyperlink implements Hyperlink {
|
||||||
/**
|
/**
|
||||||
* Convenience method equivalent to {@link #setAddress(String)}
|
* Convenience method equivalent to {@link #setAddress(String)}
|
||||||
*
|
*
|
||||||
* @param textMark the place in worksheet this hypelrink referes to, e.g. 'Target Sheet'!A1'
|
* @param textMark the place in worksheet this hyperlink refers to, e.g. 'Target Sheet'!A1'
|
||||||
*/
|
*/
|
||||||
public void setTextMark(String textMark) {
|
public void setTextMark(String textMark) {
|
||||||
record.setTextMark(textMark);
|
record.setTextMark(textMark);
|
||||||
|
@ -201,14 +201,14 @@ public class HSSFHyperlink implements Hyperlink {
|
||||||
/**
|
/**
|
||||||
* Convenience method equivalent to {@link #setAddress(String)}
|
* Convenience method equivalent to {@link #setAddress(String)}
|
||||||
*
|
*
|
||||||
* @param shortFilename the path to a file this hypelrink points to, e.g. 'readme.txt'
|
* @param shortFilename the path to a file this hyperlink points to, e.g. 'readme.txt'
|
||||||
*/
|
*/
|
||||||
public void setShortFilename(String shortFilename) {
|
public void setShortFilename(String shortFilename) {
|
||||||
record.setShortFilename(shortFilename);
|
record.setShortFilename(shortFilename);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Hypelink address. Depending on the hyperlink type it can be URL, e-mail, patrh to a file, etc.
|
* Hyperlink address. Depending on the hyperlink type it can be URL, e-mail, path to a file, etc.
|
||||||
*
|
*
|
||||||
* @param address the address of this hyperlink
|
* @param address the address of this hyperlink
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -906,9 +906,9 @@ public final class XSSFCell implements Cell {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Assign a hypelrink to this cell
|
* Assign a hyperlink to this cell
|
||||||
*
|
*
|
||||||
* @param hyperlink the hypelrink to associate with this cell
|
* @param hyperlink the hyperlink to associate with this cell
|
||||||
*/
|
*/
|
||||||
public void setHyperlink(Hyperlink hyperlink) {
|
public void setHyperlink(Hyperlink hyperlink) {
|
||||||
XSSFHyperlink link = (XSSFHyperlink)hyperlink;
|
XSSFHyperlink link = (XSSFHyperlink)hyperlink;
|
||||||
|
|
|
@ -139,7 +139,7 @@ public class XSSFHyperlink implements Hyperlink {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Hypelink address. Depending on the hyperlink type it can be URL, e-mail, path to a file
|
* Hyperlink address. Depending on the hyperlink type it can be URL, e-mail, path to a file
|
||||||
*
|
*
|
||||||
* @return the address of this hyperlink
|
* @return the address of this hyperlink
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -20,7 +20,7 @@
|
||||||
<record id="0x1051" name="LinkedData" excel-record-id="AI" package="org.apache.poi.hssf.record">
|
<record id="0x1051" name="LinkedData" excel-record-id="AI" package="org.apache.poi.hssf.record">
|
||||||
<suffix>Record</suffix>
|
<suffix>Record</suffix>
|
||||||
<extends>Record</extends>
|
<extends>Record</extends>
|
||||||
<description>Describes a linked data record. This record referes to the series data or text.</description>
|
<description>Describes a linked data record. This record refers to the series data or text.</description>
|
||||||
<author>Glen Stampoultzis (glens at apache.org)</author>
|
<author>Glen Stampoultzis (glens at apache.org)</author>
|
||||||
<fields>
|
<fields>
|
||||||
<field type="int" size="1" name="link type" description="What type of link is this?">
|
<field type="int" size="1" name="link type" description="What type of link is this?">
|
||||||
|
|
|
@ -119,7 +119,7 @@ public class Picture extends SimpleShape {
|
||||||
/**
|
/**
|
||||||
* Create a new Picture and populate the inital structure of the <code>EscherSp</code> record which holds information about this picture.
|
* Create a new Picture and populate the inital structure of the <code>EscherSp</code> record which holds information about this picture.
|
||||||
|
|
||||||
* @param idx the index of the picture which referes to <code>EscherBSE</code> container.
|
* @param idx the index of the picture which refers to <code>EscherBSE</code> container.
|
||||||
* @return the create Picture object
|
* @return the create Picture object
|
||||||
*/
|
*/
|
||||||
protected EscherContainerRecord createSpContainer(int idx, boolean isChild) {
|
protected EscherContainerRecord createSpContainer(int idx, boolean isChild) {
|
||||||
|
|
|
@ -223,13 +223,13 @@ public final class TestHSSFHyperlink extends BaseTestHyperlink {
|
||||||
assertNull(sheet.getRow(2).getCell(0).getHyperlink());
|
assertNull(sheet.getRow(2).getCell(0).getHyperlink());
|
||||||
assertNull(sheet.getRow(3).getCell(0).getHyperlink());
|
assertNull(sheet.getRow(3).getCell(0).getHyperlink());
|
||||||
|
|
||||||
//the first hypelink now belongs to A5
|
//the first hyperlink now belongs to A5
|
||||||
HSSFHyperlink link1_shifted = sheet.getRow(2+2).getCell(0).getHyperlink();
|
HSSFHyperlink link1_shifted = sheet.getRow(2+2).getCell(0).getHyperlink();
|
||||||
assertNotNull(link1_shifted);
|
assertNotNull(link1_shifted);
|
||||||
assertEquals(4, link1_shifted.getFirstRow());
|
assertEquals(4, link1_shifted.getFirstRow());
|
||||||
assertEquals(4, link1_shifted.getLastRow());
|
assertEquals(4, link1_shifted.getLastRow());
|
||||||
|
|
||||||
//the second hypelink now belongs to A6
|
//the second hyperlink now belongs to A6
|
||||||
HSSFHyperlink link2_shifted = sheet.getRow(3+2).getCell(0).getHyperlink();
|
HSSFHyperlink link2_shifted = sheet.getRow(3+2).getCell(0).getHyperlink();
|
||||||
assertNotNull(link2_shifted);
|
assertNotNull(link2_shifted);
|
||||||
assertEquals(5, link2_shifted.getFirstRow());
|
assertEquals(5, link2_shifted.getFirstRow());
|
||||||
|
|
Loading…
Reference in New Issue