org.eclipse.swt.widgets

Class Display

java.lang.Object

org.eclipse.swt.graphics.Device

org.eclipse.swt.widgets.Display

All Implemented Interfaces:

Drawable

public class Display
extends Device

Instances of this class are responsible for managing the connection between SWT and the underlying operating system. Their most important function is to implement the SWT event loop in terms of the platform event model. They also provide various methods for accessing information about the operating system, and have overall control over the operating system resources which SWT allocates.

Applications which are built with SWT will almost always require only a single display. In particular, some platforms which SWT supports will not allow more than one active display. In other words, some platforms do not support creating a new display if one already exists that has not been sent the dispose() message.

In SWT, the thread which creates a Display instance is distinguished as the user-interface thread for that display.

The user-interface thread for a particular display has the following special attributes:

• The event loop for that display must be run from the thread.
• Some SWT API methods (notably, most of the public methods in Widget and its subclasses), may only be called from the thread. (To support multi-threaded user-interface applications, class Display provides inter-thread communication methods which allow threads other than the user-interface thread to request that it perform operations on their behalf.)
• The thread is not allowed to construct other Displays until that display has been disposed. (Note that, this is in addition to the restriction mentioned above concerning platform support for multiple displays. Thus, the only way to have multiple simultaneously active displays, even on platforms which support it, is to have multiple threads.)

Enforcing these attributes allows SWT to be implemented directly on the underlying operating system's event model. This has numerous benefits including smaller footprint, better use of resources, safer memory management, clearer program logic, better performance, and fewer overall operating system threads required. The down side however, is that care must be taken (only) when constructing multi-threaded applications to use the inter-thread communication mechanisms which this class provides when required.

All SWT API methods which may only be called from the user-interface thread are distinguished in their documentation by indicating that they throw the "ERROR_THREAD_INVALID_ACCESS" SWT exception.

Styles:

(none)

Events:

Close, Dispose, OpenDocument, Settings, Skin

IMPORTANT: This class is not intended to be subclassed.

See Also:

syncExec(java.lang.Runnable), asyncExec(java.lang.Runnable), wake(), readAndDispatch(), sleep(), Device.dispose(), Display snippets, Sample code and further information

Structure Diagram

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static java.lang.String	ACCEL_KEY_HIT
(package private) boolean	accelKeyHit
(package private) static short[]	ACCENTS
(package private) static java.lang.String	APP_NAME
(package private) static java.lang.String	APP_VERSION
(package private) static java.lang.String	AWT_WINDOW_CLASS
(package private) Menu[]	bars
(package private) static char[]	BUTTON
(package private) boolean	captureChanged
(package private) int	clickCount
(package private) RECT	clickRect
(package private) int	columnCount
(package private) boolean[]	columnVisible
(package private) Control[]	controlTable
(package private) Cursor[]	cursors
(package private) java.lang.Object	data
(package private) static Display	Default
(package private) static int	DI_GETDRAGIMAGE
(package private) static Display[]	Displays
(package private) java.lang.Runnable[]	disposeList
(package private) Image	downArrow
(package private) boolean	dragCancelled
(package private) static char[]	EDIT
(package private) Callback	embeddedCallback
(package private) int	embeddedHwnd
(package private) int	embeddedProc
(package private) Image	errorImage
(package private) Event[]	eventQueue
(package private) EventTable	eventTable
(package private) static char[]	EXPLORER
(package private) static char[]	EXPLORERBAR
(package private) int	filterHook
(package private) EventTable	filterTable
(package private) boolean	fixFocus
(package private) Control	focusControl
(package private) int	focusEvent
(package private) Callback	foregroundIdleCallback
(package private) int	foregroundIdleProc
(package private) int	freeSlot
(package private) Callback	getMsgCallback
(package private) int	getMsgProc
(package private) static int	GROW_SIZE
(package private) int	hButtonTheme
(package private) NMHDR	hdr
(package private) int	hEditTheme
(package private) int	hExplorerBarTheme
(package private) int	hitCount
(package private) MSG	hookMsg
(package private) int	hScrollBarTheme
(package private) int	hTabTheme
(package private) int	hwndMessage
(package private) int	hwndParent
(package private) static int	ID_START
(package private) int	idleHook
(package private) boolean	ignoreNextKey
(package private) boolean	ignoreRestoreFocus
(package private) ImageList[]	imageList
(package private) int[]	indexTable
(package private) Image	infoImage
(package private) MenuItem[]	items
(package private) byte[]	keyboard
(package private) java.lang.String[]	keys
(package private) static int[][]	KeyTable
(package private) int	lastAscii
(package private) int	lastButton
(package private) int	lastClickHwnd
(package private) Control	lastControl
(package private) boolean	lastDead
(package private) double	lastDistance
(package private) Control	lastGetControl
(package private) int	lastGetHwnd
(package private) boolean	lastHighContrast
(package private) int	lastHittest
(package private) Control	lastHittestControl
(package private) int	lastHwnd
(package private) int	lastKey
(package private) int	lastMouse
(package private) boolean	lastNull
(package private) int	lastTime
(package private) boolean	lastVirtual
(package private) int	lastX
(package private) int	lastY
(package private) static java.lang.String	LAUNCHER_PREFIX
(package private) Composite[]	layoutDeferred
(package private) int	layoutDeferredCount
(package private) LOGFONT	lfSystemFont
(package private) static char[]	LISTVIEW
(package private) boolean	lockActiveWindow
(package private) int	lpCustColors
(package private) static STARTUPINFO	lpStartupInfo
(package private) double	magStartDistance
(package private) Callback	messageCallback
(package private) int	messageProc
(package private) boolean	mnemonicKeyHit
(package private) Dialog	modalDialog
(package private) Shell[]	modalShells
(package private) int	monitorCount
(package private) Monitor[]	monitors
MSG	msg the handle to the OS message queue (Warning: This field is platform dependent) IMPORTANT: This field is not part of the SWT public API.
(package private) Callback	msgFilterCallback
(package private) int	msgFilterProc
(package private) int	msgHook
(package private) int	nextTimerId
(package private) int	nextToolTipId
(package private) int	nextTrayId
(package private) static java.lang.String	PACKAGE_PREFIX
(package private) NMLVDISPINFO	plvfi
(package private) Menu[]	popups
(package private) Image	questionImage
(package private) static int	RESIZE_LIMIT
(package private) int	resizeCount
(package private) static int	RESOURCE_SIZE
(package private) Resource[]	resources
(package private) double	rotationAngle
(package private) static java.lang.String	RUN_MESSAGES_IN_IDLE_KEY
(package private) static java.lang.String	RUN_MESSAGES_IN_MESSAGE_PROC_KEY
(package private) boolean	runDragDrop
(package private) boolean	runMessages
(package private) boolean	runMessagesInIdle
(package private) boolean	runMessagesInMessageProc
(package private) static char[]	SCROLLBAR
(package private) int	scrollHRemainder
(package private) int	scrollRemainder
(package private) boolean	sendSettings
(package private) static int	SETTINGS_DELAY
(package private) static int	SETTINGS_ID
(package private) int	skinCount
(package private) Widget[]	skinList
(package private) static int	SWT_DESTROY
(package private) static int	SWT_GETACCEL
(package private) static int	SWT_GETACCELCOUNT
(package private) static int	SWT_KEYMSG
(package private) static int	SWT_NULL
(package private) static int	SWT_OBJECT_INDEX
(package private) static int	SWT_OPENDOC
(package private) static int	SWT_RESTORECARET
(package private) static int	SWT_RUNASYNC
(package private) static int	SWT_TRAYICONMSG
(package private) Synchronizer	synchronizer
(package private) Font	systemFont
(package private) static char[]	TAB
(package private) char[]	tableBuffer
(package private) TaskBar	taskBar
(package private) static java.lang.String	TASKBAR_EVENT
(package private) static int	TASKBARBUTTONCREATED
(package private) static int	TASKBARCREATED
(package private) java.lang.Thread	thread
(package private) int	threadId
(package private) int[]	timerIds
(package private) java.lang.Runnable[]	timerList
(package private) ImageList[]	toolDisabledImageList
(package private) ImageList[]	toolHotImageList
(package private) ImageList[]	toolImageList
(package private) TouchSource[]	touchSources
(package private) Tray	tray
(package private) static char[]	TREEVIEW
(package private) static boolean	TrimEnabled
(package private) Image	upArrow
(package private) static java.lang.String	USE_OWNDC_KEY
(package private) static boolean	USE_PROPERTY
(package private) boolean	useOwnDC
(package private) java.lang.Object[]	values
(package private) Image	warningIcon
(package private) Callback	windowCallback
(package private) TCHAR	windowClass
(package private) static int	WindowClassCount
(package private) static java.lang.String	WindowName
(package private) TCHAR	windowOwnDCClass
(package private) static java.lang.String	WindowOwnDCName
(package private) int	windowProc
(package private) TCHAR	windowShadowClass
(package private) static java.lang.String	WindowShadowName
(package private) boolean	xMouse

