<li><a href="http://jakarta.apache.org/poi">Jakarta POI Project</a>
</ul>
-<!-- Put @see and @since tags down here. -->
-@see org.apache.poi.hssf
</body>
</html>
* a listener supporting this interface and register it with the HSSFRequest (associating
* it with Record SID's).
*
- * @see org.apache.poi.hssf.eventmodel.HSSFEventFactory
- * @see org.apache.poi.hssf.eventmodel.HSSFRequest
- * @see org.apache.poi.hssf.HSSFUserException
+ * @see org.apache.poi.hssf.eventusermodel.HSSFEventFactory
+ * @see org.apache.poi.hssf.eventusermodel.HSSFRequest
+ * @see org.apache.poi.hssf.eventusermodel.HSSFUserException
*
* @author Carey Sublette (careysub@earthling.net)
*
* @see org.apache.poi.poifs.filesystem.POIFSFileSystem#createDocumentInputStream(String)
* @param req an Instance of HSSFRequest which has your registered listeners
* @param in a DocumentInputStream obtained from POIFS's POIFSFileSystem object
- * @param in a DocumentInputStream obtained from POIFS's POIFSFileSystem object
* @return numeric user-specified result code.
*/
* a listener supporting this interface and register it with the HSSFRequest (associating
* it with Record SID's).
*
- * @see org.apache.poi.hssf.eventmodel.HSSFEventFactory
- * @see org.apache.poi.hssf.eventmodel.HSSFRequest
+ * @see org.apache.poi.hssf.eventusermodel.HSSFEventFactory
+ * @see org.apache.poi.hssf.eventusermodel.HSSFRequest
* @author acoliver@apache.org
*/
* An HSSFRequest object should be constructed registering an instance or multiple
* instances of HSSFListener with each Record.sid you wish to listen for.
*
- * @see org.apache.poi.hssf.eventmodel.HSSFEventFactory
- * @see org.apache.poi.hssf.eventmodel.HSSFListener
+ * @see org.apache.poi.hssf.eventusermodel.HSSFEventFactory
+ * @see org.apache.poi.hssf.eventusermodel.HSSFListener
* @see org.apache.poi.hssf.dev.EFHSSF
- * @see org.apache.poi.hssf.HSSFUserException
+ * @see org.apache.poi.hssf.eventusermodel.HSSFUserException
* @author Andrew C. Oliver (acoliver at apache dot org)
* @author Carey Sublette (careysub@earthling.net)
*/
import org.apache.poi.hssf.record.aggregates.ValueRecordsAggregate;
import org.apache.poi.hssf.record.aggregates.ColumnInfoRecordsAggregate;
import org.apache.poi.hssf.record.formula.Ptg;
-import org.apache.poi.util.IntList;
import org.apache.poi.util.POILogFactory;
import org.apache.poi.util.POILogger;
/**
* Returns all the row page breaks
- * @return
+ * @return all the row page breaks
*/
public Iterator getRowBreaks() {
return rowBreaks.getBreaksIterator();
/**
* Returns the number of row page breaks
- * @return
+ * @return the number of row page breaks
*/
public int getNumRowBreaks(){
return (int)rowBreaks.getNumBreaks();
/**
* Returns all the column page breaks
- * @return
+ * @return all the column page breaks
*/
public Iterator getColumnBreaks(){
return colBreaks.getBreaksIterator();
/**
* Returns the number of column page breaks
- * @return
+ * @return the number of column page breaks
*/
public int getNumColumnBreaks(){
return (int)colBreaks.getNumBreaks();
/**
* Version number - for BIFF8 should be 0x06
* @see #VERSION
- * @param short version to be set
+ * @param version version to be set
*/
public void setVersion(short version)
* @see #TYPE_CHART
* @see #TYPE_EXCEL_4_MACRO
* @see #TYPE_WORKSPACE_FILE
- * @param short type to be set
+ * @param type type to be set
*/
public void setType(short type)
/**
* build that wrote this file
* @see #BUILD
- * @param short build number to set
+ * @param build build number to set
*/
public void setBuild(short build)
/**
* Year of the build that wrote this file
* @see #BUILD_YEAR
- * @param short build year to set
+ * @param year build year to set
*/
public void setBuildYear(short year)
/**
* set the history bit mask (not very useful)
* @see #HISTORY_MASK
- * @param int bitmask to set for the history
+ * @param bitmask bitmask to set for the history
*/
public void setHistoryBitMask(int bitmask)
* set the minimum version required to read this file
*
* @see #VERSION
- * @param int version to set
+ * @param version version to set
*/
public void setRequiredVersion(int version)
/**
* set the save ext links flag
*
- * @param short flag (0/1 -off/on)
+ * @param flag flag (0/1 -off/on)
*/
public void setSaveLinkValues(short flag)
/**
* Set the sheetname for this sheet. (this appears in the tabs at the bottom)
* @param sheetname the name of the sheet
- * @thows IllegalArgumentException if sheet name will cause excel to crash.
+ * @throws IllegalArgumentException if sheet name will cause excel to crash.
*/
public void setSheetname( String sheetname )
* @param id id must be 0x42 or an exception will be throw upon validation
* @param size the size of the data area of the record
* @param data data of the record (should not contain sid/len)
- * @param int offset of the record
+ * @param offset offset of the record
*/
public CodepageRecord(short id, short size, byte [] data, int offset)
* set the codepage for this workbook
*
* @see #CODEPAGE
- * @param codepage - the codepage to set
+ * @param cp the codepage to set
*/
public void setCodepage(short cp)
}
/**
- * set whether or not to use the pattern in this XF instead of the parent XF.
- * (foregrount/background)
- *
- * @param pattern- true if this XF has a different pattern value than its parent,
- * false otherwise.
+ * <p>Sets whether or not to use the pattern in this XF instead of the
+ * parent XF (foreground/background).</p>
+ *
+ * @param pattern <code>true</code> if this XF has a different pattern
+ * value than its parent,</code> false</code> otherwise.
* @see #setIndentionOptions(short)
*/
* set whether or not to use the locking/hidden in this XF instead of the parent XF.
*
*
- * @param options- true if this XF has a different locking or hidden value than its parent,
+ * @param options true if this XF has a different locking or hidden value than its parent,
* false otherwise.
* @see #setIndentionOptions(short)
*/
import org.apache.poi.util.LittleEndian;
/**
- * Record that contains the functionality page breaks (horizontal and vertical)
- * <p>
- * The other two classes just specifically set the SIDS for record creation
+ * <p>Record that contains the functionality page breaks (horizontal and vertical)</p>
+ *
+ * <p>The other two classes just specifically set the SIDS for record creation.</p>
+ *
+ * <p>REFERENCE: Microsoft Excel SDK page 322 and 420</p>
+ *
* @see HorizontalPageBreakRecord
- * @see VerticalPageBreakREcord
+ * @see VerticalPageBreakRecord
*
- * REFERENCE: Microsoft Excel SDK page 322 and 420
* @author Danny Mui (dmui at apache dot org)
*/
public class PageBreakRecord extends Record {
/**
* Retrieves the region at the row/column indicated
- * @param main
- * @return
+ * @param main FIXME: Document this!
+ * @return FIXME: Document this!
*/
public Break getBreak(short main)
{
* If the given index is greater than the current last color index,
* then black is inserted at every index required to make the palette continuous.
*
- * @param i the index to set; if this index is less than 0x8 or greater than
+ * @param byteIndex the index to set; if this index is less than 0x8 or greater than
* 0x40, then no modification is made
*/
public void setColor(short byteIndex, byte red, byte green, byte blue)
/**
* sets the first row to relative or not
- * @param isRelative or not.
+ * @param rel FIXME: Document this!
*/
public void setFirstRowRelative( boolean rel )
{
/**
* set whether the last row is relative or not
- * @param last row relative
+ * @param rel FIXME: Document this!
*/
public void setLastRowRelative( boolean rel )
{
}
/**
- * @param last row number in the area
+ * @param row last row number in the area
*/
public void setLastRow(short row)
{
/**
* set whether the last row is relative or not
- * @param last row relative
+ * @param rel <code>true</code> if the last row relative, else
+ * <code>false</code>
*/
public void setLastRowRelative(boolean rel) {
field_4_last_column=rowRelative.setShortBoolean(field_4_last_column,rel);
/**
* Implementation of method from Ptg
- * @param refs the Sheet References
+ * @param book the Sheet References
*/
public String toFormulaString(Workbook book)
{
/**
* Implementation of method from Ptg
- * @param refs the Sheet References
+ * @param book the Sheet References
*/
public String toFormulaString(Workbook book)
{
{
- /** convert infix order ptg list to rpn order ptg list
+ /* convert infix order ptg list to rpn order ptg list
* @return List ptgs in RPN order
* @param infixPtgs List of ptgs in infix order
*/
this.verticalPixelsPerPoint = 1 / verticalPointsPerPixel;
}
- /**
- * Constructs an escher graphics object.
- *
- * @param escherGroup The escher group to write the graphics calls into.
- * @param workbook The workbook we are using.
- * @param forecolor The default foreground color.
- */
+// /**
+// * Constructs an escher graphics object.
+// *
+// * @param escherGroup The escher group to write the graphics calls into.
+// * @param workbook The workbook we are using.
+// * @param forecolor The default foreground color.
+// */
// public EscherGraphics( HSSFShapeGroup escherGroup, HSSFWorkbook workbook, Color forecolor)
// {
// this(escherGroup, workbook, forecolor, 1.0f);
/**
* set the font height in unit's of 1/20th of a point. Maybe you might want to
* use the setFontHeightInPoints which matches to the familiar 10, 12, 14 etc..
- * @param short - height in 1/20ths of a point
+ * @param height height in 1/20ths of a point
* @see #setFontHeightInPoints(short)
*/
/**
* set the font height
- * @param short - height in the familiar unit of measure - points
+ * @param height height in the familiar unit of measure - points
* @see #setFontHeight(short)
*/
/**
* set whether to use italics or not
- * @param italics or not
+ * @param italic italics or not
*/
public void setItalic(boolean italic)
/**
* Sets the left string.
- * @newLeft The string to set as the left side.
+ * @param newLeft The string to set as the left side.
*/
public void setLeft(String newLeft) {
left = newLeft;
/**
* Sets the center string.
- * @newLeft The string to set as the center.
+ * @param newCenter The string to set as the center.
*/
public void setCenter(String newCenter) {
center = newCenter;
/**
* Sets the right string.
- * @newLeft The string to set as the right side.
+ * @param newRight The string to set as the right side.
*/
public void setRight(String newRight) {
right = newRight;
*
* @see org.apache.poi.hssf.usermodel.HSSFWorkbook#createName()
* @param name the Name Record
- * @param book - lowlevel Workbook object associated with the sheet.
- * @param book the Workbook */
+ * @param book lowlevel Workbook object associated with the sheet.
+ */
protected HSSFName(Workbook book, NameRecord name) {
this.book = book;
* @param book low-level Workbook object containing the sheet that contains this row
* @param sheet low-level Sheet object that contains this Row
* @param rowNum the row number of this row (0 based)
- * @see org.apache.poi.hssf.usermodel.HSSFSheet#createRow(short)
+ * @see org.apache.poi.hssf.usermodel.HSSFSheet#createRow(int)
*/
//protected HSSFRow(Workbook book, Sheet sheet, short rowNum)
* @param book low-level Workbook object containing the sheet that contains this row
* @param sheet low-level Sheet object that contains this Row
* @param record the low level api object this row should represent
- * @see org.apache.poi.hssf.usermodel.HSSFSheet#createRow(short)
+ * @see org.apache.poi.hssf.usermodel.HSSFSheet#createRow(int)
*/
protected HSSFRow(Workbook book, Sheet sheet, RowRecord record)
/**
* Sets a page break at the indicated row
- * @param row
+ * @param row FIXME: Document this!
*/
public void setRowBreak(int row) {
validateRow(row);
/**
* Determines if there is a page break at the indicated row
- * @param row
- * @return
+ * @param row FIXME: Document this!
+ * @return FIXME: Document this!
*/
public boolean isRowBroken(int row) {
return sheet.isRowBroken(row);
/**
* Retrieves all the horizontal page breaks
- * @return
+ * @return all the horizontal page breaks
*/
public int[] getRowBreaks(){
//we can probably cache this information, but this should be a sparsely used function
/**
* Retrieves all the vertical page breaks
- * @return
+ * @return all the vertical page breaks
*/
public short[] getColumnBreaks(){
//we can probably cache this information, but this should be a sparsely used function
/**
* Determines if there is a page break at the indicated column
- * @param column
- * @return
+ * @param column FIXME: Document this!
+ * @return FIXME: Document this!
*/
public boolean isColumnBroken(short column) {
return sheet.isColumnBroken(column);
* Will throw IllegalArgumentException if the name is greater than 31 chars
* or contains /\?*[]
* @param sheet number (0 based)
- * @param sheet name
*/
public void setSheetName(int sheet, String name)
{
/**
* For the Convenience of Java Programmers maintaining pointers.
- * @see setPrintArea(int, String)
+ * @see #setPrintArea(int, String)
* @param sheetIndex Zero-based sheet index (0 = First Sheet)
* @param startColumn Column to begin printarea
* @param endColumn Column to end the printarea
<li><a href="http://jakarta.apache.org/poi">Jakarta POI Project</a>
</ul>
-<!-- Put @see and @since tags down here. -->
-@see org.apache.poi.hssf
-@see org.apache.poi.hssf.eventmodel
</body>
</html>
/**
* Answers: "is the row/column inside this range?"
*
- * @returns boolean - true if the cell is in the range and false if it is not
+ * @return <code>true</code> if the cell is in the range and
+ * <code>false</code> if it is not
*/
public boolean contains(int row, short col)
}
/**
- * @returns the area contained by this region (number of cells)
+ * @return the area contained by this region (number of cells)
*/
public int getArea()
<li><a href="http://jakarta.apache.org/poi">Jakarta POI Project</a>
</ul>
-<!-- Put @see and @since tags down here. -->
-@see org.apache.poi.usermodel
</body>
</html>
<li><a href="http://jakarta.apache.org/poi">Jakarta POI Project</a>
</ul>
-<!-- Put @see and @since tags down here. -->
-@see org.apache.poi.hssf
-@see org.apache.poi.hpsf
</body>
</html>
<li><a href="http://jakarta.apache.org/poi">Jakarta POI Project</a>
</ul>
-<!-- Put @see and @since tags down here. -->
-@see org.apache.poi.poifs
</body>
</html>
* <p>Returns the path's parent or <code>null</code> if this path
* is the root path.</p>
*
- * @author Rainer Klute (klute@rainer-klute.de)
* @since 2002-01-24
* @return path of parent, or null if this path is the root path
*/
* <p>Returns a string representation of the path. Components are
* separated by the platform-specific file separator.</p>
*
- * @author Rainer Klute (klute@rainer-klute.de)
- * @since 2002-01-24
- *
* @return string representation
+ *
+ * @since 2002-01-24
*/
public String toString()
<li><a href="http://jakarta.apache.org/poi">Jakarta POI Project</a>
</ul>
-<!-- Put @see and @since tags down here. -->
-@see org.apache.poi.poifs
-@see org.apache.poi.poifs.filesystem
</body>
</html>
<li><a href="http://jakarta.apache.org/poi">Jakarta POI Project</a>
</ul>
-<!-- Put @see and @since tags down here. -->
-@see org.apache.poi.hssf
-@see org.apache.poi.hpsf
</body>
</html>
/**
* Returns the character length of a document.
- * @return
+ * @return the character length of a document
*/
public int characterLength()
{
/**
* This constructs a CHPFormattedDiskPage from a raw fkp (512 byte array
* read from a Word file).
- *
- * @param fkp The 512 byte array to read data from
*/
public CHPFormattedDiskPage(byte[] documentStream, int offset, int fcMin)
{
import org.apache.poi.util.LittleEndian;
-import org.apache.poi.hwpf.model.io.HWPFOutputStream;
-
public class FIBLongHandler
{
public static final int CBMAC = 0;
/**
* Refers to a 32 bit windows "long" same as a Java int
- * @param longCode
- * @return
+ * @param longCode FIXME: Document this!
+ * @return FIXME: Document this!
*/
public int getLong(int longCode)
{
/**
* Creates a PAPFormattedDiskPage from a 512 byte array
- *
- * @param fkp a 512 byte array.
*/
public PAPFormattedDiskPage(byte[] documentStream, byte[] dataStream, int offset, int fcMin)
{
/**
* @param fcStart The start of the text for this property.
* @param fcEnd The end of the text for this property.
- * @param grpprl The property description in compressed form.
+ * @param buf FIXME: Old documentation is: "grpprl The property description in compressed form."
*/
protected PropertyNode(int fcStart, int fcEnd, Object buf)
{
/**
* StyleSheet constructor. Loads a document's stylesheet information,
*
- * @param styleSheet A byte array containing a document's raw stylesheet
+ * @param tableStream A byte array containing a document's raw stylesheet
* info. Found by using FileInformationBlock.getFcStshf() and
* FileInformationBLock.getLcbStshf()
*/
projects / poi.git / commitdiff