org.eclipse.swt.widgets

Class Widget

java.lang.Object

org.eclipse.swt.widgets.Widget

Direct Known Subclasses:

Caret, Control, DragSource, DropTarget, IME, Item, Menu, ScrollBar, TaskBar, ToolTip, Tracker, Tray

public abstract class Widget
extends java.lang.Object

This class is the abstract superclass of all user interface objects. Widgets are created, disposed and issue notification to listeners when events occur which affect them.

Styles:

(none)

Events:

Dispose

IMPORTANT: This class is intended to be subclassed only within the SWT implementation. However, it has not been marked final to allow those outside of the SWT development team to implement patched versions of the class in order to get around specific limitations in advance of when those limitations can be addressed by the team. Any class built using subclassing to access the internals of this class will likely fail to compile or run between releases and may be strongly platform specific. Subclassing should not be attempted without an intimate and detailed understanding of the workings of the hierarchy. No support is provided for user-written classes which are implemented as subclasses of this class.

See Also:

checkSubclass(), Sample code and further information

Structure Diagram

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static int	CANVAS
(package private) java.lang.Object	data
(package private) static int	DEFAULT_HEIGHT
(package private) static int	DEFAULT_WIDTH
(package private) static int	DISABLED
(package private) Display	display
(package private) static int	DISPOSE_SENT
(package private) static int	DISPOSED
(package private) static int	DRAG_DETECT
(package private) static int	DRAW_BACKGROUND
(package private) EventTable	eventTable
(package private) static int	FOREIGN_HANDLE
(package private) static int	HIDDEN
(package private) static int	IGNORE_WM_CHANGEUISTATE
(package private) static int	KEYED_DATA
(package private) static int	LAYOUT_CHANGED
(package private) static int	LAYOUT_CHILD
(package private) static int	LAYOUT_NEEDED
(package private) static int	MAJOR
(package private) static int	MINOR
(package private) static int	MOVE_DEFERRED
(package private) static int	MOVE_OCCURRED
(package private) static int	PARENT_BACKGROUND
(package private) static int	RELEASED
(package private) static int	RESIZE_DEFERRED
(package private) static int	RESIZE_OCCURRED
(package private) static int	SKIN_NEEDED
(package private) int	state
(package private) int	style
(package private) static int	THEME_BACKGROUND
(package private) static int	TRACK_MOUSE

Constructor Summary

Constructors

Constructor and Description
Widget() Prevents uninitialized instances from being created outside the package.
Widget(Widget parent, int style) Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

Method Summary

Methods

