Package org.openl.rules.table.xls

Class XlsSheetGridModel

java.lang.Object

org.openl.rules.table.AGrid

org.openl.rules.table.xls.XlsSheetGridModel

All Implemented Interfaces:

IGrid, IWritableGrid

public class XlsSheetGridModel
extends AGrid
implements IWritableGrid

Author:

snshor

Field Summary

Fields inherited from class org.openl.rules.table.AGrid

RANGE_SEPARATOR

Fields inherited from interface org.openl.rules.table.IGrid

CELL_TYPE_BLANK, CELL_TYPE_BOOLEAN, CELL_TYPE_ERROR, CELL_TYPE_FORMULA, CELL_TYPE_NUMERIC, CELL_TYPE_STRING

Constructor Summary

Constructors

Constructor	Description
XlsSheetGridModel(XlsSheetSourceCodeModule sheetSource)

Method Summary

Modifier and Type	Method	Description
int	addMergedRegion(IGridRegion reg)
void	clearCell(int col, int row)
void	clearCellValue(int col, int row)
void	copyCell(int colFrom, int rowFrom, int colTo, int rowTo)
void	createCell(int col, int row, Object value, String formula, ICellStyle style, String comment, String prevCommentAuthor)
IGridRegion	findEmptyRect(int width, int height)	Finds a rectangular area of given width and height on the grid that can be used for writing.
ICell	getCell(int column, int row)
AXlsCellWriter	getCellWriter(Object value)
int	getColumnWidth(int col)
int	getMaxColumnIndex(int rownum)
int	getMaxRowIndex()
IGridRegion	getMergedRegion(int i)
int	getMinColumnIndex(int rownum)
int	getMinRowIndex()
String	getName()
int	getNumberOfMergedRegions()
String	getRangeUri(IGridRegion region)	Gets the URI to the table by table region.
IGridRegion	getRegionContaining(int x, int y)
XlsSheetSourceCodeModule	getSheetSource()
SpreadsheetConstants	getSpreadsheetConstants()
String	getUri()
boolean	isEmpty(int x, int y)
void	removeMergedRegion(int x, int y)
void	removeMergedRegion(IGridRegion remove)
void	setCellAlignment(int col, int row, org.apache.poi.ss.usermodel.HorizontalAlignment alignment)
void	setCellBorderStyle(int col, int row, ICellStyle style)
void	setCellComment(int col, int row, String comment, String prevCommentAuthor)
void	setCellFillColor(int col, int row, short[] color)
void	setCellFontBold(int col, int row, boolean bold)
void	setCellFontColor(int col, int row, short[] color)
void	setCellFontItalic(int col, int row, boolean italic)
void	setCellFontUnderline(int col, int row, boolean underlined)
void	setCellFormula(int col, int row, String formula)
void	setCellIndent(int col, int row, int indent)
void	setCellStringValue(int col, int row, String value)
void	setCellStyle(int col, int row, ICellStyle style)
void	setCellValue(int col, int row, Object value)

Methods inherited from class org.openl.rules.table.AGrid

getRangeUri, getRegionStartingAt, getTables, isInOneMergedRegion, isPartOfTheMergedRegion, isTopLeftCellInMergedRegion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openl.rules.table.IGrid

getRangeUri, getRegionStartingAt, getTables, isInOneMergedRegion, isPartOfTheMergedRegion, isTopLeftCellInMergedRegion

Constructor Detail

XlsSheetGridModel

public XlsSheetGridModel(XlsSheetSourceCodeModule sheetSource)

Method Detail

addMergedRegion

public int addMergedRegion(IGridRegion reg)

Specified by:

addMergedRegion in interface IWritableGrid

clearCellValue

public void clearCellValue(int col,
                           int row)

clearCell

public void clearCell(int col,
                      int row)

Specified by:

clearCell in interface IWritableGrid

copyCell

public void copyCell(int colFrom,
                     int rowFrom,
                     int colTo,
                     int rowTo)

Specified by:

copyCell in interface IWritableGrid

createCell

public void createCell(int col,
                       int row,
                       Object value,
                       String formula,
                       ICellStyle style,
                       String comment,
                       String prevCommentAuthor)

Specified by:

createCell in interface IWritableGrid

findEmptyRect

public IGridRegion findEmptyRect(int width,
                                 int height)

Description copied from interface: IWritableGrid

Finds a rectangular area of given width and height on the grid that can be used for writing. The returned region should not intersect with or touch existing not empty cells.

Specified by:

findEmptyRect in interface IWritableGrid

