org.zkoss.zss.ui.sys
Interface SpreadsheetCtrl

public interface SpreadsheetCtrl

Special controller interface . Only spreadsheet developer need to use this interface.

Author:

Dennis.Chen

Nested Class Summary

static class	SpreadsheetCtrl.CellAttribute
static class	SpreadsheetCtrl.Header

Field Summary

static java.lang.String	CHILD_PASSING_KEY
static int	DEFAULT_LOAD_COLUMN_SIZE
static int	DEFAULT_LOAD_ROW_SIZE

Method Summary

boolean	addWidget(Widget widget) Add widget to the WidgetHandler of this spreadsheet,
org.zkoss.json.JSONObject	getColumnHeaderAttrs(Worksheet sheet, int colStart, int colEnd)
HeaderPositionHelper	getColumnPositionHelper(java.lang.String sheetId)
Rect	getFocusRect()
java.lang.Boolean	getLeftHeaderHiddens(int row)
Rect	getLoadedRect()
MergeMatrixHelper	getMergeMatrixHelper(Worksheet sheet)
org.zkoss.json.JSONObject	getRangeAttrs(Worksheet sheet, SpreadsheetCtrl.Header containsHeader, SpreadsheetCtrl.CellAttribute type, int left, int top, int right, int bottom)
org.zkoss.json.JSONObject	getRowHeaderAttrs(Worksheet sheet, int rowStart, int rowEnd)
HeaderPositionHelper	getRowPositionHelper(java.lang.String sheetId)
Rect	getSelectionRect()
java.lang.Boolean	getTopHeaderHiddens(int col)
Rect	getVisibleRect()
WidgetHandler	getWidgetHandler()
boolean	removeWidget(Widget widget) Remove widget from the WidgetHandler of this spreadsheet,

Field Detail

CHILD_PASSING_KEY

static final java.lang.String CHILD_PASSING_KEY

See Also:

Constant Field Values

DEFAULT_LOAD_COLUMN_SIZE

static final int DEFAULT_LOAD_COLUMN_SIZE

See Also:

Constant Field Values

DEFAULT_LOAD_ROW_SIZE

static final int DEFAULT_LOAD_ROW_SIZE

See Also:

Constant Field Values

Method Detail

getRowPositionHelper

HeaderPositionHelper getRowPositionHelper(java.lang.String sheetId)

getColumnPositionHelper

HeaderPositionHelper getColumnPositionHelper(java.lang.String sheetId)

getMergeMatrixHelper

MergeMatrixHelper getMergeMatrixHelper(Worksheet sheet)

getSelectionRect

Rect getSelectionRect()

getFocusRect

Rect getFocusRect()

getLoadedRect

Rect getLoadedRect()

getVisibleRect

Rect getVisibleRect()

getWidgetHandler

WidgetHandler getWidgetHandler()

getRowHeaderAttrs

org.zkoss.json.JSONObject getRowHeaderAttrs(Worksheet sheet,
                                            int rowStart,
                                            int rowEnd)

getColumnHeaderAttrs

org.zkoss.json.JSONObject getColumnHeaderAttrs(Worksheet sheet,
                                               int colStart,
                                               int colEnd)

getRangeAttrs

org.zkoss.json.JSONObject getRangeAttrs(Worksheet sheet,
                                        SpreadsheetCtrl.Header containsHeader,
                                        SpreadsheetCtrl.CellAttribute type,
                                        int left,
                                        int top,
                                        int right,
                                        int bottom)

addWidget

boolean addWidget(Widget widget)

Add widget to the WidgetHandler of this spreadsheet,

Parameters:

widget - a widget

Returns:

true if success to add a widget

removeWidget

boolean removeWidget(Widget widget)

Remove widget from the WidgetHandler of this spreadsheet,

Parameters:

widget -

Returns:

true if success to remove a widget

getTopHeaderHiddens

java.lang.Boolean getTopHeaderHiddens(int col)

getLeftHeaderHiddens

java.lang.Boolean getLeftHeaderHiddens(int row)