Modifier and Type	Method and Description
(package private) void	_addListener(int eventType, Listener listener)
void	addDisposeListener(DisposeListener listener) Adds the listener to the collection of listeners who will be notified when the widget is disposed.
void	addListener(int eventType, Listener listener) Adds the listener to the collection of listeners who will be notified when an event of the given type occurs.
(package private) int	callWindowProc(int hwnd, int msg, int wParam, int lParam)
(package private) static int	checkBits(int style, int int0, int int1, int int2, int int3, int int4, int int5) Returns a style with exactly one style bit set out of the specified set of exclusive style bits.
(package private) void	checkOpened()
(package private) void	checkOrientation(Widget parent)
(package private) void	checkParent(Widget parent) Throws an exception if the specified widget can not be used as a parent for the receiver.
protected void	checkSubclass() Checks that this class can be subclassed.
protected void	checkWidget() Throws an SWTException if the receiver can not be accessed by the caller.
(package private) int	DeferWindowPos(int hWinPosInfo, int hWnd, int hWndInsertAfter, int X, int Y, int cx, int cy, int uFlags)
(package private) void	destroyWidget() Destroys the widget in the operating system and releases the widget's handle.
void	dispose() Disposes of the operating system resources associated with the receiver and all its descendants.
(package private) boolean	dragDetect(int hwnd, int x, int y, boolean filter, boolean[] detect, boolean[] consume)
(package private) void	error(int code) Does whatever widget specific cleanup is required, and then uses the code in SWTError.error to handle the error.
(package private) boolean	filters(int eventType)
(package private) Widget	findItem(int id)
(package private) char[]	fixMnemonic(java.lang.String string)
(package private) char[]	fixMnemonic(java.lang.String string, boolean spaces)
java.lang.Object	getData() Returns the application defined widget data associated with the receiver, or null if it has not been set.
java.lang.Object	getData(java.lang.String key) Returns the application defined property of the receiver with the specified name, or null if it has not been set.
Display	getDisplay() Returns the Display that is associated with the receiver.
Listener[]	getListeners(int eventType) Returns an array of listeners who will be notified when an event of the given type occurs.
(package private) Menu	getMenu()
(package private) java.lang.String	getName() Returns the name of the widget.
(package private) java.lang.String	getNameText()
int	getStyle() Returns the receiver's style information.
(package private) boolean	hooks(int eventType)
boolean	isDisposed() Returns true if the widget has been disposed, and false otherwise.
boolean	isListening(int eventType) Returns true if there are any listeners for the specified event type associated with the receiver, and false otherwise.
(package private) boolean	isValidSubclass()
(package private) boolean	isValidThread()
(package private) void	mapEvent(int hwnd, Event event)
(package private) GC	new_GC(GCData data)
void	notifyListeners(int eventType, Event event) Notifies all of the receiver's listeners for events of the given type that one such event has occurred by invoking their handleEvent() method.
(package private) void	postEvent(int eventType)
(package private) void	postEvent(int eventType, Event event)
(package private) void	release(boolean destroy)
(package private) void	releaseChildren(boolean destroy)
(package private) void	releaseHandle()
(package private) void	releaseParent()
(package private) void	releaseWidget()
void	removeDisposeListener(DisposeListener listener) Removes the listener from the collection of listeners who will be notified when the widget is disposed.
void	removeListener(int eventType, Listener listener) Removes the listener from the collection of listeners who will be notified when an event of the given type occurs.
protected void	removeListener(int eventType, SWTEventListener listener) Removes the listener from the collection of listeners who will be notified when an event of the given type occurs.
void	reskin(int flags) Marks the widget to be skinned.
(package private) void	reskinChildren(int flags)
(package private) void	reskinWidget()
(package private) boolean	sendDragEvent(int button, int x, int y)
(package private) boolean	sendDragEvent(int button, int stateMask, int x, int y)
(package private) void	sendEvent(Event event)
(package private) void	sendEvent(int eventType)
(package private) void	sendEvent(int eventType, Event event)
(package private) void	sendEvent(int eventType, Event event, boolean send)
(package private) boolean	sendFocusEvent(int type)
(package private) boolean	sendKeyEvent(int type, int msg, int wParam, int lParam)
(package private) boolean	sendKeyEvent(int type, int msg, int wParam, int lParam, Event event)
(package private) boolean	sendMouseEvent(int type, int button, int count, int detail, boolean send, int hwnd, int msg, int wParam, int lParam)
(package private) boolean	sendMouseEvent(int type, int button, int hwnd, int msg, int wParam, int lParam)
(package private) boolean	sendMouseWheelEvent(int type, int hwnd, int wParam, int lParam)
(package private) void	sendSelectionEvent(int type)
(package private) void	sendSelectionEvent(int type, Event event, boolean send)
void	setData(java.lang.Object data) Sets the application defined widget data associated with the receiver to be the argument.
void	setData(java.lang.String key, java.lang.Object value) Sets the application defined property of the receiver with the specified name to the given value.
(package private) boolean	setInputState(Event event, int type)
(package private) boolean	setKeyState(Event event, int type, int wParam, int lParam)
(package private) int	setLocationMask(Event event, int type, int wParam, int lParam)
(package private) boolean	setTabGroupFocus()
(package private) boolean	setTabItemFocus()
(package private) boolean	SetWindowPos(int hWnd, int hWndInsertAfter, int X, int Y, int cx, int cy, int uFlags)
(package private) boolean	showMenu(int x, int y)
(package private) boolean	showMenu(int x, int y, int detail)
java.lang.String	toString() Returns a string containing a concise, human-readable description of the receiver.
(package private) void	updateMenuLocation(Event event)
(package private) LRESULT	wmCaptureChanged(int hwnd, int wParam, int lParam)
(package private) LRESULT	wmChar(int hwnd, int wParam, int lParam)
(package private) LRESULT	wmContextMenu(int hwnd, int wParam, int lParam)
(package private) LRESULT	wmIMEChar(int hwnd, int wParam, int lParam)
(package private) LRESULT	wmKeyDown(int hwnd, int wParam, int lParam)
(package private) LRESULT	wmKeyUp(int hwnd, int wParam, int lParam)
(package private) LRESULT	wmKillFocus(int hwnd, int wParam, int lParam)
(package private) LRESULT	wmLButtonDblClk(int hwnd, int wParam, int lParam)
(package private) LRESULT	wmLButtonDown(int hwnd, int wParam, int lParam)
(package private) LRESULT	wmLButtonUp(int hwnd, int wParam, int lParam)
(package private) LRESULT	wmMButtonDblClk(int hwnd, int wParam, int lParam)
(package private) LRESULT	wmMButtonDown(int hwnd, int wParam, int lParam)
(package private) LRESULT	wmMButtonUp(int hwnd, int wParam, int lParam)
(package private) LRESULT	wmMouseHover(int hwnd, int wParam, int lParam)
(package private) LRESULT	wmMouseHWheel(int hwnd, int wParam, int lParam)
(package private) LRESULT	wmMouseLeave(int hwnd, int wParam, int lParam)
(package private) LRESULT	wmMouseMove(int hwnd, int wParam, int lParam)
(package private) LRESULT	wmMouseWheel(int hwnd, int wParam, int lParam)
(package private) LRESULT	wmNCPaint(int hwnd, int wParam, int lParam)
(package private) LRESULT	wmPaint(int hwnd, int wParam, int lParam)
(package private) LRESULT	wmPrint(int hwnd, int wParam, int lParam)
(package private) LRESULT	wmRButtonDblClk(int hwnd, int wParam, int lParam)
(package private) LRESULT	wmRButtonDown(int hwnd, int wParam, int lParam)
(package private) LRESULT	wmRButtonUp(int hwnd, int wParam, int lParam)
(package private) LRESULT	wmSetFocus(int hwnd, int wParam, int lParam)
(package private) LRESULT	wmSysChar(int hwnd, int wParam, int lParam)
(package private) LRESULT	wmSysKeyDown(int hwnd, int wParam, int lParam)
(package private) LRESULT	wmSysKeyUp(int hwnd, int wParam, int lParam)
(package private) LRESULT	wmXButtonDblClk(int hwnd, int wParam, int lParam)
(package private) LRESULT	wmXButtonDown(int hwnd, int wParam, int lParam)
(package private) LRESULT	wmXButtonUp(int hwnd, int wParam, int lParam)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