Parameters:

width - rectangle width

height - rectangle height

Returns:

region representing required rectangle or null if not found

getCell

public ICell getCell(int column,
                     int row)

Specified by:

getCell in interface IGrid

getColumnWidth

public int getColumnWidth(int col)

Specified by:

getColumnWidth in interface IGrid

getMaxColumnIndex

public int getMaxColumnIndex(int rownum)

Specified by:

getMaxColumnIndex in interface IGrid

getMaxRowIndex

public int getMaxRowIndex()

Specified by:

getMaxRowIndex in interface IGrid

getMergedRegion

public IGridRegion getMergedRegion(int i)

Specified by:

getMergedRegion in interface IGrid

getMinColumnIndex

public int getMinColumnIndex(int rownum)

Specified by:

getMinColumnIndex in interface IGrid

getMinRowIndex

public int getMinRowIndex()

Specified by:

getMinRowIndex in interface IGrid

getName

public String getName()

getNumberOfMergedRegions

public int getNumberOfMergedRegions()

Specified by:

getNumberOfMergedRegions in interface IGrid

getRangeUri

public String getRangeUri(IGridRegion region)

Gets the URI to the table by table region. Just calls AGrid.getRangeUri(int, int, int, int).

Parameters:

region - Table region.

Returns:

URI to the table in the sheet. (e.g. file:D:\work\Workspace\org.openl.tablets.tutorial4\rules \main&wbName=Tutorial_4.xls&wsName=Vehicle-Scoring&range=B3:D12)

getRegionContaining

public IGridRegion getRegionContaining(int x,
                                       int y)

Specified by:

getRegionContaining in interface IGrid

Overrides:

getRegionContaining in class AGrid

Returns:

Merged region containing cell specified by coordinates or null

getSheetSource

public XlsSheetSourceCodeModule getSheetSource()

getUri

public String getUri()

Specified by:

getUri in interface IGrid

isEmpty

public boolean isEmpty(int x,
                       int y)

Specified by:

isEmpty in interface IGrid

removeMergedRegion

public void removeMergedRegion(IGridRegion remove)

Specified by:

removeMergedRegion in interface IWritableGrid

removeMergedRegion

public void removeMergedRegion(int x,
                               int y)

Specified by:

removeMergedRegion in interface IWritableGrid

setCellValue

public void setCellValue(int col,
                         int row,
                         Object value)

Specified by:

setCellValue in interface IWritableGrid

setCellStringValue

public void setCellStringValue(int col,
                               int row,
                               String value)

Specified by:

setCellStringValue in interface IWritableGrid

setCellFormula

public void setCellFormula(int col,
                           int row,
                           String formula)

Specified by:

setCellFormula in interface IWritableGrid

setCellStyle

public void setCellStyle(int col,
                         int row,
                         ICellStyle style)

Specified by:

setCellStyle in interface IWritableGrid

setCellBorderStyle

public void setCellBorderStyle(int col,
                               int row,
                               ICellStyle style)

Specified by:

setCellBorderStyle in interface IWritableGrid

setCellAlignment

public void setCellAlignment(int col,
                             int row,
                             org.apache.poi.ss.usermodel.HorizontalAlignment alignment)

Specified by:

setCellAlignment in interface IWritableGrid

setCellIndent

public void setCellIndent(int col,
                          int row,
                          int indent)

Specified by:

setCellIndent in interface IWritableGrid

setCellFillColor

public void setCellFillColor(int col,
                             int row,
                             short[] color)

Specified by:

setCellFillColor in interface IWritableGrid

setCellFontColor

public void setCellFontColor(int col,
                             int row,
                             short[] color)

Specified by:

setCellFontColor in interface IWritableGrid

setCellFontBold

public void setCellFontBold(int col,
                            int row,
                            boolean bold)

Specified by:

setCellFontBold in interface IWritableGrid

setCellFontItalic

public void setCellFontItalic(int col,
                              int row,
                              boolean italic)

Specified by:

setCellFontItalic in interface IWritableGrid

setCellFontUnderline

public void setCellFontUnderline(int col,
                                 int row,
                                 boolean underlined)

Specified by:

setCellFontUnderline in interface IWritableGrid

setCellComment

public void setCellComment(int col,
                           int row,
                           String comment,
                           String prevCommentAuthor)

Specified by:

setCellComment in interface IWritableGrid

getCellWriter

public AXlsCellWriter getCellWriter(Object value)

getSpreadsheetConstants

public SpreadsheetConstants getSpreadsheetConstants()