Fields inherited from class org.eclipse.swt.graphics.Device

CurrentDevice, DEBUG, DeviceFinder, hPalette

Constructor Summary

Constructors

Constructor and Description
Display() Constructs a new instance of this class.
Display(DeviceData data) Constructs a new instance of this class using the parameter.

Method Summary

Methods

Modifier and Type	Method and Description
(package private) Control	_getFocusControl()
(package private) void	addBar(Menu menu)
(package private) void	addControl(int handle, Control control)
void	addFilter(int eventType, Listener listener) Adds the listener to the collection of listeners who will be notified when an event of the given type occurs anywhere in a widget.
(package private) void	addLayoutDeferred(Composite comp)
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) void	addMenuItem(MenuItem item)
(package private) void	addPopup(Menu menu)
(package private) void	addSkinnableWidget(Widget widget)
(package private) int	asciiKey(int key)
void	asyncExec(java.lang.Runnable runnable) Causes the run() method of the runnable to be invoked by the user-interface thread at the next reasonable opportunity.
void	beep() Causes the system hardware to emit a short sound (if it supports this capability).
protected void	checkDevice() Throws an SWTException if the receiver can not be accessed by the caller.
(package private) static void	checkDisplay(java.lang.Thread thread, boolean multiple)
protected void	checkSubclass() Checks that this class can be subclassed.
(package private) void	clearModal(Shell shell)
void	close() Requests that the connection between SWT and the underlying operating system be closed.
(package private) int	controlKey(int key)
protected void	create(DeviceData data) Creates the device in the operating system.
(package private) static int	create32bitDIB(Image image)
(package private) static int	create32bitDIB(int hBitmap, int alpha, byte[] alphaData, int transparentPixel)
(package private) void	createDisplay(DeviceData data)
(package private) static Image	createIcon(Image image)
(package private) static int	createMaskFromAlpha(ImageData data, int destWidth, int destHeight)
(package private) static void	deregister(Display display)
protected void	destroy() Destroys the device in the operating system and releases the device's handle.
(package private) void	destroyDisplay()
void	disposeExec(java.lang.Runnable runnable) Causes the run() method of the runnable to be invoked by the user-interface thread just before the receiver is disposed.
(package private) void	drawMenuBars()
(package private) int	embeddedProc(int hwnd, int msg, int wParam, int lParam)
(package private) void	error(int code) Does whatever display specific cleanup is required, and then uses the code in SWTError.error to handle the error.
(package private) boolean	filterEvent(Event event)
(package private) boolean	filterMessage(MSG msg)
(package private) boolean	filters(int eventType)
(package private) Control	findControl(int handle)
static Display	findDisplay(java.lang.Thread thread) Returns the display which the given thread is the user-interface thread for, or null if the given thread is not a user-interface thread for any display.
(package private) TouchSource	findTouchSource(int touchDevice, Monitor monitor)
Widget	findWidget(int handle) Given the operating system handle for a widget, returns the instance of the Widget subclass which represents it in the currently running application, if such exists, or null if no matching widget can be found.
Widget	findWidget(int handle, int id) Given the operating system handle for a widget, and widget-specific id, returns the instance of the Widget subclass which represents the handle/id pair in the currently running application, if such exists, or null if no matching widget can be found.
Widget	findWidget(Widget widget, int id) Given a widget and a widget-specific id, returns the instance of the Widget subclass which represents the widget/id pair in the currently running application, if such exists, or null if no matching widget can be found.
(package private) int	foregroundIdleProc(int code, int wParam, int lParam)
Shell	getActiveShell() Returns the currently active Shell, or null if no shell belonging to the currently running application is active.
static java.lang.String	getAppName() Returns the application name.
static java.lang.String	getAppVersion() Returns the application version.
Rectangle	getBounds() Returns a rectangle describing the receiver's size and location.
(package private) int	getClickCount(int type, int button, int hwnd, int lParam)
Rectangle	getClientArea() Returns a rectangle which describes the area of the receiver which is capable of displaying data.
(package private) Control	getControl(int handle)
static Display	getCurrent() Returns the display which the currently running thread is the user-interface thread for, or null if the currently running thread is not a user-interface thread for any display.
Control	getCursorControl() Returns the control which the on-screen pointer is currently over top of, or null if it is not currently over one of the controls built by the currently running application.
Point	getCursorLocation() Returns the location of the on-screen pointer relative to the top left corner of the screen.
Point[]	getCursorSizes() Returns an array containing the recommended cursor sizes.
java.lang.Object	getData() Returns the application defined, display specific 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.
static Display	getDefault() Returns the default display.
int	getDismissalAlignment() Returns the button dismissal alignment, one of LEFT or RIGHT.
int	getDoubleClickTime() Returns the longest duration, in milliseconds, between two mouse button clicks that will be considered a double click by the underlying operating system.
Control	getFocusControl() Returns the control which currently has keyboard focus, or null if keyboard events are not currently going to any of the controls built by the currently running application.
(package private) java.lang.String	getFontName(LOGFONT logFont)
boolean	getHighContrast() Returns true when the high contrast mode is enabled.
int	getIconDepth() Returns the maximum allowed depth of icons on this display, in bits per pixel.
Point[]	getIconSizes() Returns an array containing the recommended icon sizes.
(package private) ImageList	getImageList(int style, int width, int height)
(package private) ImageList	getImageListToolBar(int style, int width, int height)
(package private) ImageList	getImageListToolBarDisabled(int style, int width, int height)
(package private) ImageList	getImageListToolBarHot(int style, int width, int height)
(package private) int	getLastEventTime()
Menu	getMenuBar() Returns the single instance of the application menu bar, or null if there is no application menu bar for the platform.
(package private) MenuItem	getMenuItem(int id)
(package private) int	getMessageCount()
(package private) Dialog	getModalDialog()
(package private) Shell	getModalShell()
Monitor[]	getMonitors() Returns an array of monitors attached to the device.
(package private) int	getMsgProc(int code, int wParam, int lParam)
Monitor	getPrimaryMonitor() Returns the primary monitor for that device.
(package private) java.lang.String	getSharedData(int pid, int handle)
Shell[]	getShells() Returns a (possibly empty) array containing all shells which have not been disposed and have the receiver as their display.
(package private) Image	getSortImage(int direction)
Synchronizer	getSynchronizer() Gets the synchronizer used by the display.
java.lang.Thread	getSyncThread() Returns the thread that has invoked syncExec or null if no such runnable is currently being invoked by the user-interface thread.
Color	getSystemColor(int id) Returns the matching standard color for the given constant, which should be one of the color constants specified in class SWT.
Cursor	getSystemCursor(int id) Returns the matching standard platform cursor for the given constant, which should be one of the cursor constants specified in class SWT.
Font	getSystemFont() Returns a reasonable font for applications to use.
Image	getSystemImage(int id) Returns the matching standard platform image for the given constant, which should be one of the icon constants specified in class SWT.
Menu	getSystemMenu() Returns the single instance of the system-provided menu for the application, or null on platforms where no menu is provided for the application.
TaskBar	getSystemTaskBar() Returns the single instance of the system taskBar or null when there is no system taskBar available for the platform.
Tray	getSystemTray() Returns the single instance of the system tray or null when there is no system tray available for the platform.
java.lang.Thread	getThread() Returns the user-interface thread for the receiver.
boolean	getTouchEnabled() Returns a boolean indicating whether a touch-aware input device is attached to the system and is ready for use.
(package private) int	hButtonTheme()
(package private) int	hEditTheme()
(package private) int	hExplorerBarTheme()
(package private) int	hScrollBarTheme()
(package private) int	hTabTheme()
protected void	init() Initializes any internal resources needed by the device.
void	internal_dispose_GC(int hDC, GCData data) Invokes platform specific functionality to dispose a GC handle.
int	internal_new_GC(GCData data) Invokes platform specific functionality to allocate a new GC handle.
(package private) static boolean	isValidClass(java.lang.Class clazz)
(package private) boolean	isValidThread()
(package private) boolean	isXMouseActive()
Point	map(Control from, Control to, int x, int y) Maps a point from one coordinate system to another.
Rectangle	map(Control from, Control to, int x, int y, int width, int height) Maps a point from one coordinate system to another.
Point	map(Control from, Control to, Point point) Maps a point from one coordinate system to another.
Rectangle	map(Control from, Control to, Rectangle rectangle) Maps a point from one coordinate system to another.
(package private) static char	mbcsToWcs(int ch)
(package private) static char	mbcsToWcs(int ch, int codePage)
(package private) int	messageProc(int hwnd, int msg, int wParam, int lParam)
(package private) int	monitorEnumProc(int hmonitor, int hdc, int lprcMonitor, int dwData)
(package private) int	msgFilterProc(int code, int wParam, int lParam)
(package private) int	numpadKey(int key)
boolean	post(Event event) Generate a low level system event.
(package private) void	postEvent(Event event)
boolean	readAndDispatch() Reads an event from the operating system's event queue, dispatches it appropriately, and returns true if there is potentially more work to do, or false if the caller can sleep until another event is placed on the event queue.
(package private) static void	register(Display display)
protected void	release() Releases any internal resources back to the operating system and clears all fields except the device handle.
(package private) void	releaseDisplay()
(package private) void	releaseImageList(ImageList list)
(package private) void	releaseToolDisabledImageList(ImageList list)
(package private) void	releaseToolHotImageList(ImageList list)
(package private) void	releaseToolImageList(ImageList list)
(package private) void	removeBar(Menu menu)
(package private) Control	removeControl(int handle)
void	removeFilter(int eventType, Listener listener) Removes the listener from the collection of listeners who will be notified when an event of the given type occurs anywhere in a widget.
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.
(package private) void	removeMenuItem(MenuItem item)
(package private) void	removePopup(Menu menu)
(package private) boolean	runAsyncMessages(boolean all)
(package private) boolean	runDeferredEvents()
(package private) boolean	runDeferredLayouts()
(package private) boolean	runPopups()
(package private) void	runSettings()
(package private) boolean	runSkin()
(package private) boolean	runTimer(int id)
(package private) void	saveResources()
(package private) void	sendEvent(int eventType, Event event)
static void	setAppName(java.lang.String name) Sets the application name to the argument.
static void	setAppVersion(java.lang.String version) Sets the application version to the argument.
void	setCursorLocation(int x, int y) Sets the location of the on-screen pointer relative to the top left corner of the screen.
void	setCursorLocation(Point point) Sets the location of the on-screen pointer relative to the top left corner of the screen.
void	setData(java.lang.Object data) Sets the application defined, display specific data associated with the receiver, to 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 argument.
(package private) static void	setDevice(Device device)
(package private) void	setModalDialog(Dialog modalDailog)
(package private) void	setModalShell(Shell shell)
void	setSynchronizer(Synchronizer synchronizer) Sets the synchronizer used by the display to be the argument, which can not be null.
(package private) int	shiftedKey(int key)
boolean	sleep() Causes the user-interface thread to sleep (that is, to be put in a state where it does not consume CPU cycles) until an event is received or it is otherwise awakened.
void	syncExec(java.lang.Runnable runnable) Causes the run() method of the runnable to be invoked by the user-interface thread at the next reasonable opportunity.
void	timerExec(int milliseconds, java.lang.Runnable runnable) Causes the run() method of the runnable to be invoked by the user-interface thread after the specified number of milliseconds have elapsed.
(package private) boolean	translateAccelerator(MSG msg, Control control)
(package private) static int	translateKey(int key)
(package private) boolean	translateMnemonic(MSG msg, Control control)
(package private) boolean	translateTraversal(MSG msg, Control control)
(package private) static int	untranslateKey(int key)
void	update() Forces all outstanding paint requests for the display to be processed before this method returns.
(package private) void	updateImages()
void	wake() If the receiver's user-interface thread was sleeping, causes it to be awakened and start running again.
(package private) void	wakeThread()
(package private) static int	wcsToMbcs(char ch)
(package private) static int	wcsToMbcs(char ch, int codePage)
(package private) int	windowProc(int hwnd, int msg, int wParam, int lParam)
(package private) static char[]	withCrLf(char[] string)
(package private) static java.lang.String	withCrLf(java.lang.String string)