style

int style

state

int state

display

Display display

eventTable

EventTable eventTable

data

java.lang.Object data

DISPOSED

static final int DISPOSED

See Also:

Constant Field Values

CANVAS

static final int CANVAS

See Also:

Constant Field Values

KEYED_DATA

static final int KEYED_DATA

See Also:

Constant Field Values

DISABLED

static final int DISABLED

See Also:

Constant Field Values

HIDDEN

static final int HIDDEN

See Also:

Constant Field Values

LAYOUT_NEEDED

static final int LAYOUT_NEEDED

See Also:

Constant Field Values

LAYOUT_CHANGED

static final int LAYOUT_CHANGED

See Also:

Constant Field Values

LAYOUT_CHILD

static final int LAYOUT_CHILD

See Also:

Constant Field Values

THEME_BACKGROUND

static final int THEME_BACKGROUND

See Also:

Constant Field Values

DRAW_BACKGROUND

static final int DRAW_BACKGROUND

See Also:

Constant Field Values

PARENT_BACKGROUND

static final int PARENT_BACKGROUND

See Also:

Constant Field Values

RELEASED

static final int RELEASED

See Also:

Constant Field Values

DISPOSE_SENT

static final int DISPOSE_SENT

See Also:

Constant Field Values

TRACK_MOUSE

