richlet.java

来自「非常接近C/S操作方式的Java Ajax框架－ZK 用ZK框架使你的B/S应」· Java 代码 · 共 54 行

/* Richlet.java

{{IS_NOTE
	Purpose:
		
	Description:
		
	History:
		Thu Oct  5 11:56:22     2006, Created by tomyeh
}}IS_NOTE

Copyright (C) 2006 Potix Corporation. All Rights Reserved.

{{IS_RIGHT
	This program is distributed under GPL Version 2.0 in the hope that
	it will be useful, but WITHOUT ANY WARRANTY.
}}IS_RIGHT
*/
package org.zkoss.zk.ui;

import org.zkoss.zk.ui.Page;
import org.zkoss.zk.ui.metainfo.LanguageDefinition;

/**
 * Defines methods that all richlets must implement.
 * A richlet is a small Java program that
 * creates all necessary components for a given page in response to user's request.
 *
 * <p>To activate it, it must be added to {@link org.zkoss.zk.ui.util.Configuration}
 * by use of {@link org.zkoss.zk.ui.util.Configuration#addRichlet}, or specify
 * &lt;richlet&gt; in zk.xml.
 *
 * @author tomyeh
 */
public interface Richlet {
	/** Called by the richlet container to indicate to a richlet that
	 * the richlet is being placed into service.
	 */
	public void init(RichletConfig config);
	/** Called by the richlet container to indicate to a richlet that
	 * the richlet is being taken out of service.
	 */
	public void destroy();
	/** Returns the language defintion that this richlet belongs to.
	 * Don't return null.
	 */
	public LanguageDefinition getLanguageDefinition();

	/** Called by the richlet container to create components when
	 * the specified page is visited and created.
	 */
	public void service(Page page);
}