diff options
Diffstat (limited to 'xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/SpreadsheetEncoder.java')
| -rw-r--r-- | xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/SpreadsheetEncoder.java | 58 |
1 files changed, 23 insertions, 35 deletions
diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/SpreadsheetEncoder.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/SpreadsheetEncoder.java index 3b79122f32f6..e87748773fc6 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/SpreadsheetEncoder.java +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/SpreadsheetEncoder.java @@ -22,72 +22,60 @@ import java.io.IOException; import java.util.ArrayList; /** - * <p>This class is a abstract class for encoding an SXC into an - * alternative spreadsheet format.</p> + * This {@code class} is an {@code abstract class} for encoding an SXC into an + * alternative spreadsheet format. * - * <p>TODO - Add appropriate exceptions to each of the methods.</p> + * <p>ToDo - Add appropriate exceptions to each of the methods.</p> * */ public abstract class SpreadsheetEncoder { - /** - * Create a new WorkSheet within the WorkBook. + * Create a new WorkSheet within the WorkBook. * - * @param sheetName The name of the WorkSheet. + * @param sheetName The name of the WorkSheet. * - * @throws IOException If any I/O error occurs. + * @throws IOException If any I/O error occurs. */ public abstract void createWorksheet(String sheetName) throws IOException; - - - - /** - * Add a cell to the current WorkSheet. + * Add a cell to the current WorkSheet. * - * @param row The row number of the cell - * @param column The column number of the cell - * @param fmt The <code>Format</code> object describing the - * appearance of this cell. - * @param cellContents The text or formula of the cell's contents. + * @param row The row number of the cell + * @param column The column number of the cell + * @param fmt The {@code Format} object describing the appearance + * of this cell. + * @param cellContents The text or formula of the cell's contents. */ - public abstract void addCell(int row, int column, - Format fmt, String cellContents) throws IOException; - + public abstract void addCell(int row, int column, Format fmt, + String cellContents) throws IOException; /** - * Get the number of sheets in the WorkBook. + * Get the number of sheets in the WorkBook. * - * @return The number of sheets in the WorkBook. + * @return The number of sheets in the WorkBook. */ public abstract int getNumberOfSheets(); - - - - /** - * Set the width of the columns in the WorkBook. + * Set the width of the columns in the WorkBook. * - * @param columnRows An <code>IntArrayList</code> of column - * widths. + * @param columnRows An {@code IntArrayList} of column widths. */ public abstract void setColumnRows(ArrayList<ColumnRowInfo> columnRows) throws IOException; /** - * Set the name definition of this spreadsheet + * Set the name definition of this spreadsheet. * - * @param nd The <code>NameDefinition</code> to use. + * @param nd The {@code NameDefinition} to use. */ public abstract void setNameDefinition(NameDefinition nd) throws IOException; /** - * Adds settings to the WorkBook. + * Adds settings to the WorkBook. * - * @param s The <code>BookSettings</code> to add. + * @param s The {@code BookSettings} to add. */ public abstract void addSettings(BookSettings s) throws IOException; -} - +}
\ No newline at end of file |