/**
* Creates a new font for a specific cell style
- *
- * @param wb Description of the Parameter
- * @param style Description of the Parameter
- * @return Description of the Return Value
*/
public static Font makeFont(HSSFFont font) {
boolean isbold = font.getBoldweight() > HSSFFont.BOLDWEIGHT_NORMAL;
* a listener supporting this interface and register it with the HSSFRequest (associating
* it with Record SID's).
*
- * @see org.apache.poi.hssf.eventusermodel.HSSFEventFactory
- * @see org.apache.poi.hssf.eventusermodel.HSSFRequest
- * @see org.apache.poi.hssf.HSSFUserException
+ * @see HSSFEventFactory
+ * @see HSSFRequest
+ * @see AbortableHSSFListener
*
* @author Carey Sublette (careysub@earthling.net)
*
* 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.HSSFRequest
* @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)
*/
/**
* Year of the build that wrote this file
* @see #BUILD_YEAR
- * @param build year to set
+ * @param year year to set
*/
public void setBuildYear(short year)
* set the codepage for this workbook
*
* @see #CODEPAGE
- * @param 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.
+ * @param pattern true if this XF has a different pattern value than its parent,
+ * false 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,
- * false otherwise.
+ * @param options true if this XF has a different locking or hidden value than its parent,
+ * false otherwise.
* @see #setIndentionOptions(short)
*/
* 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
- * 0x40, then no modification is made
+ * @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 specifies whether the first row is relative or not
*/
public void setFirstRowRelative( boolean rel )
{
/**
* set whether the last row is relative or not
- * @param last row relative
+ * @param rel specifies whether the last row is relative
*/
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 specifies whether the last row is relative or not
*/
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
*/
public String toFormulaString(Workbook book)
{
- return this.GREATERTHAN;
+ return GreaterThanPtg.GREATERTHAN;
}
/**
/**
* Implementation of method from Ptg
- * @param refs the Sheet References
*/
public String toFormulaString(Workbook book)
{
- return this.LESSTHAN;
+ return LessThanPtg.LESSTHAN;
}
/**
public abstract class Ptg
{
-
- /** convert infix order ptg list to rpn order ptg list
- * @return List ptgs in RPN order
- * @param infixPtgs List of ptgs in infix order
- */
/* DO NOT REMOVE
*we keep this method in case we wish to change the way we parse
*It needs a getPrecedence in OperationsPtg
+ /** convert infix order ptg list to rpn order ptg list
+ * @return List ptgs in RPN order
+ * @param infixPtgs List of ptgs in infix order
+ */
+ /*
public static List ptgsToRpn(List infixPtgs) {
java.util.Stack operands = new java.util.Stack();
java.util.List retval = new java.util.Stack();
/**
* set the name for the font (i.e. Arial)
- * @param String representing the name of the font to use
+ * @param name the name of the font to use
* @see #FONT_ARIAL
*/
/**
* set whether to use italics or not
- * @param italics or not
+ * @param italic use italics or not
*/
public void setItalic(boolean italic)
/**
* set type of text underlining to use
- * @param underlining type
+ * @param underline the underlining type to use
* @see #U_NONE
* @see #U_SINGLE
* @see #U_DOUBLE
*
* @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)
* set the sheet name.
* Will throw IllegalArgumentException if the name is greater than 31 chars
* or contains /\?*[]
- * @param sheet number (0 based)
- * @param sheet name
+ * @param sheet sheet number (0 based)
+ * @param name sheet name
*/
public void setSheetName(int sheet, String name)
* <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
+ *
+ * @since 2002-01-24
*/
public POIFSDocumentPath getParent()
* <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()
/**
* Set the start block for this instance
*
- * @param index index into the array of BigBlock instances making
- * up the the filesystem
- *
* @param start_block
*/
/**
* Set the start block for this instance
*
- * @param index index into the array of BigBlock instances making
- * up the the filesystem
- *
* @param start_block
*/
* Check if a logger is enabled to log at the specified level
*
* @param level One of DEBUG, INFO, WARN, ERROR, FATAL
- * @param obj1 The logger to check.
*/
public boolean check(final int level)
* Check if a logger is enabled to log at the specified level
*
* @param level One of DEBUG, INFO, WARN, ERROR, FATAL
- * @param obj1 The logger to check.
*/
public boolean check(final int level)
* Check if a logger is enabled to log at the specified level
*
* @param level One of DEBUG, INFO, WARN, ERROR, FATAL
- * @param obj1 The logger to check.
*/
abstract public boolean check(final int level);
*@param offset the initial offset into the
* byte array. it is assumed that string[ offset ] and string[ offset +
* 1 ] contain the first 16-bit unicode character
- *@param len
+ *@param len the length of the final string
*@return the converted string
*@exception ArrayIndexOutOfBoundsException if offset is out of bounds for
* the byte array (i.e., is negative or is greater than or equal to
*@exception IllegalArgumentException if len is too large (i.e.,
* there is not enough data in string to create a String of that
* length)
- *@param len the length of the final string
*/
public static String getFromUnicodeLE(
final byte[] string,
**@param offset the initial offset into the
* byte array. it is assumed that string[ offset ] and string[ offset +
* 1 ] contain the first 16-bit unicode character
- *@param len
+ *@param len the length of the final string
*@return the converted string
*@exception ArrayIndexOutOfBoundsException if offset is out of bounds for
* the byte array (i.e., is negative or is greater than or equal to
*@exception IllegalArgumentException if len is too large (i.e.,
* there is not enough data in string to create a String of that
* length)
- *@param len the length of the final string
*/
public static String getFromUnicodeBE(
final byte[] string,
/**
* 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)
{
/**
* Creates a PAPFormattedDiskPage from a 512 byte array
- *
- * @param fkp a 512 byte array.
*/
public PAPFormattedDiskPage(byte[] documentStream, 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.
*/
public PropertyNode(int fcStart, int fcEnd, Object buf)
{
}
/**
- * @retrun The offset of the end of this property's text.
+ * @return The offset of the end of this property's text.
*/
public int getEnd()
{
/**
* StyleSheet constructor. Loads a document's stylesheet information,
- *
- * @param styleSheet A byte array containing a document's raw stylesheet
- * info. Found by using FileInformationBlock.getFcStshf() and
- * FileInformationBLock.getLcbStshf()
*/
public StyleSheet(byte[] tableStream, int offset)
{
/**
* @param start Offset in main document stream.
- * @param length The total length of the text in bytes. Note: 1 character
- * does not necessarily refer to 1 byte.
- * @param unicode true if this text is unicode.
*/
public TextPiece(int start, int end, byte[] text, PieceDescriptor pd)
throws UnsupportedEncodingException
projects / poi.git / commitdiff