static final int TRACK_MOUSE

See Also:

Constant Field Values

FOREIGN_HANDLE

static final int FOREIGN_HANDLE

See Also:

Constant Field Values

DRAG_DETECT

static final int DRAG_DETECT

See Also:

Constant Field Values

MOVE_OCCURRED

static final int MOVE_OCCURRED

See Also:

Constant Field Values

MOVE_DEFERRED

static final int MOVE_DEFERRED

See Also:

Constant Field Values

RESIZE_OCCURRED

static final int RESIZE_OCCURRED

See Also:

Constant Field Values

RESIZE_DEFERRED

static final int RESIZE_DEFERRED

See Also:

Constant Field Values

IGNORE_WM_CHANGEUISTATE

static final int IGNORE_WM_CHANGEUISTATE

See Also:

Constant Field Values

SKIN_NEEDED

static final int SKIN_NEEDED

See Also:

Constant Field Values

DEFAULT_WIDTH

static final int DEFAULT_WIDTH

See Also:

Constant Field Values

DEFAULT_HEIGHT

static final int DEFAULT_HEIGHT

See Also:

Constant Field Values

MAJOR

static final int MAJOR

See Also:

Constant Field Values

MINOR

static final int MINOR

See Also:

Constant Field Values

Constructor Detail

Widget

Widget()

Prevents uninitialized instances from being created outside the package.

Widget

public Widget(Widget parent,
      int style)

Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

The style value is either one of the style constants defined in class SWT which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the int "|" operator) two or more of those SWT style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

Parameters:

parent - a widget which will be the parent of the new instance (cannot be null)

style - the style of widget to construct

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the parent is null
• ERROR_INVALID_ARGUMENT - if the parent is disposed

SWTException -

• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
• ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass

See Also:

SWT, checkSubclass(), getStyle()

Method Detail

_addListener

void _addListener(int eventType,
                Listener listener)

addListener

public void addListener(int eventType,
               Listener listener)

Adds the listener to the collection of listeners who will be notified when an event of the given type occurs. When the event does occur in the widget, the listener is notified by sending it the handleEvent() message. The event type is one of the event constants defined in class SWT.

Parameters:

eventType - the type of event to listen for

listener - the listener which should be notified when the event occurs

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

Listener, SWT, getListeners(int), removeListener(int, Listener), notifyListeners(int, org.eclipse.swt.widgets.Event)

addDisposeListener

public void addDisposeListener(DisposeListener listener)

Adds the listener to the collection of listeners who will be notified when the widget is disposed. When the widget is disposed, the listener is notified by sending it the widgetDisposed() message.

Parameters:

listener - the listener which should be notified when the receiver is disposed

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

DisposeListener, removeDisposeListener(org.eclipse.swt.events.DisposeListener)

callWindowProc

int callWindowProc(int hwnd,
                 int msg,
                 int wParam,
                 int lParam)

checkBits

static int checkBits(int style,
            int int0,
            int int1,
            int int2,
            int int3,
            int int4,
            int int5)

Returns a style with exactly one style bit set out of the specified set of exclusive style bits. All other possible bits are cleared when the first matching bit is found. Bits that are not part of the possible set are untouched.

Parameters:

style - the original style bits

int0 - the 0th possible style bit

int1 - the 1st possible style bit

int2 - the 2nd possible style bit

int3 - the 3rd possible style bit

int4 - the 4th possible style bit

int5 - the 5th possible style bit

Returns:

the new style bits

checkOrientation

void checkOrientation(Widget parent)

checkOpened

void checkOpened()

