Sheet Event

Overview

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

onSheetSelect

This event is fired when a user clicks on the sheet bar to select a sheet. When a corresponding event listener is invoked, a io.keikai.ui.event.SheetSelectEvent object is passed as an argument.

onAfterSheetCreate

This event is fired after a user creates a new sheet. When a corresponding event listener is invoked, a io.keikai.ui.event.SheetEvent object is passed as an argument.

onAfterSheetNameChange

This event is fired after a user has renamed a sheet. When a corresponding event listener is invoked, a io.keikai.ui.event.SheetEvent object is passed as an argument.

onAfterSheetOrderChange

This event is fired after a user changes the order of a sheet. When a corresponding event listener is invoked, a io.keikai.ui.event.SheetEvent object is passed as an argument.

onAfterSheetDelete

This event is fired after a user deletes a sheet. When a corresponding event listener is invoked, a io.keikai.ui.event.SheetDeleteEvent object is passed as an argument.

Event Monitor Example

Below is the screenshot of Event Monitor for about sheet operations. You can see from the right hand side panel that we created a “sheet3”, selected it, moved it, and renamed it to “essentials”, and eventually deleted it.

center

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
public class EventsComposer extends SelectorComposer<Component>{
    //omitted codes...
    
    @Listen("onSheetSelect = #ss")
    public void onSheetSelect(SheetSelectEvent event){
        StringBuilder info = new StringBuilder();
        info.append("Select sheet : ").append(event.getSheetName());
        
        //show info...
    }

    @Listen("onAfterSheetCreate = #ss")
    public void onAfterSheetCreate(SheetEvent event){
        StringBuilder info = new StringBuilder();
        info.append("Create sheet : ").append(event.getSheetName());
        
        //show info...
    }
    
    @Listen("onAfterSheetNameChange = #ss")
    public void onAfterSheetNameChange(SheetEvent event){
        StringBuilder info = new StringBuilder();
        info.append("Rename sheet to ").append(event.getSheetName());
        
        
        //show info...
    }
    
    @Listen("onAfterSheetOrderChange = #ss")
    public void onAfterSheetOrderChange(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("onAfterSheetDelete = #ss")
    public void onAfterSheetDelete(SheetDeleteEvent event){
        StringBuilder info = new StringBuilder();
        info.append("Delete sheet : ").append(event.getSheetName());
        
        //show info...
    }
    
}
  • Line 4, 12, 20, 29, 41: Apply @Listen to listen to an event with the syntax [EVENT NAME] = [COMPONENT SELECTOR]. All event names can be found in io.keikai.ui.event.Events. The “#ss” is the component selector which refers to the component with id “ss” on the ZUL page. (SelectorComposer supports various selector syntax that let you select components easily. Please refer to ZK Developer Reference).

Comments