Methods inherited from class org.eclipse.swt.graphics.Device

dispose, getDepth, getDeviceData, getDPI, getFontList, getWarnings, isDisposed, loadFont, setWarnings

Methods inherited from class java.lang.Object

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

Field Detail

msg

public MSG msg

the handle to the OS message queue (Warning: This field is platform dependent)

IMPORTANT: This field 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 is not available on all platforms and should never be accessed from application code.

APP_NAME

static java.lang.String APP_NAME

APP_VERSION

static java.lang.String APP_VERSION

eventQueue

Event[] eventQueue

windowCallback

Callback windowCallback

windowProc

int windowProc

threadId

int threadId

windowClass

TCHAR windowClass

windowShadowClass

TCHAR windowShadowClass

windowOwnDCClass

TCHAR windowOwnDCClass

WindowClassCount

static int WindowClassCount

WindowName

static final java.lang.String WindowName

See Also:

Constant Field Values

WindowShadowName

static final java.lang.String WindowShadowName

See Also:

Constant Field Values

WindowOwnDCName

static final java.lang.String WindowOwnDCName

See Also:

Constant Field Values

eventTable

EventTable eventTable

filterTable

EventTable filterTable

useOwnDC

boolean useOwnDC

freeSlot

int freeSlot

indexTable

int[] indexTable

lastControl

Control lastControl

lastGetControl

Control lastGetControl

lastHwnd

int lastHwnd

lastGetHwnd

int lastGetHwnd

controlTable

Control[] controlTable

GROW_SIZE

static final int GROW_SIZE

See Also:

Constant Field Values

SWT_OBJECT_INDEX

static final int SWT_OBJECT_INDEX

USE_PROPERTY

static final boolean USE_PROPERTY

lpStartupInfo

static STARTUPINFO lpStartupInfo

hButtonTheme

int hButtonTheme

hEditTheme

int hEditTheme

hExplorerBarTheme

int hExplorerBarTheme

hScrollBarTheme

int hScrollBarTheme

hTabTheme

int hTabTheme

BUTTON

static final char[] BUTTON

EDIT

static final char[] EDIT

EXPLORER

static final char[] EXPLORER

EXPLORERBAR

