blob: e87748773fc6e5f1c0cfa94e9bb767393975ee33 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
package org.openoffice.xmerge.converter.xml.sxc;
import java.io.IOException;
import java.util.ArrayList;
/**
* 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>
*
*/
public abstract class SpreadsheetEncoder {
/**
* Create a new WorkSheet within the WorkBook.
*
* @param sheetName The name of the WorkSheet.
*
* @throws IOException If any I/O error occurs.
*/
public abstract void createWorksheet(String sheetName) throws IOException;
/**
* 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} 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;
/**
* Get 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.
*
* @param columnRows An {@code IntArrayList} of column widths.
*/
public abstract void setColumnRows(ArrayList<ColumnRowInfo> columnRows) throws IOException;
/**
* Set the name definition of this spreadsheet.
*
* @param nd The {@code NameDefinition} to use.
*/
public abstract void setNameDefinition(NameDefinition nd) throws IOException;
/**
* Adds settings to the WorkBook.
*
* @param s The {@code BookSettings} to add.
*/
public abstract void addSettings(BookSettings s) throws IOException;
}
|
