The ZK Spreadsheet Component

The ZK Spreadsheet Component

In this section, a brief overview is given on how developers work with the ZK Spreadsheet component.

The Bare Spreadsheet Component

---

ZK Spreadsheet is a single ZK component. Developers could declare it within any ZK container components, such as Window, tabs, groupbox, etc.

For example:

<window title="Bare ZK Spreadsheet" border="normal" height="600px">
<spreadsheet src="/demo_sample.xls"	
			maxrows="200" 
			maxcolumns="40"
			width="500px"
			height="300px"></spreadsheet>
</window>

which renders:

Spreadsheet Component Attributes

---

Developers customize the spreadsheet component by declaring its attributes, for example:

• the source file of the spreadsheet, for example src="/demo_sample.xls"
• the maximum number of rows of this spread sheet, for example maxrows="200"
• the maximum number of columns of this spread sheet, for example maxcolumns="40"
• size of the spreadsheet component, for example: width="500px" height="300px"

Triggered Spreadsheet Events

---

Cell Event

• onCellFocused, trigger when user focus on cell
• onCellClick, trigger when user left click on a cell
• onCellRightClick, trigger when user right click on a cell
• onCellDoubleClick, trigger when user double click on a cell

Header Event

Name	Event Type
onHeaderClick	org.zkoss.zss.ui.event.HeaderMouseEvent Description: Notifies one that the user has left click on a header
onHeaderRightClick	HeaderMouseEvent Description: Notifies one that the user has right click on a header
onHeaderDoubleClick	HeaderMouseEvent Description: Notifies one that the user has double click on a header
onHeaderSize	HeaderEvent Description: Notifies one that the user has resize a header

Edit Event

• onStartEditing, trigger when user start editing cell
• onStopEditing, trigger when user stop editing cell

Selection Event

• onCellSelection, trigger when user select a range of cells
• onSelectionChange, trigger when user move or modify the range of a selection

Hyperlink Event

• onHyperlink, trigger when user click on the hyperlink of a cell

Spreadsheet Event Data Objects

• CellEvent

All source code listed in this book is at Github.