static final char[] EXPLORERBAR

SCROLLBAR

static final char[] SCROLLBAR

LISTVIEW

static final char[] LISTVIEW

TAB

static final char[] TAB

TREEVIEW

static final char[] TREEVIEW

focusEvent

int focusEvent

focusControl

Control focusControl

fixFocus

boolean fixFocus

bars

Menu[] bars

popups

Menu[] popups

items

MenuItem[] items

ID_START

static final int ID_START

See Also:

Constant Field Values

msgFilterCallback

Callback msgFilterCallback

msgFilterProc

int msgFilterProc

filterHook

int filterHook

hookMsg

MSG hookMsg

runDragDrop

boolean runDragDrop

dragCancelled

boolean dragCancelled

foregroundIdleCallback

Callback foregroundIdleCallback

foregroundIdleProc

int foregroundIdleProc

idleHook

int idleHook

ignoreNextKey

boolean ignoreNextKey

getMsgCallback

Callback getMsgCallback

embeddedCallback

Callback embeddedCallback

getMsgProc

int getMsgProc

msgHook

int msgHook

embeddedHwnd

int embeddedHwnd

embeddedProc

int embeddedProc

AWT_WINDOW_CLASS

static final java.lang.String AWT_WINDOW_CLASS

See Also:

Constant Field Values

ACCENTS

static final short[] ACCENTS

synchronizer

Synchronizer synchronizer

runMessages

boolean runMessages

runMessagesInIdle

boolean runMessagesInIdle

runMessagesInMessageProc

boolean runMessagesInMessageProc

RUN_MESSAGES_IN_IDLE_KEY

static final java.lang.String RUN_MESSAGES_IN_IDLE_KEY

See Also:

Constant Field Values

RUN_MESSAGES_IN_MESSAGE_PROC_KEY

static final java.lang.String RUN_MESSAGES_IN_MESSAGE_PROC_KEY

See Also:

Constant Field Values

USE_OWNDC_KEY

static final java.lang.String USE_OWNDC_KEY

See Also:

Constant Field Values

ACCEL_KEY_HIT

static final java.lang.String ACCEL_KEY_HIT

See Also:

Constant Field Values

thread

java.lang.Thread thread

disposeList

java.lang.Runnable[] disposeList

layoutDeferred

Composite[] layoutDeferred

layoutDeferredCount

int layoutDeferredCount

tray

Tray tray

nextTrayId

int nextTrayId

taskBar

TaskBar taskBar

TASKBAR_EVENT

static final java.lang.String TASKBAR_EVENT

See Also:

Constant Field Values

LAUNCHER_PREFIX

static final java.lang.String LAUNCHER_PREFIX

See Also:

Constant Field Values

timerIds

int[] timerIds

timerList

java.lang.Runnable[] timerList

nextTimerId

int nextTimerId

SETTINGS_ID

static final int SETTINGS_ID

See Also:

Constant Field Values

SETTINGS_DELAY

static final int SETTINGS_DELAY

See Also:

Constant Field Values

lastHighContrast

boolean lastHighContrast

sendSettings

boolean sendSettings

clickRect

RECT clickRect

clickCount

int clickCount

lastTime

int lastTime

lastButton

int lastButton

lastClickHwnd

int lastClickHwnd

scrollRemainder

int scrollRemainder

scrollHRemainder

int scrollHRemainder

lastKey

int lastKey

lastMouse

int lastMouse

lastAscii

int lastAscii

lastVirtual

boolean lastVirtual

lastNull

boolean lastNull

lastDead

boolean lastDead

keyboard

byte[] keyboard

accelKeyHit

boolean accelKeyHit

mnemonicKeyHit

boolean mnemonicKeyHit

lockActiveWindow

boolean lockActiveWindow

captureChanged

boolean captureChanged

xMouse

boolean xMouse

magStartDistance

double magStartDistance

lastDistance

double lastDistance

rotationAngle

double rotationAngle

lastX

int lastX

lastY

int lastY

touchSources

TouchSource[] touchSources

nextToolTipId

int nextToolTipId

ignoreRestoreFocus

boolean ignoreRestoreFocus

lastHittestControl

Control lastHittestControl

lastHittest

int lastHittest

messageCallback

Callback messageCallback

hwndMessage

int hwndMessage

messageProc

int messageProc

lfSystemFont

LOGFONT lfSystemFont

systemFont

Font systemFont

errorImage

Image errorImage

infoImage

Image infoImage

questionImage

Image questionImage

warningIcon

Image warningIcon

cursors

Cursor[] cursors

resources

Resource[] resources

RESOURCE_SIZE

static final int RESOURCE_SIZE

See Also:

Constant Field Values

imageList

ImageList[] imageList

toolImageList

ImageList[] toolImageList

toolHotImageList

ImageList[] toolHotImageList

toolDisabledImageList

ImageList[] toolDisabledImageList

lpCustColors

int lpCustColors

upArrow

Image upArrow

downArrow

Image downArrow

tableBuffer

char[] tableBuffer

hdr

NMHDR hdr

plvfi

NMLVDISPINFO plvfi

hwndParent

int hwndParent

columnCount

int columnCount

columnVisible

boolean[] columnVisible

resizeCount

int resizeCount

RESIZE_LIMIT

static final int RESIZE_LIMIT

See Also:

Constant Field Values

data

java.lang.Object data

keys

java.lang.String[] keys

values

java.lang.Object[] values

KeyTable

static final int[][] KeyTable

Default

static Display Default

Displays

static Display[] Displays

monitors

Monitor[] monitors

monitorCount

int monitorCount

modalShells

Shell[] modalShells

modalDialog

Dialog modalDialog

TrimEnabled

static boolean TrimEnabled

SWT_GETACCELCOUNT

static final int SWT_GETACCELCOUNT

See Also:

Constant Field Values

SWT_GETACCEL

static final int SWT_GETACCEL

See Also:

Constant Field Values

SWT_KEYMSG

static final int SWT_KEYMSG

See Also:

Constant Field Values

SWT_DESTROY

static final int SWT_DESTROY

See Also:

Constant Field Values

SWT_TRAYICONMSG

static final int SWT_TRAYICONMSG

See Also:

Constant Field Values

SWT_NULL

static final int SWT_NULL

See Also:

Constant Field Values

SWT_RUNASYNC

static final int SWT_RUNASYNC

See Also:

Constant Field Values

TASKBARCREATED

static int TASKBARCREATED

TASKBARBUTTONCREATED

static int TASKBARBUTTONCREATED

SWT_RESTORECARET

static int SWT_RESTORECARET

DI_GETDRAGIMAGE

static int DI_GETDRAGIMAGE

SWT_OPENDOC

static int SWT_OPENDOC

hitCount

int hitCount

skinList

Widget[] skinList

skinCount

int skinCount

PACKAGE_PREFIX

static final java.lang.String PACKAGE_PREFIX

See Also:

Constant Field Values

Constructor Detail

Display

public Display()

Constructs a new instance of this class.

Note: The resulting display is marked as the current display. If this is the first display which has been constructed since the application started, it is also marked as the default display.

Throws:

SWTException -

• ERROR_THREAD_INVALID_ACCESS - if called from a thread that already created an existing display
• ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass

See Also:

getCurrent(), getDefault(), Widget.checkSubclass(), Shell

Display

public Display(DeviceData data)

Constructs a new instance of this class using the parameter.

Parameters:

data - the device data

Method Detail

setDevice

static void setDevice(Device device)

_getFocusControl

Control _getFocusControl()

addBar

void addBar(Menu menu)

addControl

void addControl(int handle,
              Control control)

addSkinnableWidget

void addSkinnableWidget(Widget widget)

addFilter

public void addFilter(int eventType,
             Listener listener)

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

