Messagebox"

From Documentation
Line 42: Line 42:
  
 
== The Template ==
 
== 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 <javadoc method="setTemplate(java.lang.String)">org.zkoss.zul.Messagebox</javadoc>. Notice it affects all message boxes used in an application. It is typically called when the application starts (i.e., in <javadoc method="init(org.zkoss.zk.ui.WebApp)" type="interface">org.zkoss.zk.ui.util.WebAppInit</javadoc> -- for more information, please refer to [[ZK Developer's Reference/Customization/Init and Cleanup|ZK Developer's Reference: Init and Cleanup]]).
 +
 +
To implement a custom template, please take a look at [http://zk1.svn.sourceforge.net/viewvc/zk1/branches/5.0/zul/src/archive/web/zul/html/messagebox.zul|the default template].
 +
 
=Supported events=
 
=Supported events=
  

Revision as of 06:57, 8 February 2011

Messagebox

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
     



Last Update : 2011/02/08

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