Sheet Event

From Documentation
Revision as of 08:20, 9 July 2013 by Hawk (talk | contribs) (Created page with "{{ZKSpreadsheetEssentials3PageHeader}} These events are related to sheet operation such as creating, selecting, deleting, and renaming a sheet. * '''onSheetCreate ''' *: This...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)



These events are related to sheet operation such as creating, selecting, deleting, and renaming a sheet.

  • onSheetCreate
    This event is fired when a user creates a new sheet. When a corresponding event listener is invoked, a SheetEvent object is passed as an argument.
  • onSheetSelect
    This event is fired when a user clicks on sheet bar to select a sheet. When a corresponding event listener is invoked, a SheetSelectEvent object is passed as an argument.
  • onSheetNameChange
    This event is fired after a user has renamed a sheet. When a corresponding event listener is invoked, a SheetEvent object is passed as an argument.
  • onSheetOrderChange
    This event is fired after a user change the order of a sheet. When a corresponding event listener is invoked, a SheetEvent object is passed as an argument.
  • onSheetDelete
    This event is fired when a user deletes a sheet. When a corresponding event listener is invoked, a SheetDeleteEvent object is passed as an argument.


Event Monitor Example

The Event Monitor application's screenshot when we click the link http://www.zkoss.org in A7.

Zss-essentials-events-hyperlink.png


<source lang='java' high=> public class EventsComposer extends SelectorComposer<Component>{ //omitted codes...

@Listen("onSheetSelect = spreadsheet") public void onSheetSelect(SheetSelectEvent event){ StringBuilder info = new StringBuilder(); info.append("Select sheet : ").append(event.getSheetName());

//show info... }

@Listen("onSheetNameChange = spreadsheet") public void onSheetNameChange(SheetEvent event){ StringBuilder info = new StringBuilder(); info.append("Rename sheet to ").append(event.getSheetName());


//show info... }

@Listen("onSheetOrderChange = spreadsheet") public void onSheetOrderChange(SheetEvent event){ StringBuilder info = new StringBuilder(); Sheet sheet = event.getSheet(); info.append("Reorder sheet : ").append(event.getSheetName()).append(" to ").append(sheet.getBook().getSheetIndex(sheet));

if(isShowEventInfo(event.getName())){ addInfo(info.toString()); } }

@Listen("onSheetCreate = spreadsheet") public void onSheetCreate(SheetEvent event){ StringBuilder info = new StringBuilder(); info.append("Create sheet : ").append(event.getSheetName());

//show info... }

@Listen("onSheetDelete = spreadsheet") public void onSheetDelete(SheetDeleteEvent event){ StringBuilder info = new StringBuilder(); info.append("Delete sheet : ").append(event.getSheetName());

//show info... }

}