Setting the type of an event to SWT.None from within the handleEvent() method can be used to change the event type and stop subsequent Java listeners from running. Because event filters run before other listeners, event filters can both block other listeners and set arbitrary fields within an event. For this reason, event filters are both powerful and dangerous. They should generally be avoided for performance, debugging and code maintenance reasons.

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_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
• ERROR_DEVICE_DISPOSED - if the receiver has been disposed

Since:

3.0

See Also:

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

addLayoutDeferred

void addLayoutDeferred(Composite comp)

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. The event type is one of the event constants defined in class SWT. When the event does occur in the display, the listener is notified by sending it the handleEvent() message.

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_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
• ERROR_DEVICE_DISPOSED - if the receiver has been disposed

Since:

2.0

See Also:

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

addMenuItem

void addMenuItem(MenuItem item)

addPopup

void addPopup(Menu menu)

asciiKey

int asciiKey(int key)

asyncExec

public void asyncExec(java.lang.Runnable runnable)

Causes the run() method of the runnable to be invoked by the user-interface thread at the next reasonable opportunity. The caller of this method continues to run in parallel, and is not notified when the runnable has completed. Specifying null as the runnable simply wakes the user-interface thread when run.

Note that at the time the runnable is invoked, widgets that have the receiver as their display may have been disposed. Therefore, it is necessary to check for this case inside the runnable before accessing the widget.

Parameters:

runnable - code to run on the user-interface thread or null

Throws:

SWTException -

• ERROR_DEVICE_DISPOSED - if the receiver has been disposed

See Also:

syncExec(java.lang.Runnable)

beep

public void beep()

Causes the system hardware to emit a short sound (if it supports this capability).

Throws:

SWTException -

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

checkSubclass

protected void checkSubclass()

Checks that this class can be subclassed.

IMPORTANT: See the comment in Widget.checkSubclass().

Throws:

SWTException -

• ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass

See Also:

Widget.checkSubclass()

checkDevice

protected void checkDevice()

Description copied from class: Device

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 device implementors to enforce the standard SWT invariants.

Currently, it is an error to invoke any method (other than isDisposed() and dispose()) on a device that has had its dispose() method called.

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

Overrides:

checkDevice in class Device

checkDisplay

static void checkDisplay(java.lang.Thread thread,
                boolean multiple)

clearModal

void clearModal(Shell shell)

controlKey

int controlKey(int key)

close

public void close()

Requests that the connection between SWT and the underlying operating system be closed.

Throws:

SWTException -

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

Since:

2.0

See Also:

Device.dispose()

create

protected void create(DeviceData data)

Creates the device in the operating system. If the device does not have a handle, this method may do nothing depending on the device.

This method is called before init.

Overrides:

create in class Device

Parameters:

data - the DeviceData which describes the receiver

See Also:

init()

createDisplay

void createDisplay(DeviceData data)

create32bitDIB

static int create32bitDIB(Image image)

create32bitDIB

static int create32bitDIB(int hBitmap,
                 int alpha,
                 byte[] alphaData,
                 int transparentPixel)

createIcon

static Image createIcon(Image image)

createMaskFromAlpha

static int createMaskFromAlpha(ImageData data,
                      int destWidth,
                      int destHeight)

deregister

static void deregister(Display display)

destroy

protected void destroy()

Destroys the device in the operating system and releases the device's handle. If the device does not have a handle, this method may do nothing depending on the device.

This method is called after release.

Overrides:

destroy in class Device

See Also:

Device.dispose(), release()

destroyDisplay

void destroyDisplay()

disposeExec

public void disposeExec(java.lang.Runnable runnable)

Causes the run() method of the runnable to be invoked by the user-interface thread just before the receiver is disposed. Specifying a null runnable is ignored.

Parameters:

runnable - code to run at dispose time.

Throws:

SWTException -

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

drawMenuBars

void drawMenuBars()

embeddedProc

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

error

void error(int code)

Does whatever display 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)

filterEvent

boolean filterEvent(Event event)

filters

boolean filters(int eventType)

filterMessage

boolean filterMessage(MSG msg)

findControl

Control findControl(int handle)

findWidget

public Widget findWidget(int handle)

Given the operating system handle for a widget, returns the instance of the Widget subclass which represents it in the currently running application, if such exists, or null if no matching widget can be found.

IMPORTANT: This method should not be called from application code. The arguments are platform-specific.

Parameters:

handle - the handle for the widget

Returns:

the SWT widget that the handle represents

Throws:

SWTException -

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

findWidget

public Widget findWidget(int handle,
                int id)

Given the operating system handle for a widget, and widget-specific id, returns the instance of the Widget subclass which represents the handle/id pair in the currently running application, if such exists, or null if no matching widget can be found.

IMPORTANT: This method should not be called from application code. The arguments are platform-specific.

Parameters:

handle - the handle for the widget

id - the id for the subwidget (usually an item)

Returns:

the SWT widget that the handle/id pair represents

Throws:

SWTException -

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

Since:

3.1

findWidget

public Widget findWidget(Widget widget,
                int id)

Given a widget and a widget-specific id, returns the instance of the Widget subclass which represents the widget/id pair in the currently running application, if such exists, or null if no matching widget can be found.

Parameters:

widget - the widget

id - the id for the subwidget (usually an item)

Returns:

the SWT subwidget (usually an item) that the widget/id pair represents

Throws:

SWTException -

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

Since:

3.3

foregroundIdleProc

int foregroundIdleProc(int code,
                     int wParam,
                     int lParam)

findDisplay

public static Display findDisplay(java.lang.Thread thread)

Returns the display which the given thread is the user-interface thread for, or null if the given thread is not a user-interface thread for any display. Specifying null as the thread will return null for the display.

Parameters:

thread - the user-interface thread

Returns:

the display for the given thread

findTouchSource

TouchSource findTouchSource(int touchDevice,
                          Monitor monitor)

getActiveShell

public Shell getActiveShell()

Returns the currently active Shell, or null if no shell belonging to the currently running application is active.

Returns:

the active shell or null

Throws:

SWTException -

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

getMenuBar

public Menu getMenuBar()

Returns the single instance of the application menu bar, or null if there is no application menu bar for the platform.

Returns:

the application menu bar, or null

Throws:

SWTException -

• ERROR_DEVICE_DISPOSED - if the receiver has been disposed

Since:

3.7

getBounds

public Rectangle getBounds()

Returns a rectangle describing the receiver's size and location. Note that on multi-monitor systems the origin can be negative.

Overrides:

getBounds in class Device

Returns:

the bounding rectangle

Throws:

SWTException -

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

getCurrent

public static Display getCurrent()

Returns the display which the currently running thread is the user-interface thread for, or null if the currently running thread is not a user-interface thread for any display.

Returns:

the current display

getClickCount

int getClickCount(int type,
                int button,
                int hwnd,
                int lParam)

getClientArea

public Rectangle getClientArea()

Returns a rectangle which describes the area of the receiver which is capable of displaying data.

Overrides:

getClientArea in class Device

Returns:

the client area

Throws:

SWTException -

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

See Also:

getBounds()

getControl

Control getControl(int handle)

getCursorControl

public Control getCursorControl()

Returns the control which the on-screen pointer is currently over top of, or null if it is not currently over one of the controls built by the currently running application.

Returns:

the control under the cursor or null

Throws:

SWTException -

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

getCursorLocation

public Point getCursorLocation()

Returns the location of the on-screen pointer relative to the top left corner of the screen.

Returns:

the cursor location

Throws:

SWTException -

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

getCursorSizes

public Point[] getCursorSizes()

Returns an array containing the recommended cursor sizes.

Returns:

the array of cursor sizes

Throws:

SWTException -

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

Since:

3.0

getDefault

public static Display getDefault()

Returns the default display. One is created (making the thread that invokes this method its user-interface thread) if it did not already exist.

Returns:

the default display

isValidClass

