/*
* Copyright 2008 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.google.gwt.topspin.ui.client;
import com.google.gwt.core.client.JavaScriptObject;
import com.google.gwt.events.client.Event;
import com.google.gwt.events.client.EventListener;
import com.google.gwt.events.client.EventListenerRemover;
/**
* An event fired when the context-menu is requested for a widget.
*
* This event represents the native 'oncontextmenu' event.
*/
public class ContextMenuEvent extends NativeEvent {
public static final String NAME = "contextmenu";
/**
* Adds a context-menu listener to the given native object.
*
* @param source the associated event source
* @param nativeSource the native object that will fire the event
* @param listener the listener to be notified of the event
* @return a handle that may be used to remove this listener
*/
public static EventListenerRemover addContextMenuListener(
final Object source, JavaScriptObject nativeSource,
final ContextMenuListener listener) {
return Event.addEventListener(ContextMenuEvent.NAME, nativeSource,
new EventListener() {
public void handleEvent(Event event) {
listener.onContextMenu(new ContextMenuEvent(source, event));
}
});
}
/**
* Creates a new context-menu event with the given source and browser event.
*
* @param sender the event source
* @param nativeEvent the browser event
*/
public ContextMenuEvent(Object sender, Event nativeEvent) {
super(sender, nativeEvent);
}
}