Get or Set Value, Formula, or Formatted Text"

From Documentation
m (Created page with '{{ZKSpreadsheetEssentialsPageHeader}} __TOC__ {{ZKSpreadsheetEssentialsPageFooter}}')
 
m (correct highlight (via JWB))
 
(37 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
{{ZKSpreadsheetEssentialsPageHeader}}
 
{{ZKSpreadsheetEssentialsPageHeader}}
 +
 +
 +
{{Deprecated|url=http://books.zkoss.org/wiki/ZK_Spreadsheet_Essentials}}
  
 
__TOC__
 
__TOC__
  
 +
===Purpose===
 +
ZK Spreadsheet uses <javadoc directory="zss" method="getEditText()">org.zkoss.zss.model.Range</javadoc> to get cell's edit text, and <javadoc directory="zss"  method="setEditText(java.lang.String)">org.zkoss.zss.model.Range</javadoc>to set cell's text as input by the user.
 +
 +
===ZUML===
 +
 +
<source lang="xml" highlight="4,6,8">
 +
<zk>
 +
<div width="100%" height="100%" apply="demo.EditorComposer" >
 +
<div height="3px"></div>
 +
<combobox id="focusCombobox" mold="rounded" style="text-align:center;">
 +
</combobox>
 +
<textbox id="formulaEditor" cols="100"/>
 +
<div height="3px"></div>
 +
<spreadsheet id="spreadsheet" src="/demo_sample.xls"
 +
maxrows="200"
 +
maxcolumns="40"
 +
width="100%"
 +
height="450px"></spreadsheet>
 +
</div>
 +
</zk>
 +
</source>
 +
 +
===Composer===
 +
 +
====Current Cell Text====
 +
We can use onCellFocused event to get the current focus cell and display the cell's text.
 +
<source lang="java" highlight="4,9">
 +
public void onCellFocused$spreadsheet(CellEvent event) {
 +
int row = event.getRow();
 +
int col = event.getColumn();
 +
focusCombobox.setText(spreadsheet.getRowtitle(row) + spreadsheet.getColumntitle(col));
 +
 +
Worksheet sheet = spreadsheet.getSelectedSheet();
 +
currentCell = Utils.getCell(sheet, row, col);
 +
currentRange = Ranges.range(sheet, row, col);
 +
formulaEditor.setText(currentRange.getEditText());
 +
}
 +
</source>
 +
 +
====Cell Position====
 +
First, we need to get the current cell's position. We can get row and column index from CellEvent, then use <javadoc directory="zss"  method="getRowtitle(java.lang.String)">org.zkoss.zss.ui.Spreadsheet</javadoc> and <javadoc directory="zss" method="getColumntitle((java.lang.String)">org.zkoss.zss.ui.Spreadsheet</javadoc> to get the current cell's title.
 +
 +
<source lang="java" highlight="4">
 +
public void onCellFocused$spreadsheet(CellEvent event) {
 +
int row = event.getRow();
 +
int col = event.getColumn();
 +
focusCombobox.setText(spreadsheet.getRowtitle(row) + spreadsheet.getColumntitle(col));
 +
...
 +
</source>
 +
 +
====Cell Value====
 +
After we get the cell's position, we can get the cell's value from <javadoc directory="zss" method="getEditText()">org.zkoss.zss.model.Range</javadoc>
 +
 +
<source lang="java" highlight="7">
 +
public void onCellFocused$spreadsheet(CellEvent event) {
 +
        ...
 +
 +
Worksheet sheet = spreadsheet.getSelectedSheet();
 +
currentCell = Utils.getCell(sheet, row, col);
 +
currentRange = Ranges.range(sheet, row, col);
 +
formulaEditor.setText(currentRange.getEditText());
 +
}
 +
</source>
 +
 +
====Editor====
 +
 +
For editor, we can use the onOK event, which menus when the user click '''Enter''' keyboard, set cell's value and make spreadsheet's focus to the next cell
 +
<source lang="java" highlight="2,3">
 +
public void onOK$formulaEditor() {
 +
currentRange.setEditText(formulaEditor.getText());
 +
spreadsheet.focusTo(currentCell.getRowIndex() + 1, currentCell.getColumnIndex());
 +
}
 +
</source>
 +
 +
Second, we can also use the onChange and onChanging event to get the current editor's value and set the cell's value.
 +
<source lang="java" highlight="3, 7">
 +
public void onChanging$formulaEditor(InputEvent event) {
 +
if (currentCell.getCellType() != Cell.CELL_TYPE_FORMULA)
 +
currentRange.setEditText(event.getValue());
 +
}
 +
 +
public void onChange$formulaEditor() {
 +
currentRange.setEditText(formulaEditor.getText());
 +
}
 +
</source>
 +
 +
[[File:ZKSsEss_Spreadsheet_SetValue_Input.png]]
 +
 +
View the complete source of ZUML [https://code.google.com/p/zkbooks/source/browse/trunk/zssessentials/examples/WebContent/config/editor.zul editor.zul]
 +
 +
View the complete source of composer [https://code.google.com/p/zkbooks/source/browse/trunk/zssessentials/examples/src/org/zkoss/zssessentials/config/EditorComposer.java EditorComposer.java]
 +
 +
=Version History=
 +
{{LastUpdated}}
 +
{| border='1px' | width="100%"
 +
! Version !! Date !! Content
 +
|-
 +
| &nbsp;
 +
| &nbsp;
 +
| &nbsp;
 +
|}
  
 
{{ZKSpreadsheetEssentialsPageFooter}}
 
{{ZKSpreadsheetEssentialsPageFooter}}

Latest revision as of 12:55, 19 January 2022


DocumentationZK Spreadsheet EssentialsWorking with ZK SpreadsheetConfigure and Control ZK SpreadsheetGet or Set Value, Formula, or Formatted Text
Get or Set Value, Formula, or Formatted Text




Stop.png This article is out of date, please refer to http://books.zkoss.org/wiki/ZK_Spreadsheet_Essentials for more up to date information.

Purpose

ZK Spreadsheet uses Range.getEditText() to get cell's edit text, and Range.setEditText(String)to set cell's text as input by the user.

ZUML

<zk>
<div width="100%" height="100%" apply="demo.EditorComposer" >
	<div height="3px"></div>
		<combobox id="focusCombobox" mold="rounded"	style="text-align:center;">
		</combobox>
		<textbox id="formulaEditor" cols="100"/>
	<div height="3px"></div>
	<spreadsheet id="spreadsheet" src="/demo_sample.xls"	
			maxrows="200" 
			maxcolumns="40"
			width="100%"
			height="450px"></spreadsheet>
</div>
</zk>

Composer

Current Cell Text

We can use onCellFocused event to get the current focus cell and display the cell's text. 

public void onCellFocused$spreadsheet(CellEvent event) {
	int row = event.getRow();
	int col = event.getColumn();
	focusCombobox.setText(spreadsheet.getRowtitle(row) + spreadsheet.getColumntitle(col));

	Worksheet sheet = spreadsheet.getSelectedSheet();
	currentCell = Utils.getCell(sheet, row, col);
	currentRange = Ranges.range(sheet, row, col);
	formulaEditor.setText(currentRange.getEditText());
}

Cell Position

First, we need to get the current cell's position. We can get row and column index from CellEvent, then use Spreadsheet.getRowtitle(String) and Spreadsheet.getColumntitle((String) to get the current cell's title. 

public void onCellFocused$spreadsheet(CellEvent event) {
	int row = event.getRow();
	int col = event.getColumn();
	focusCombobox.setText(spreadsheet.getRowtitle(row) + spreadsheet.getColumntitle(col));
 ...

Cell Value

After we get the cell's position, we can get the cell's value from Range.getEditText() 

public void onCellFocused$spreadsheet(CellEvent event) {
        ...

	Worksheet sheet = spreadsheet.getSelectedSheet();
	currentCell = Utils.getCell(sheet, row, col);
	currentRange = Ranges.range(sheet, row, col);
	formulaEditor.setText(currentRange.getEditText());
}

Editor

For editor, we can use the onOK event, which menus when the user click Enter keyboard, set cell's value and make spreadsheet's focus to the next cell 

public void onOK$formulaEditor() {
	currentRange.setEditText(formulaEditor.getText());
	spreadsheet.focusTo(currentCell.getRowIndex() + 1, currentCell.getColumnIndex());
}

Second, we can also use the onChange and onChanging event to get the current editor's value and set the cell's value. 

public void onChanging$formulaEditor(InputEvent event) {
	if (currentCell.getCellType() != Cell.CELL_TYPE_FORMULA)
		currentRange.setEditText(event.getValue());
}
	
public void onChange$formulaEditor() {
	currentRange.setEditText(formulaEditor.getText());
}

ZKSsEss Spreadsheet SetValue Input.png

View the complete source of ZUML editor.zul

View the complete source of composer EditorComposer.java

Version History

Last Update : 2022/01/19


Version Date Content
     


All source code listed in this book is at Github.


Last Update : 2022/01/19

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.


Retrieved from "https://www.zkoss.org/_w/index.php?title=ZK_Spreadsheet_Essentials/Working_with_ZK_Spreadsheet/Configure_and_Control_ZK_Spreadsheet/Get_or_Set_Value,_Formula,_or_Formatted_Text&oldid=53625"