ZK Component Reference/Supporting Classes/Messagebox

Messagebox

• Demonstration: Messagebox
• Java API: Messagebox
• JavaScript API: N/A

Employment/Purpose

It provides a set of utilities to show message boxes.

It is typically used to alert users when an error occurs, or to prompt user for an decision.

Example

<window title="Messagebox demo" border="normal">
	<button label="Question" width="100px">
		<attribute name="onClick">{ Messagebox.show("Question is pressed. Are
			you sure?", "Question", Messagebox.OK | Messagebox.CANCEL,
			Messagebox.QUESTION); }</attribute>
	</button>
</window>

Customization

The Default Title

If the title is not specified, the application's name (returned by WebApp.getAppName()). You could change it by invoking WebApp.setAppName(String).

Since 5.0.6, you could specify the application's name with a library property called org.zkoss.zk.ui.WebApp.name. For example, you could specify the following in WEB-INF/zk.xml:

<library-property>
    <name>org.zkoss.zk.ui.WebApp.name</name>
    <value>My Killer Application</value>
</library-property>

The Template

The UI of a message box is based on a ZUL file, so you could customize it by replacing it with your own implementation. It can be done easily by invoking Messagebox.setTemplate(String). Notice it affects all message boxes used in an application. It is typically called when the application starts (i.e., in WebAppInit.init(WebApp) -- for more information, please refer to ZK Developer's Reference: Init and Cleanup).

To implement a custom template, please take a look at default template.

Supported events

Name	Event Type
None	None

Supported Children

*NONE

Use cases

Version	Description	Example Location

Version History

Version	Date	Content