/*
* Smart GWT (GWT for SmartClient)
* Copyright 2008 and beyond, Isomorphic Software, Inc.
*
* Smart GWT is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License version 3
* as published by the Free Software Foundation. Smart GWT is also
* available under typical commercial license terms - see
* http://smartclient.com/license
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*/
package com.smartgwt.client.widgets.events;
import com.google.gwt.event.shared.EventHandler;
public interface ShowContextMenuHandler extends EventHandler {
/**
* Executed when the right mouse button is clicked. The default implementation of this method auto-creates a {@link
* com.smartgwt.client.widgets.menu.Menu} from the {@link com.smartgwt.client.widgets.Canvas#getContextMenu contextMenu}
* property on this component and then calls {@link com.smartgwt.client.widgets.menu.Menu#showContextMenu
* Menu.showContextMenu} on it to show it. <p> If you want to show a standard context menu, you can simply define your Menu
* and set it as the contextMenu property on your component - you do not need to override this method. <p> If you want to
* do some other processing before showing a menu or do something else entirely, then you should override this method.
* Note that the return value from this method controls whether or not the native browser context menu is shown.
*
* @param event the event
*/
void onShowContextMenu(com.smartgwt.client.widgets.events.ShowContextMenuEvent event);
}