checkParent

void checkParent(Widget parent)

Throws an exception if the specified widget can not be used as a parent for the receiver.

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the parent is null
• ERROR_INVALID_ARGUMENT - if the parent is disposed

SWTException -

• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent

checkSubclass

protected void checkSubclass()

Checks that this class can be subclassed.

The SWT class library is intended to be subclassed only at specific, controlled points (most notably, Composite and Canvas when implementing new widgets). This method enforces this rule unless it is overridden.

IMPORTANT: By providing an implementation of this method that allows a subclass of a class which does not normally allow subclassing to be created, the implementer agrees to be fully responsible for the fact that any such subclass will likely fail between SWT releases and will be strongly platform specific. No support is provided for user-written classes which are implemented in this fashion.

The ability to subclass outside of the allowed SWT classes is intended purely to enable those not on the SWT development team to implement patches in order to get around specific limitations in advance of when those limitations can be addressed by the team. Subclassing should not be attempted without an intimate and detailed understanding of the hierarchy.

Throws:

SWTException -

• ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass

checkWidget

protected void checkWidget()

Throws an SWTException if the receiver can not be accessed by the caller. This may include both checks on the state of the receiver and more generally on the entire execution context. This method should be called by widget implementors to enforce the standard SWT invariants.

Currently, it is an error to invoke any method (other than isDisposed()) on a widget that has had its dispose() method called. It is also an error to call widget methods from any thread that is different from the thread that created the widget.

In future releases of SWT, there may be more or fewer error checks and exceptions may be thrown for different reasons.

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

destroyWidget

void destroyWidget()

Destroys the widget in the operating system and releases the widget's handle. If the widget does not have a handle, this method may hide the widget, mark the widget as destroyed or do nothing, depending on the widget.

When a widget is destroyed in the operating system, its descendants are also destroyed by the operating system. This means that it is only necessary to call destroyWidget on the root of the widget tree.

This method is called after releaseWidget().

See also releaseChild(), releaseWidget() and releaseHandle().

See Also:

dispose()

DeferWindowPos

int DeferWindowPos(int hWinPosInfo,
                 int hWnd,
                 int hWndInsertAfter,
                 int X,
                 int Y,
                 int cx,
                 int cy,
                 int uFlags)

dispose

public void dispose()

Disposes of the operating system resources associated with the receiver and all its descendants. After this method has been invoked, the receiver and all descendants will answer true when sent the message isDisposed(). Any internal connections between the widgets in the tree will have been removed to facilitate garbage collection. This method does nothing if the widget is already disposed.

NOTE: This method is not called recursively on the descendants of the receiver. This means that, widget implementers can not detect when a widget is being disposed of by re-implementing this method, but should instead listen for the Dispose event.

Throws:

SWTException -

• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

addDisposeListener(org.eclipse.swt.events.DisposeListener), removeDisposeListener(org.eclipse.swt.events.DisposeListener), checkWidget()

dragDetect

boolean dragDetect(int hwnd,
                 int x,
                 int y,
                 boolean filter,
                 boolean[] detect,
                 boolean[] consume)

error

void error(int code)

Does whatever widget specific cleanup is required, and then uses the code in SWTError.error to handle the error.

Parameters:

code - the descriptive error code

See Also:

SWT.error(int)

filters

boolean filters(int eventType)

findItem

Widget findItem(int id)

fixMnemonic

char[] fixMnemonic(java.lang.String string)

fixMnemonic

char[] fixMnemonic(java.lang.String string,
                 boolean spaces)

getData

public java.lang.Object getData()

Returns the application defined widget data associated with the receiver, or null if it has not been set. The widget data is a single, unnamed field that is stored with every widget.

Applications may put arbitrary objects in this field. If the object stored in the widget data needs to be notified when the widget is disposed of, it is the application's responsibility to hook the Dispose event on the widget and do so.

Returns:

the widget data

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - when the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - when called from the wrong thread

See Also:

setData(Object)

getData