static boolean isValidClass(java.lang.Class clazz)

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 display is disposed of, it is the application's responsibility to provide a disposeExec() handler which does 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_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
• ERROR_DEVICE_DISPOSED - if the receiver has been disposed

See Also:

setData(String, Object), disposeExec(Runnable)

getData

public java.lang.Object getData()

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

Applications may put arbitrary objects in this field. If the object stored in the display specific data needs to be notified when the display is disposed of, it is the application's responsibility to provide a disposeExec() handler which does so.

Returns:

the display specific data

Throws:

SWTException -

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

See Also:

setData(Object), disposeExec(Runnable)

getDismissalAlignment

public int getDismissalAlignment()

Returns the button dismissal alignment, one of LEFT or RIGHT. The button dismissal alignment is the ordering that should be used when positioning the default dismissal button for a dialog. For example, in a dialog that contains an OK and CANCEL button, on platforms where the button dismissal alignment is LEFT, the button ordering should be OK/CANCEL. When button dismissal alignment is RIGHT, the button ordering should be CANCEL/OK.

Returns:

the button dismissal order

Throws:

SWTException -

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

Since:

2.1

getDoubleClickTime

public int getDoubleClickTime()

Returns the longest duration, in milliseconds, between two mouse button clicks that will be considered a double click by the underlying operating system.

Returns:

the double click time

Throws:

SWTException -

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

getFocusControl

public Control getFocusControl()

Returns the control which currently has keyboard focus, or null if keyboard events are not currently going to any of the controls built by the currently running application.

Returns:

the focus control or null

Throws:

SWTException -

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

getFontName

java.lang.String getFontName(LOGFONT logFont)

getHighContrast

public boolean getHighContrast()

Returns true when the high contrast mode is enabled. Otherwise, false is returned.

Note: This operation is a hint and is not supported on platforms that do not have this concept.

Returns:

the high contrast mode

Throws:

SWTException -

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

Since:

3.0

getIconDepth

public int getIconDepth()

Returns the maximum allowed depth of icons on this display, in bits per pixel. On some platforms, this may be different than the actual depth of the display.

Returns:

the maximum icon depth

Throws:

SWTException -

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

See Also:

Device.getDepth()

getIconSizes

public Point[] getIconSizes()

Returns an array containing the recommended icon sizes.

Returns:

the array of icon sizes

Throws:

SWTException -

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

Since:

3.0

See Also:

Decorations.setImages(Image[])

getImageList

ImageList getImageList(int style,
                     int width,
                     int height)

getImageListToolBar

ImageList getImageListToolBar(int style,
                            int width,
                            int height)

getImageListToolBarDisabled

ImageList getImageListToolBarDisabled(int style,
                                    int width,
                                    int height)

getImageListToolBarHot

ImageList getImageListToolBarHot(int style,
                               int width,
                               int height)

getLastEventTime

int getLastEventTime()

getMenuItem

MenuItem getMenuItem(int id)

getMessageCount

int getMessageCount()

getModalShell

Shell getModalShell()

getModalDialog

Dialog getModalDialog()

getMonitors

public Monitor[] getMonitors()

Returns an array of monitors attached to the device.

Returns:

the array of monitors

Since:

3.0

getMsgProc

int getMsgProc(int code,
             int wParam,
             int lParam)

getPrimaryMonitor

public Monitor getPrimaryMonitor()

Returns the primary monitor for that device.

Returns:

the primary monitor

Since:

3.0

getShells

public Shell[] getShells()

Returns a (possibly empty) array containing all shells which have not been disposed and have the receiver as their display.

Returns:

the receiver's shells

Throws:

SWTException -

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

getSortImage

Image getSortImage(int direction)

getSynchronizer

public Synchronizer getSynchronizer()

Gets the synchronizer used by the display.

Returns:

the receiver's synchronizer

Throws:

SWTException -

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

Since:

3.4

getSyncThread

public java.lang.Thread getSyncThread()

Returns the thread that has invoked syncExec or null if no such runnable is currently being invoked by the user-interface thread.

Note: If a runnable invoked by asyncExec is currently running, this method will return null.

Returns:

the receiver's sync-interface thread

Throws:

SWTException -

• ERROR_DEVICE_DISPOSED - if the receiver has been disposed

getSystemColor

public Color getSystemColor(int id)

Returns the matching standard color for the given constant, which should be one of the color constants specified in class SWT. Any value other than one of the SWT color constants which is passed in will result in the color black. This color should not be free'd because it was allocated by the system, not the application.

Overrides:

getSystemColor in class Device

Parameters:

id - the color constant

Returns:

the matching color

Throws:

SWTException -

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

See Also:

SWT

getSystemCursor

public Cursor getSystemCursor(int id)

Returns the matching standard platform cursor for the given constant, which should be one of the cursor constants specified in class SWT. This cursor should not be free'd because it was allocated by the system, not the application. A value of null will be returned if the supplied constant is not an SWT cursor constant.

Parameters:

id - the SWT cursor constant

Returns:

the corresponding cursor or null

Throws:

SWTException -

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

Since:

3.0

See Also:

SWT.CURSOR_ARROW, SWT.CURSOR_WAIT, SWT.CURSOR_CROSS, SWT.CURSOR_APPSTARTING, SWT.CURSOR_HELP, SWT.CURSOR_SIZEALL, SWT.CURSOR_SIZENESW, SWT.CURSOR_SIZENS, SWT.CURSOR_SIZENWSE, SWT.CURSOR_SIZEWE, SWT.CURSOR_SIZEN, SWT.CURSOR_SIZES, SWT.CURSOR_SIZEE, SWT.CURSOR_SIZEW, SWT.CURSOR_SIZENE, SWT.CURSOR_SIZESE, SWT.CURSOR_SIZESW, SWT.CURSOR_SIZENW, SWT.CURSOR_UPARROW, SWT.CURSOR_IBEAM, SWT.CURSOR_NO, SWT.CURSOR_HAND

getSystemFont

public Font getSystemFont()

Returns a reasonable font for applications to use. On some platforms, this will match the "default font" or "system font" if such can be found. This font should not be free'd because it was allocated by the system, not the application.

Typically, applications which want the default look should simply not set the font on the widgets they create. Widgets are always created with the correct default font for the class of user-interface component they represent.

Overrides:

getSystemFont in class Device

Returns:

a font

Throws:

SWTException -

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

getSystemImage

public Image getSystemImage(int id)

Returns the matching standard platform image for the given constant, which should be one of the icon constants specified in class SWT. This image should not be free'd because it was allocated by the system, not the application. A value of null will be returned either if the supplied constant is not an SWT icon constant or if the platform does not define an image that corresponds to the constant.

Parameters:

id - the SWT icon constant

Returns:

the corresponding image or null

Throws:

SWTException -

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

Since:

3.0

See Also:

SWT.ICON_ERROR, SWT.ICON_INFORMATION, SWT.ICON_QUESTION, SWT.ICON_WARNING, SWT.ICON_WORKING

getSystemMenu

public Menu getSystemMenu()

Returns the single instance of the system-provided menu for the application, or null on platforms where no menu is provided for the application.

Returns:

the system menu, or null

Throws:

SWTException -

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

Since:

3.7

getSystemTaskBar

public TaskBar getSystemTaskBar()

Returns the single instance of the system taskBar or null when there is no system taskBar available for the platform.

Returns:

the system taskBar or null

Throws:

SWTException -

• ERROR_DEVICE_DISPOSED - if the receiver has been disposed

Since:

3.6

getSystemTray

public Tray getSystemTray()

Returns the single instance of the system tray or null when there is no system tray available for the platform.

Returns:

the system tray or null

Throws:

SWTException -

• ERROR_DEVICE_DISPOSED - if the receiver has been disposed

Since:

3.0

getThread

public java.lang.Thread getThread()

Returns the user-interface thread for the receiver.

