org.eclipse.swt.events.MenuDetectEvent Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2010, 2012 EclipseSource and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* EclipseSource - initial API and implementation
******************************************************************************/
package org.eclipse.swt.events;
import org.eclipse.swt.widgets.Event;
/**
* Instances of this class are sent whenever the platform-
* specific trigger for showing a context menu is detected.
*
* @see MenuDetectListener
* @see Sample code and further information
*
* @since 1.3
*/
public final class MenuDetectEvent extends TypedEvent {
private static final long serialVersionUID = -3061660596590828941L;
/**
* the display-relative x coordinate of the pointer
* at the time the context menu trigger occurred
*/
public int x;
/**
* the display-relative y coordinate of the pointer
* at the time the context menu trigger occurred
*/
public int y;
/**
* A flag indicating whether the operation should be allowed. Setting this
* field to false will cancel the operation.
*/
public boolean doit;
/**
* Constructs a new instance of this class based on the
* information in the given untyped event.
*
* @param event the untyped event containing the information
*/
public MenuDetectEvent( Event event ) {
super( event );
x = event.x;
y = event.y;
doit = event.doit;
}
/**
* Returns a string containing a concise, human-readable
* description of the receiver.
*
* @return a string representation of the event
*/
@Override
public String toString() {
String string = super.toString ();
return string.substring (0, string.length() - 1) // remove trailing '}'
+ " x=" + x
+ " y=" + y
+ " doit=" + doit
+ "}";
}
}