icontextmenuitem.java

来自「esri的ArcGIS Server超级学习模板程序（for java）」· Java 代码 · 共 40 行

package com.esri.solutions.jitk.common.contextmenus;

import javax.faces.model.SelectItem;

import com.esri.adf.web.faces.event.TocEvent;

/**
 * Defines operations for a Context Menu Item that will be
 * displayed within the Table Of Contents.  This interface
 * will define method to create the {@link SelectItem} that
 * represents the Context Menu Item as well as an event
 * handler that will be called when there was an event that
 * occurred for this Context Menu Item.
 */
public interface IContextMenuItem {
	
	/**
	 * Creates a {@link SelectItem} that will render as a Context
	 * Menu Item in the Table Of Contents.  The returned SelectItem
	 * object must contain a unique <code>value</code> property.
	 * Implementations must not return <code>null</code> from this
	 * method.
	 * 
	 * @return SelectItem object that will render as a Context Menu
	 * 			Item in the Table Of Contents.  <code>null</code> must
	 * 			not be returned.
	 */
	public SelectItem createSelectItem ();
	
	/**
	 * Event handler that is invoked when the Context Menu Item is the
	 * subject of a Context Menu Event.  The details of the event will
	 * be contained within the {@link TocEvent} argument.  Implementations
	 * are free to decide how to handle the event.
	 * 
	 * @param event  Contains details on the Context Menu Event.
	 */
	public void handleContextMenuEvent (TocEvent event);
}