Returns:

the receiver's user-interface thread

Throws:

SWTException -

• ERROR_DEVICE_DISPOSED - if the receiver has been disposed

getTouchEnabled

public boolean getTouchEnabled()

Returns a boolean indicating whether a touch-aware input device is attached to the system and is ready for use.

Returns:

true if a touch-aware input device is detected, or false otherwise

Throws:

SWTException -

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

Since:

3.7

hButtonTheme

int hButtonTheme()

hEditTheme

int hEditTheme()

hExplorerBarTheme

int hExplorerBarTheme()

hScrollBarTheme

int hScrollBarTheme()

hTabTheme

int hTabTheme()

internal_new_GC

public int internal_new_GC(GCData data)

Invokes platform specific functionality to allocate a new GC handle.

IMPORTANT: This method is not part of the public API for Display. It is marked public only so that it can be shared within the packages provided by SWT. It is not available on all platforms, and should never be called from application code.

Specified by:

internal_new_GC in interface Drawable

Specified by:

internal_new_GC in class Device

Parameters:

data - the platform specific GC data

Returns:

the platform specific GC handle

Throws:

SWTException -

• ERROR_DEVICE_DISPOSED - if the receiver has been disposed

SWTError -

• ERROR_NO_HANDLES if a handle could not be obtained for gc creation

init

protected void init()

Initializes any internal resources needed by the device.

This method is called after create.

Overrides:

init in class Device

See Also:

create(org.eclipse.swt.graphics.DeviceData)

internal_dispose_GC

public void internal_dispose_GC(int hDC,
                       GCData data)

Invokes platform specific functionality to dispose a GC handle.

IMPORTANT: This method is not part of the public API for Display. It is marked public only so that it can be shared within the packages provided by SWT. It is not available on all platforms, and should never be called from application code.

Specified by:

internal_dispose_GC in interface Drawable

Specified by:

internal_dispose_GC in class Device

Parameters:

hDC - the platform specific GC handle

data - the platform specific GC data

isXMouseActive

boolean isXMouseActive()

isValidThread

boolean isValidThread()

map

public Point map(Control from,
        Control to,
        Point point)

Maps a point from one coordinate system to another. When the control is null, coordinates are mapped to the display.

NOTE: On right-to-left platforms where the coordinate systems are mirrored, special care needs to be taken when mapping coordinates from one control to another to ensure the result is correctly mirrored. Mapping a point that is the origin of a rectangle and then adding the width and height is not equivalent to mapping the rectangle. When one control is mirrored and the other is not, adding the width and height to a point that was mapped causes the rectangle to extend in the wrong direction. Mapping the entire rectangle instead of just one point causes both the origin and the corner of the rectangle to be mapped.

Parameters:

from - the source Control or null

to - the destination Control or null

point - to be mapped

Returns:

point with mapped coordinates

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the point is null
• ERROR_INVALID_ARGUMENT - if the Control from or the Control to have been disposed

SWTException -

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

Since:

2.1.2

map

public Point map(Control from,
        Control to,
        int x,
        int y)

Maps a point from one coordinate system to another. When the control is null, coordinates are mapped to the display.

NOTE: On right-to-left platforms where the coordinate systems are mirrored, special care needs to be taken when mapping coordinates from one control to another to ensure the result is correctly mirrored. Mapping a point that is the origin of a rectangle and then adding the width and height is not equivalent to mapping the rectangle. When one control is mirrored and the other is not, adding the width and height to a point that was mapped causes the rectangle to extend in the wrong direction. Mapping the entire rectangle instead of just one point causes both the origin and the corner of the rectangle to be mapped.

Parameters:

from - the source Control or null

to - the destination Control or null

x - coordinates to be mapped

y - coordinates to be mapped

Returns:

point with mapped coordinates

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_ARGUMENT - if the Control from or the Control to have been disposed

SWTException -

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

Since:

2.1.2

map

public Rectangle map(Control from,
            Control to,
            Rectangle rectangle)

Maps a point from one coordinate system to another. When the control is null, coordinates are mapped to the display.

NOTE: On right-to-left platforms where the coordinate systems are mirrored, special care needs to be taken when mapping coordinates from one control to another to ensure the result is correctly mirrored. Mapping a point that is the origin of a rectangle and then adding the width and height is not equivalent to mapping the rectangle. When one control is mirrored and the other is not, adding the width and height to a point that was mapped causes the rectangle to extend in the wrong direction. Mapping the entire rectangle instead of just one point causes both the origin and the corner of the rectangle to be mapped.

Parameters:

from - the source Control or null

to - the destination Control or null

rectangle - to be mapped

Returns:

rectangle with mapped coordinates

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the rectangle is null
• ERROR_INVALID_ARGUMENT - if the Control from or the Control to have been disposed

SWTException -

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

Since:

2.1.2

map

public Rectangle map(Control from,
            Control to,
            int x,
            int y,
            int width,
            int height)

Maps a point from one coordinate system to another. When the control is null, coordinates are mapped to the display.

NOTE: On right-to-left platforms where the coordinate systems are mirrored, special care needs to be taken when mapping coordinates from one control to another to ensure the result is correctly mirrored. Mapping a point that is the origin of a rectangle and then adding the width and height is not equivalent to mapping the rectangle. When one control is mirrored and the other is not, adding the width and height to a point that was mapped causes the rectangle to extend in the wrong direction. Mapping the entire rectangle instead of just one point causes both the origin and the corner of the rectangle to be mapped.

Parameters:

from - the source Control or null

to - the destination Control or null

x - coordinates to be mapped

y - coordinates to be mapped

width - coordinates to be mapped

height - coordinates to be mapped

Returns:

rectangle with mapped coordinates

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_ARGUMENT - if the Control from or the Control to have been disposed

SWTException -

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

Since:

2.1.2

mbcsToWcs

static char mbcsToWcs(int ch)

mbcsToWcs

static char mbcsToWcs(int ch,
             int codePage)

messageProc

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

getSharedData

java.lang.String getSharedData(int pid,
                             int handle)

monitorEnumProc

int monitorEnumProc(int hmonitor,
                  int hdc,
                  int lprcMonitor,
                  int dwData)

msgFilterProc

int msgFilterProc(int code,
                int wParam,
                int lParam)

numpadKey

int numpadKey(int key)

post

public boolean post(Event event)

Generate a low level system event. post is used to generate low level keyboard and mouse events. The intent is to enable automated UI testing by simulating the input from the user. Most SWT applications should never need to call this method.

Note that this operation can fail when the operating system fails to generate the event for any reason. For example, this can happen when there is no such key or mouse button or when the system event queue is full.

Event Types:

KeyDown, KeyUp

The following fields in the Event apply:

• (in) type KeyDown or KeyUp

Either one of:

• (in) character a character that corresponds to a keyboard key
• (in) keyCode the key code of the key that was typed, as defined by the key code constants in class SWT

MouseDown, MouseUp

The following fields in the Event apply:

• (in) type MouseDown or MouseUp
• (in) button the button that is pressed or released

MouseMove

The following fields in the Event apply:

• (in) type MouseMove
• (in) x the x coordinate to move the mouse pointer to in screen coordinates
• (in) y the y coordinate to move the mouse pointer to in screen coordinates

MouseWheel

The following fields in the Event apply:

• (in) type MouseWheel
• (in) detail either SWT.SCROLL_LINE or SWT.SCROLL_PAGE
• (in) count the number of lines or pages to scroll

Parameters:

event - the event to be generated

Returns:

true if the event was generated or false otherwise

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the event is null

SWTException -

• ERROR_DEVICE_DISPOSED - if the receiver has been disposed

Since:

3.0

postEvent

void postEvent(Event event)

readAndDispatch

public boolean readAndDispatch()

Reads an event from the operating system's event queue, dispatches it appropriately, and returns true if there is potentially more work to do, or false if the caller can sleep until another event is placed on the event queue.