public java.lang.Object getData(java.lang.String key)

Returns the application defined property of the receiver with the specified name, or null if it has not been set.

Applications may have associated arbitrary objects with the receiver in this fashion. If the objects stored in the properties need to be notified when the widget is disposed of, it is the application's responsibility to hook the Dispose event on the widget and do so.

Parameters:

key - the name of the property

Returns:

the value of the property or null if it has not been set

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the key is null

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

setData(String, Object)

getDisplay

public Display getDisplay()

Returns the Display that is associated with the receiver.

A widget's display is either provided when it is created (for example, top level Shells) or is the same as its parent's display.

Returns:

the receiver's display

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed

getListeners

public Listener[] getListeners(int eventType)

Returns an array of listeners who will be notified when an event of the given type occurs. The event type is one of the event constants defined in class SWT.

Parameters:

eventType - the type of event to listen for

Returns:

an array of listeners that will be notified when the event occurs

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

3.4

See Also:

Listener, SWT, addListener(int, Listener), removeListener(int, Listener), notifyListeners(int, org.eclipse.swt.widgets.Event)

getMenu

Menu getMenu()

getName

java.lang.String getName()

Returns the name of the widget. This is the name of the class without the package name.

Returns:

the name of the widget

getNameText

java.lang.String getNameText()

getStyle

public int getStyle()

Returns the receiver's style information.

Note that the value which is returned by this method may not match the value which was provided to the constructor when the receiver was created. This can occur when the underlying operating system does not support a particular combination of requested styles. For example, if the platform widget used to implement a particular SWT widget always has scroll bars, the result of calling this method would always have the SWT.H_SCROLL and SWT.V_SCROLL bits set.

Returns:

the style bits

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

hooks

boolean hooks(int eventType)

isDisposed

public boolean isDisposed()

Returns true if the widget has been disposed, and false otherwise.

This method gets the dispose state for the widget. When a widget has been disposed, it is an error to invoke any other method (except dispose()) using the widget.

Returns:

true when the widget is disposed and false otherwise

isListening

public boolean isListening(int eventType)

Returns true if there are any listeners for the specified event type associated with the receiver, and false otherwise. The event type is one of the event constants defined in class SWT.

Parameters:

eventType - the type of event

Returns:

true if the event is hooked

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

SWT

isValidSubclass

boolean isValidSubclass()

isValidThread

boolean isValidThread()

mapEvent

void mapEvent(int hwnd,
            Event event)

new_GC

GC new_GC(GCData data)

notifyListeners

public void notifyListeners(int eventType,
                   Event event)

Notifies all of the receiver's listeners for events of the given type that one such event has occurred by invoking their handleEvent() method. The event type is one of the event constants defined in class SWT.

Parameters:

eventType - the type of event which has occurred

event - the event data

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

SWT, addListener(int, org.eclipse.swt.widgets.Listener), getListeners(int), removeListener(int, Listener)

postEvent

void postEvent(int eventType)

postEvent

void postEvent(int eventType,
             Event event)

release

void release(boolean destroy)

releaseChildren

void releaseChildren(boolean destroy)

releaseHandle

void releaseHandle()

releaseParent

void releaseParent()

releaseWidget

void releaseWidget()

removeListener

public void removeListener(int eventType,
                  Listener listener)

Removes the listener from the collection of listeners who will be notified when an event of the given type occurs. The event type is one of the event constants defined in class SWT.

Parameters:

eventType - the type of event to listen for

listener - the listener which should no longer be notified

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

Listener, SWT, addListener(int, org.eclipse.swt.widgets.Listener), getListeners(int), notifyListeners(int, org.eclipse.swt.widgets.Event)

removeListener

protected void removeListener(int eventType,
                  SWTEventListener listener)

Removes the listener from the collection of listeners who will be notified when an event of the given type occurs.

IMPORTANT: This method is not part of the SWT public API. It is marked public only so that it can be shared within the packages provided by SWT. It should never be referenced from application code.

Parameters:

eventType - the type of event to listen for

listener - the listener which should no longer be notified

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

Listener, addListener(int, org.eclipse.swt.widgets.Listener)

removeDisposeListener

public void removeDisposeListener(DisposeListener listener)

Removes the listener from the collection of listeners who will be notified when the widget is disposed.

Parameters:

listener - the listener which should no longer be notified

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

DisposeListener, addDisposeListener(org.eclipse.swt.events.DisposeListener)

reskin

public void reskin(int flags)

Marks the widget to be skinned.

The skin event is sent to the receiver's display when appropriate (usually before the next event is handled). Widgets are automatically marked for skinning upon creation as well as when its skin id or class changes. The skin id and/or class can be changed by calling Display.setData(String, Object) with the keys SWT.SKIN_ID and/or SWT.SKIN_CLASS. Once the skin event is sent to a widget, it will not be sent again unless reskin(int) is called on the widget or on an ancestor while specifying the SWT.ALL flag.

The parameter flags may be either:

SWT.ALL

all children in the receiver's widget tree should be skinned

SWT.NONE

only the receiver should be skinned

Parameters:

flags - the flags specifying how to reskin

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

3.6

reskinChildren

void reskinChildren(int flags)

reskinWidget

void reskinWidget()

sendDragEvent

boolean sendDragEvent(int button,
                    int x,
                    int y)

sendDragEvent

boolean sendDragEvent(int button,
                    int stateMask,
                    int x,
                    int y)

sendEvent

void sendEvent(Event event)

sendEvent

void sendEvent(int eventType)

sendEvent

void sendEvent(int eventType,
             Event event)

sendEvent

void sendEvent(int eventType,
             Event event,
             boolean send)

sendSelectionEvent

void sendSelectionEvent(int type)

sendSelectionEvent

void sendSelectionEvent(int type,
                      Event event,
                      boolean send)

sendKeyEvent

boolean sendKeyEvent(int type,
                   int msg,
                   int wParam,
                   int lParam)

sendKeyEvent

boolean sendKeyEvent(int type,
                   int msg,
                   int wParam,
                   int lParam,
                   Event event)

sendMouseEvent

boolean sendMouseEvent(int type,
                     int button,
                     int hwnd,
                     int msg,
                     int wParam,
                     int lParam)

sendMouseEvent

boolean sendMouseEvent(int type,
                     int button,
                     int count,
                     int detail,
                     boolean send,
                     int hwnd,
                     int msg,
                     int wParam,
                     int lParam)

sendMouseWheelEvent

boolean sendMouseWheelEvent(int type,
                          int hwnd,
                          int wParam,
                          int lParam)

setData

public void setData(java.lang.Object data)

Sets the application defined widget data associated with the receiver to be the argument. The widget data is a single, unnamed field that is stored with every widget.

Applications may put arbitrary objects in this field. If the object stored in the widget data needs to be notified when the widget is disposed of, it is the application's responsibility to hook the Dispose event on the widget and do so.

Parameters:

data - the widget data

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - when the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - when called from the wrong thread

See Also:

getData()

setData

public void setData(java.lang.String key,
           java.lang.Object value)

Sets the application defined property of the receiver with the specified name to the given value.

Applications may associate arbitrary objects with the receiver in this fashion. If the objects stored in the properties need to be notified when the widget is disposed of, it is the application's responsibility to hook the Dispose event on the widget and do so.

Parameters:

key - the name of the property

value - the new value for the property

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the key is null

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

getData(String)

sendFocusEvent

boolean sendFocusEvent(int type)

setInputState

boolean setInputState(Event event,
                    int type)

setKeyState

boolean setKeyState(Event event,
                  int type,
                  int wParam,
                  int lParam)

setLocationMask

int setLocationMask(Event event,
                  int type,
                  int wParam,
                  int lParam)

setTabGroupFocus

boolean setTabGroupFocus()

setTabItemFocus

boolean setTabItemFocus()

SetWindowPos

