Toolbar Customization

From Documentation


Three toolbar buttons in out-of-box Spreadsheet are disabled by default: "New Book", "Save Book", and "Export to PDF" for they are not implemented yet. That's because the implementation of these functions quite depends on your requirement so we leave them unimplemented. Here we will tell you how to hook your own logic for these buttons.

Before implementing them, we should get the ideas behind toolbar buttons. When you click a toolbar button, Spreadsheet will invoke its corresponding "action handler" one by one (might be one or more) to perform the task. Hence, what you have to do is to write your custom action handlers and register them in Spreadsheet.

Steps to implement logic for a toolbar button

  1. Create a class to implement UserActionHandler.
    There are some methods you have to implement - isEnabled() and process(). The isEnabled() which returns the enabled state of the handler is invoked by UserActionManager when Spreadsheet needs to refresh toolbar button's enabled state (e.g. selecting a sheet). When users click a toolbar button, only those enabled handler will be invoked. If one toolbar button's all handlers are disabled, the toolbar button becomes disabled. The process() is the method you should write your own logic to handle the user action.
  2. Register our custom handlers via UserActionManager.
    After creating a UserActionHandler, you must hook it before it can be executed. We provide 2 ways to register a handler. UserActionManager.registerHandler() will append the passed handler while UserActionManager.setHandler() will remove other existing handlers and add the passed one.

Create User Action Handlers

New Book

"New Book" button will make Spreadsheet load a blank Excel file. We create NewBookHandler to implement this function, the source code are as follows:

public class NewBookHandler implements UserActionHandler {

	public boolean isEnabled(Book book, Sheet sheet) {
		return true;

	public boolean process(UserActionContext context) {
		Importer importer = Importers.getImporter();
		try {
			Book loadedBook = importer.imports(new File(WebApps.getCurrent()
							.getRealPath("/WEB-INF/books/blank.xlsx")), "blank.xlsx");
		} catch (IOException e) {
		return true;
  • Line 1: A custom handler should implement UserActionHandler interface.
  • Line 4: Return enabled state of this handlers.
  • Line 13: Import a blank Excel file with importer, please refer to Load A Book Model.
  • Line 15: Change Spreadsheet's book model with newly-loaded book. We can get Spreadsheet, Book, Event, selection (AreaRef), and action from UserActionContext.
  • Line 19: In most cases, you should return true if you have handled the action.

Save Book

"Save Book" button will save a book model as an Excel file with its book name as the file name.

public class SaveBookHandler implements UserActionHandler {
	public boolean isEnabled(Book book, Sheet sheet) {
		return book!=null;

	public boolean process(UserActionContext ctx){
			Book book = ctx.getBook();
			Clients.showNotification("saved "+book.getBookName(),"info",null,null,2000,true);
		}catch(Exception e){
		return true;
	//omitted code for brevity...
  • Line 5: Only when Spreadsheet has loaded a book, this handler is enabled.
  • Line 11: We can get Spreadsheet, Book, Event, selection (AreaRef), and action from UserActionContext.
  • Line 12: We just save back to original Excel file in our example for simplicity. Regarding how to implement the saving, you can refer to Export to Excel.

Register User Action Handlers

After creating our own handlers, we have to register them to correspond buttons of a Spreadsheet. In such a manner that when a user clicks a button, Spreadsheet can find our custom handlers through the registration.

The source code below demonstrates how to register custom user action handler in a controller:

Controller of customHandler.zul

public class CustomHandlerComposer extends SelectorComposer<Component> {
	private Spreadsheet ss;

	public void doAfterCompose(Component comp) throws Exception {
		//initialize custom handlers
		UserActionManager actionManager = ss.getUserActionManager();
				AuxAction.NEW_BOOK.getAction(), new NewBookHandler());
				AuxAction.SAVE_BOOK.getAction(), new SaveBookHandler());
  • Line 12: Get UserActionManager via Spreadsheet.
  • Line 13: Use UserActionManager to register our user action handlers.
  • Line 14: The first parameter is category name. Toolbar button belongs to DefaultUserActionManagerCtrl.Category.AUXACTION.
  • Line 15: The second parameter is action name. Each toolbar button corresponds to one action which is defined in AuxAction.

After completing above step, run customHandler.zul and you can see those buttons we registered handlers for are now enabled.


Append or Override with Your Handler

There are 2 ways to hook up your user action handlers:

Hide Toolbar Button

You can hide some toolbar buttons by JavaScript like:


    <script defer="true"><![CDATA[
var hiddenButtons = ['.zstbtn-newBook', '.zstbtn-saveBook', '.zstbtn-exportPDF', '.zstbtn-sortAndFilter'
	, '.zschktbtn-protectSheet', '.zstbtn-insertPicture', '.zstbtn-insertChart'];

jq.each(hiddenButtons, function(index, selector){

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.