In addition to checking the system event queue, this method also checks if any inter-thread messages (created by syncExec() or asyncExec()) are waiting to be processed, and if so handles them before returning.

Returns:

false if the caller can sleep upon return from this method

Throws:

SWTException -

• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
• ERROR_DEVICE_DISPOSED - if the receiver has been disposed
• ERROR_FAILED_EXEC - if an exception occurred while running an inter-thread message

See Also:

sleep(), wake()

register

static void register(Display display)

release

protected void release()

Releases any internal resources back to the operating system and clears all fields except the device handle.

Disposes all shells which are currently open on the display. After this method has been invoked, all related related shells will answer true when sent the message isDisposed().

When a device is destroyed, resources that were acquired on behalf of the programmer need to be returned to the operating system. For example, if the device allocated a font to be used as the system font, this font would be freed in release. Also,to assist the garbage collector and minimize the amount of memory that is not reclaimed when the programmer keeps a reference to a disposed device, all fields except the handle are zero'd. The handle is needed by destroy.

This method is called before destroy.

Overrides:

release in class Device

See Also:

Device.dispose(), destroy()

releaseDisplay

void releaseDisplay()

releaseImageList

void releaseImageList(ImageList list)

releaseToolImageList

void releaseToolImageList(ImageList list)

releaseToolHotImageList

void releaseToolHotImageList(ImageList list)

releaseToolDisabledImageList

void releaseToolDisabledImageList(ImageList list)

removeFilter

public void removeFilter(int eventType,
                Listener listener)

Removes the listener from the collection of listeners who will be notified when an event of the given type occurs anywhere in a widget. 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 when the event occurs

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

SWTException -

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

Since:

3.0

See Also:

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

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_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
• ERROR_DEVICE_DISPOSED - if the receiver has been disposed

Since:

2.0

See Also:

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

removeBar

void removeBar(Menu menu)

removeControl

Control removeControl(int handle)

removeMenuItem

void removeMenuItem(MenuItem item)

removePopup

void removePopup(Menu menu)

runAsyncMessages

boolean runAsyncMessages(boolean all)

runDeferredEvents

boolean runDeferredEvents()

runDeferredLayouts

boolean runDeferredLayouts()

runPopups

boolean runPopups()

runSettings

void runSettings()

runSkin

boolean runSkin()

runTimer

boolean runTimer(int id)

saveResources

void saveResources()

sendEvent

void sendEvent(int eventType,
             Event event)

setCursorLocation

public void setCursorLocation(int x,
                     int y)

Sets the location of the on-screen pointer relative to the top left corner of the screen. Note: It is typically considered bad practice for a program to move the on-screen pointer location.

Parameters:

x - the new x coordinate for the cursor

y - the new y coordinate for the cursor

Throws:

SWTException -

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

Since:

2.1

setCursorLocation

public void setCursorLocation(Point point)

Sets the location of the on-screen pointer relative to the top left corner of the screen. Note: It is typically considered bad practice for a program to move the on-screen pointer location.

Parameters:

point - new position

Throws:

SWTException -

• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
• ERROR_NULL_ARGUMENT - if the point is null
• ERROR_DEVICE_DISPOSED - if the receiver has been disposed

Since:

2.0

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 argument.

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 display is disposed of, it is the application's responsibility provide a disposeExec() handler which does 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_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
• ERROR_DEVICE_DISPOSED - if the receiver has been disposed

See Also:

getData(String), disposeExec(Runnable)

setData

public void setData(java.lang.Object data)

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

Applications may put arbitrary objects in this field. If the object stored in the display specific data needs to be notified when the display is disposed of, it is the application's responsibility provide a disposeExec() handler which does so.

Parameters:

data - the new display specific data

Throws:

SWTException -

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

See Also:

getData(), disposeExec(Runnable)

getAppName

public static java.lang.String getAppName()

Returns the application name.

Returns:

the application name

Since:

3.6

See Also:

setAppName(String)

getAppVersion

public static java.lang.String getAppVersion()

Returns the application version.

Returns:

the application version

Since:

3.6

See Also:

setAppVersion(String)

setAppName

public static void setAppName(java.lang.String name)

Sets the application name to the argument.

The application name can be used in several ways, depending on the platform and tools being used. On Motif, for example, this can be used to set the name used for resource lookup. Accessibility tools may also ask for the application name.

Specifying null for the name clears it.

Parameters:

name - the new app name or null

setAppVersion

public static void setAppVersion(java.lang.String version)

Sets the application version to the argument.

Parameters:

version - the new app version

Since:

3.6

setModalDialog

void setModalDialog(Dialog modalDailog)

setModalShell

void setModalShell(Shell shell)

setSynchronizer

public void setSynchronizer(Synchronizer synchronizer)

Sets the synchronizer used by the display to be the argument, which can not be null.

Parameters:

synchronizer - the new synchronizer for the display (must not be null)

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the synchronizer is null

SWTException -

• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
• ERROR_DEVICE_DISPOSED - if the receiver has been disposed
• ERROR_FAILED_EXEC - if an exception occurred while running an inter-thread message

shiftedKey

int shiftedKey(int key)

sleep

public boolean sleep()

Causes the user-interface thread to sleep (that is, to be put in a state where it does not consume CPU cycles) until an event is received or it is otherwise awakened.

Returns:

true if an event requiring dispatching was placed on the queue.

Throws:

SWTException -

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

See Also:

wake()

syncExec

public void syncExec(java.lang.Runnable runnable)

Causes the run() method of the runnable to be invoked by the user-interface thread at the next reasonable opportunity. The thread which calls this method is suspended until the runnable completes. Specifying null as the runnable simply wakes the user-interface thread.

Note that at the time the runnable is invoked, widgets that have the receiver as their display may have been disposed. Therefore, it is necessary to check for this case inside the runnable before accessing the widget.

Parameters:

runnable - code to run on the user-interface thread or null

Throws:

SWTException -

• ERROR_FAILED_EXEC - if an exception occurred when executing the runnable
• ERROR_DEVICE_DISPOSED - if the receiver has been disposed

See Also:

asyncExec(java.lang.Runnable)

timerExec

public void timerExec(int milliseconds,
             java.lang.Runnable runnable)

Causes the run() method of the runnable to be invoked by the user-interface thread after the specified number of milliseconds have elapsed. If milliseconds is less than zero, the runnable is not executed.

Note that at the time the runnable is invoked, widgets that have the receiver as their display may have been disposed. Therefore, it is necessary to check for this case inside the runnable before accessing the widget.

Parameters:

milliseconds - the delay before running the runnable

runnable - code to run on the user-interface thread

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the runnable is null

SWTException -

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

See Also:

asyncExec(java.lang.Runnable)

translateAccelerator

boolean translateAccelerator(MSG msg,
                           Control control)

translateKey

static int translateKey(int key)

translateMnemonic

boolean translateMnemonic(MSG msg,
                        Control control)

translateTraversal

boolean translateTraversal(MSG msg,
                         Control control)

untranslateKey

static int untranslateKey(int key)

update

public void update()

Forces all outstanding paint requests for the display to be processed before this method returns.

Throws:

SWTException -

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

See Also:

Control.update()

updateImages

void updateImages()

wake

public void wake()

If the receiver's user-interface thread was sleeping, causes it to be awakened and start running again. Note that this method may be called from any thread.

Throws:

SWTException -

• ERROR_DEVICE_DISPOSED - if the receiver has been disposed

See Also:

sleep()

wakeThread

void wakeThread()

wcsToMbcs

static int wcsToMbcs(char ch,
            int codePage)

wcsToMbcs

static int wcsToMbcs(char ch)

windowProc

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

withCrLf

static java.lang.String withCrLf(java.lang.String string)

withCrLf

static char[] withCrLf(char[] string)