boolean SetWindowPos(int hWnd,
                   int hWndInsertAfter,
                   int X,
                   int Y,
                   int cx,
                   int cy,
                   int uFlags)

showMenu

boolean showMenu(int x,
               int y)

showMenu

boolean showMenu(int x,
               int y,
               int detail)

toString

public java.lang.String toString()

Returns a string containing a concise, human-readable description of the receiver.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the receiver

updateMenuLocation

void updateMenuLocation(Event event)

wmCaptureChanged

LRESULT wmCaptureChanged(int hwnd,
                       int wParam,
                       int lParam)

wmChar

LRESULT wmChar(int hwnd,
             int wParam,
             int lParam)

wmContextMenu

LRESULT wmContextMenu(int hwnd,
                    int wParam,
                    int lParam)

wmIMEChar

LRESULT wmIMEChar(int hwnd,
                int wParam,
                int lParam)

wmKeyDown

LRESULT wmKeyDown(int hwnd,
                int wParam,
                int lParam)

wmKeyUp

LRESULT wmKeyUp(int hwnd,
              int wParam,
              int lParam)

wmKillFocus

LRESULT wmKillFocus(int hwnd,
                  int wParam,
                  int lParam)

wmLButtonDblClk

LRESULT wmLButtonDblClk(int hwnd,
                      int wParam,
                      int lParam)

wmLButtonDown

LRESULT wmLButtonDown(int hwnd,
                    int wParam,
                    int lParam)

wmLButtonUp

LRESULT wmLButtonUp(int hwnd,
                  int wParam,
                  int lParam)

wmMButtonDblClk

LRESULT wmMButtonDblClk(int hwnd,
                      int wParam,
                      int lParam)

wmMButtonDown

LRESULT wmMButtonDown(int hwnd,
                    int wParam,
                    int lParam)

wmMButtonUp

LRESULT wmMButtonUp(int hwnd,
                  int wParam,
                  int lParam)

wmMouseHover

LRESULT wmMouseHover(int hwnd,
                   int wParam,
                   int lParam)

wmMouseLeave

LRESULT wmMouseLeave(int hwnd,
                   int wParam,
                   int lParam)

wmMouseMove

LRESULT wmMouseMove(int hwnd,
                  int wParam,
                  int lParam)

wmMouseWheel

LRESULT wmMouseWheel(int hwnd,
                   int wParam,
                   int lParam)

wmMouseHWheel

LRESULT wmMouseHWheel(int hwnd,
                    int wParam,
                    int lParam)

wmNCPaint

LRESULT wmNCPaint(int hwnd,
                int wParam,
                int lParam)

wmPaint

LRESULT wmPaint(int hwnd,
              int wParam,
              int lParam)

wmPrint

LRESULT wmPrint(int hwnd,
              int wParam,
              int lParam)

wmRButtonDblClk

LRESULT wmRButtonDblClk(int hwnd,
                      int wParam,
                      int lParam)

wmRButtonDown

LRESULT wmRButtonDown(int hwnd,
                    int wParam,
                    int lParam)

wmRButtonUp

LRESULT wmRButtonUp(int hwnd,
                  int wParam,
                  int lParam)

wmSetFocus

LRESULT wmSetFocus(int hwnd,
                 int wParam,
                 int lParam)

wmSysChar

LRESULT wmSysChar(int hwnd,
                int wParam,
                int lParam)

wmSysKeyDown

LRESULT wmSysKeyDown(int hwnd,
                   int wParam,
                   int lParam)

wmSysKeyUp

LRESULT wmSysKeyUp(int hwnd,
                 int wParam,
                 int lParam)

wmXButtonDblClk

LRESULT wmXButtonDblClk(int hwnd,
                      int wParam,
                      int lParam)

wmXButtonDown

LRESULT wmXButtonDown(int hwnd,
                    int wParam,
                    int lParam)

wmXButtonUp

LRESULT wmXButtonUp(int hwnd,
                  int wParam,
                  int lParam)