Class Spinner

java.lang.Object

org.eclipse.swt.widgets.Widget

org.eclipse.swt.widgets.Control

org.eclipse.swt.widgets.Scrollable

org.eclipse.swt.widgets.Composite

org.eclipse.swt.widgets.Spinner

All Implemented Interfaces:

Drawable

public class Spinner
extends Composite

Instances of this class are selectable user interface objects that allow the user to enter and modify numeric values.

Note that although this class is a subclass of Composite, it does not make sense to add children to it, or set a layout on it.

Styles:

READ_ONLY, WRAP

Events:

Selection, Modify, Verify

IMPORTANT: This class is not intended to be subclassed.

Since:

3.1

See Also:

• Spinner snippets
• SWT Example: ControlExample
• Sample code and further information

Field Summary

Fields

Modifier and Type	Field	Description
(package private) GdkRGBA	background
(package private) double	climbRate
(package private) long	entryHandle
(package private) int	fixEnd
(package private) int	fixStart
(package private) long	gdkEventKey
(package private) long	imContext
(package private) int	lastEventTime
static final int	LIMIT	the operating system limit for the number of characters that the text field in an instance of this class can hold
(package private) static final int	MIN_ARROW_WIDTH

Fields inherited from class Composite

backgroundMode, childrenLowered, embeddedHandle, fixClipHandle, fixClipMap, imHandle, layout, layoutCount, NO_INPUT_METHOD, noChildDrawing, popupChild, socketHandle, tabList

Fields inherited from class Scrollable

horizontalBar, RESIZE_ON_GETCLIENTAREA, scrolledHandle, verticalBar

Fields inherited from class Control

accessible, autoScale, backgroundAlpha, backgroundImage, cachedNoBackground, checkScaleFactor, cssBackground, cssForeground, cursor, DISABLE_EMOJI, dragDetectionQueue, dragGesture, drawCount, drawRegion, enableWindow, eventRegion, firstFixedHandle, fixedHandle, font, gestureBegin, gestureEnd, gestureRotation, gestureSwipe, gestureZoom, keyController, labelRelation, lastInput, layoutData, menu, mouseDown, panGesture, parent, provider, redrawWindow, region, regionHandle, rotateGesture, toolTipText, zoomGesture

Fields inherited from class Widget

ACTIVATE, ACTIVATE_INVERSE, AUTO_TEXT_DIRECTION, BACKGROUND, BACKSPACE, BACKSPACE_INVERSE, BUTTON_PRESS_EVENT, BUTTON_PRESS_EVENT_INVERSE, BUTTON_RELEASE_EVENT, BUTTON_RELEASE_EVENT_INVERSE, CANVAS, CHANGE_VALUE, CHANGED, CHECK_SUBWINDOW, CLICKED, CLOSE_REQUEST, COMMIT, COMPUTE_SIZE, CONFIGURE_EVENT, COPY_CLIPBOARD, COPY_CLIPBOARD_INVERSE, CREATE_MENU_PROXY, CUT_CLIPBOARD, CUT_CLIPBOARD_INVERSE, data, DAY_SELECTED, DAY_SELECTED_DOUBLE_CLICK, DECELERATE, DEFAULT_HEIGHT, DEFAULT_WIDTH, DELETE_EVENT, DELETE_FROM_CURSOR, DELETE_FROM_CURSOR_INVERSE, DELETE_RANGE, DELETE_TEXT, DIRECTION_CHANGED, DISABLED, display, DISPOSE_SENT, DISPOSED, DPI_CHANGED, DRAG_DETECT, DRAW, ENTER, ENTER_NOTIFY_EVENT, EVENT, EVENT_AFTER, eventTable, EXPAND_COLLAPSE_CURSOR_ROW, EXPOSE_EVENT, EXPOSE_EVENT_INVERSE, FOCUS, FOCUS_IN, FOCUS_IN_EVENT, FOCUS_OUT, FOCUS_OUT_EVENT, FONT, FOREGROUND, FOREIGN_HANDLE, gdkSeatGrabPrepareFunc, GESTURE_PRESSED, GESTURE_RELEASED, GRAB_FOCUS, handle, HANDLE, HAS_AUTO_DIRECTION, HIDDEN, HIDE, ICON_RELEASE, IM_UPDATE, INPUT, INSERT_TEXT, IS_ACTIVE, KEY_CHECK_SUBWINDOW, KEY_GTK_CSS, KEY_PRESS_EVENT, KEY_PRESSED, KEY_RELEASE_EVENT, KEY_RELEASED, KEYED_DATA, LAST_SIGNAL, LAYOUT_CHANGED, LAYOUT_CHILD, LAYOUT_NEEDED, LEAVE, LEAVE_NOTIFY_EVENT, MAP, MAP_EVENT, MENU, MNEMONIC_ACTIVATE, MONTH_CHANGED, MOTION, MOTION_INVERSE, MOTION_NOTIFY_EVENT, MOTION_NOTIFY_EVENT_INVERSE, MOVE_CURSOR, MOVE_CURSOR_INVERSE, MOVE_FOCUS, MOVED, NOTIFY_DEFAULT_HEIGHT, NOTIFY_DEFAULT_WIDTH, NOTIFY_MAXIMIZED, NOTIFY_STATE, OBSCURED, OUTPUT, PARENT_BACKGROUND, PASTE_CLIPBOARD, PASTE_CLIPBOARD_INVERSE, POPPED_UP, POPULATE_POPUP, POPUP_MENU, PREEDIT_CHANGED, REALIZE, RELEASED, RESIZED, ROW_ACTIVATED, ROW_DELETED, ROW_HAS_CHILD_TOGGLED, ROW_INSERTED, SCROLL, SCROLL_BEGIN, SCROLL_CHILD, SCROLL_END, SCROLL_EVENT, SELECT, SELECTION_DONE, SHOW, SHOW_HELP, SIZE_ALLOCATE, SIZE_ALLOCATE_GTK4, SKIN_NEEDED, START_INTERACTIVE_SEARCH, state, STATUS_ICON_POPUP_MENU, style, STYLE_UPDATED, SWITCH_PAGE, TEST_COLLAPSE_ROW, TEST_EXPAND_ROW, TEXT_BUFFER_INSERT_TEXT, THEME_BACKGROUND, TOGGLED, UNMAP, UNMAP_EVENT, UNREALIZE, VALUE_CHANGED, WINDOW_STATE_EVENT, ZERO_HEIGHT, ZERO_WIDTH

Constructor Summary

Constructors

Constructor	Description
Spinner(Composite parent, int style)	Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

Method Summary

Modifier and Type	Method	Description
void	addModifyListener(ModifyListener listener)	Adds the listener to the collection of listeners who will be notified when the receiver's text is modified, by sending it one of the messages defined in the ModifyListener interface.
void	addSelectionListener(SelectionListener listener)	Adds the listener to the collection of listeners who will be notified when the control is selected by the user, by sending it one of the messages defined in the SelectionListener interface.
(package private) void	addVerifyListener(VerifyListener listener)	Adds the listener to the collection of listeners who will be notified when the receiver's text is verified, by sending it one of the messages defined in the VerifyListener interface.
(package private) static int	checkStyle(int style)
protected void	checkSubclass()	Checks that this class can be subclassed.
(package private) boolean	checkSubwindow()
(package private) Point	computeSizeInPixels(int wHint, int hHint, boolean changed)
(package private) Rectangle	computeTrimInPixels(int x, int y, int width, int height)
void	copy()	Copies the selected text.
(package private) void	createHandle(int index)
void	cut()	Cuts the selected text.
(package private) GdkRGBA	defaultBackground()
(package private) void	deregister()
(package private) long	enterExitHandle()
(package private) long	eventSurface()
(package private) long	eventWindow()
(package private) boolean	filterKey(long event)
(package private) void	fixIM()
(package private) int	getBorderWidthInPixels()
(package private) GdkRGBA	getContextBackgroundGdkRGBA()
(package private) String	getDecimalSeparator()
int	getDigits()	Returns the number of decimal places used by the receiver.
int	getIncrement()	Returns the amount that the receiver's value will be modified by when the up/down arrows are pressed.
int	getMaximum()	Returns the maximum value which the receiver will allow.
int	getMinimum()	Returns the minimum value which the receiver will allow.
int	getPageIncrement()	Returns the amount that the receiver's position will be modified by when the page up/down keys are pressed.
int	getSelection()	Returns the selection, which is the receiver's position.
String	getText()	Returns a string containing a copy of the contents of the receiver's text field, or an empty string if there are no contents.
int	getTextLimit()	Returns the maximum number of characters that the receiver's text field is capable of holding.
(package private) long	gtk_activate(long widget)
(package private) long	gtk_changed(long widget)
(package private) long	gtk_commit(long imContext, long text)
(package private) long	gtk_delete_text(long widget, long start_pos, long end_pos)
(package private) long	gtk_focus_out_event(long widget, long event)
(package private) long	gtk_insert_text(long widget, long new_text, long new_text_length, long position)
(package private) long	gtk_populate_popup(long widget, long menu)
(package private) long	gtk_value_changed(long range)
(package private) long	gtk3_event_after(long widget, long gdkEvent)
(package private) long	gtk3_key_press_event(long widget, long event)
(package private) void	hookEvents()
(package private) long	imContext()
(package private) long	paintSurface()
(package private) long	paintWindow()
void	paste()	Pastes text from clipboard.
(package private) void	register()
(package private) void	releaseWidget()
void	removeModifyListener(ModifyListener listener)	Removes the listener from the collection of listeners who will be notified when the receiver's text is modified.
void	removeSelectionListener(SelectionListener listener)	Removes the listener from the collection of listeners who will be notified when the control is selected by the user.
(package private) void	removeVerifyListener(VerifyListener listener)	Removes the listener from the collection of listeners who will be notified when the control is verified.
(package private) void	setBackgroundGdkRGBA(long context, long handle, GdkRGBA rgba)
(package private) void	setCursor(long cursor)
void	setDigits(int value)	Sets the number of decimal places used by the receiver.
void	setIncrement(int value)	Sets the amount that the receiver's value will be modified by when the up/down arrows are pressed to the argument, which must be at least one.
void	setMaximum(int value)	Sets the maximum value that the receiver will allow.
void	setMinimum(int value)	Sets the minimum value that the receiver will allow.
void	setPageIncrement(int value)	Sets the amount that the receiver's position will be modified by when the page up/down keys are pressed to the argument, which must be at least one.
void	setSelection(int value)	Sets the selection, which is the receiver's position, to the argument.
void	setTextLimit(int limit)	Sets the maximum number of characters that the receiver's text field is capable of holding to be the argument.
void	setValues(int selection, int minimum, int maximum, int digits, int increment, int pageIncrement)	Sets the receiver's selection, minimum value, maximum value, digits, increment and page increment all at once.
(package private) boolean	translateTraversal(long event)
(package private) String	verifyText(String string, int start, int end)

Methods inherited from class Composite

_getChildren, _getTabList, adjustChildClipping, applyThemeBackground, changed, checkBuffered, computeTabList, connectFixedHandleDraw, createHandle, drawBackground, enableWidget, findDeferredControl, findMenus, fixChildren, fixClippings, fixModal, fixParentGdkResource, fixStyle, fixTabList, fixZOrder, focusHandle, forceFocus, getBackgroundMode, getChildren, getChildrenCount, getClientAreaInPixels, getLayout, getLayoutDeferred, getTabList, gtk_button_press_event, gtk_draw, gtk_focus, gtk_focus_in_event, gtk_map, gtk_realize, gtk_scroll_child, gtk_style_updated, gtk4_key_press_event, hasBorder, hooksKeys, imHandle, isLayoutDeferred, isTabGroup, layout, layout, layout, layout, layout, markLayout, minimumSize, moveAbove, moveBelow, moveChildren, mustBeVisibleOnInitBounds, parentingHandle, printWidget, propagateDraw, redrawChildren, releaseChildren, releaseHandle, removeControl, resizeHandle, reskinChildren, setBackgroundMode, setBounds, setFocus, setLayout, setLayoutDeferred, setOrientation, setScrollBarVisible, setTabGroupFocus, setTabItemFocus, setTabList, showWidget, toString, translateMnemonic, traversalCode, updateBackgroundMode, updateLayout

Methods inherited from class Scrollable

clientHandle, computeTrim, createScrollBar, createWidget, destroyScrollBar, getClientArea, getHorizontalBar, getScrollbarsMode, getVerticalBar, gtk_scroll_event, hScrollBarWidth, redrawBackgroundImage, redrawWidget, sendLeaveNotify, setScrollbarsMode, topHandle, updateScrollBarValue, vScrollBarWidth

Methods inherited from class Control

_getAccessible, _getShell, addControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addRelation, addTouchListener, addTraverseListener, cairoClipRegion, cairoCopyRegion, cairoDisposeRegion, checkBackground, checkBorder, checkMirrored, cleanupEnableWindow, computeNativeSize, computeSize, computeSize, computeSizeInPixels, computeTabGroup, computeTabRoot, containedInRegion, defaultFont, destroyWidget, dragDetect, dragDetect, dragDetect, dragDetect, drawBackground, drawGripper, drawWidget, eventHandle, findBackgroundControl, fixFocus, fixGdkEventTypeValues, fixStyle, flushQueueOnDnd, fontHandle, forceFocus, forceResize, gestureBeginProc, gestureEndProc, gestureHandle, getAccessible, getBackground, getBackgroundGdkRGBA, getBackgroundImage, getBaseGdkRGBA, getBgGdkRGBA, getBorderWidth, getBounds, getBoundsInPixels, getClientWidth, getContextColorGdkRGBA, getControl, getControlOrigin, getCursor, getDragDetect, getEnabled, getFont, getFontDescription, getForeground, getForegroundGdkRGBA, getIMCaretPos, getLayoutData, getLocation, getLocationInPixels, getMenu, getMonitor, getOrientation, getParent, getPath, getRegion, getShell, getSize, getSizeInPixels, getSurfaceOrigin, getTextDirection, getThickness, getToolTipText, getTouchEnabled, getVisible, getWindowOrigin, gtk_button_press_event, gtk_button_release_event, gtk_css_provider_load_from_css, gtk_enter_notify_event, gtk_gesture_press_event, gtk_gesture_release_event, gtk_label_set_align, gtk_leave_notify_event, gtk_mnemonic_activate, gtk_motion_notify_event, gtk_preedit_changed, gtk_style_context_get_border, gtk_style_context_get_padding, gtk_unrealize, gtk_widget_reparent, gtk_widget_set_align, gtk3_key_release_event, gtk3_popup_menu, gtk3_show_help, gtk4_draw, gtk4_enter_event, gtk4_focus_enter_event, gtk4_focus_leave_event, gtk4_focus_window_event, gtk4_key_release_event, gtk4_leave_event, gtk4_motion_event, gtk4_scroll_event, hasFocus, hooksPaint, hoverProc, internal_dispose_GC, internal_new_GC, isActive, isAutoScalable, isDescribedByLabel, isEnabled, isFocusAncestor, isFocusControl, isFocusHandle, isReparentable, isShowing, isTabItem, isVisible, magnifyProc, menuShell, mnemonicHit, mnemonicMatch, moveAbove, moveBelow, moveHandle, pack, pack, paintHandle, print, printWindow, redraw, redraw, redraw, release, releaseParent, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeRelation, removeTouchListener, removeTraverseListener, requestLayout, resizeCalculationsGTK3, restackWindow, rotateProc, sendDragEvent, sendFocusEvent, sendGestureEvent, sendGestureEvent, sendGestureEvent, sendHelpEvent, sendMouseEvent, sendMouseEvent, setBackground, setBackground, setBackgroundGdkRGBA, setBackgroundGdkRGBA, setBackgroundImage, setBackgroundSurface, setBounds, setBounds, setBoundsInPixels, setBoundsInPixels, setCapture, setCursor, setDragDetect, setEnabled, setFont, setFontDescription, setForeground, setForegroundGdkRGBA, setForegroundGdkRGBA, setInitialBounds, setLayoutData, setLocation, setLocation, setLocationInPixels, setLocationInPixels, setMenu, setOrientation, setParent, setParentBackground, setParentGdkResource, setRadioSelection, setRedraw, setRegion, setRelations, setSize, setSize, setSizeInPixels, setSizeInPixels, setTextDirection, setToolTipText, setToolTipText, setTouchEnabled, setVisible, setWidgetBackground, setZOrder, setZOrder, showMenu, showMenu, sort, swipeProc, toControl, toControl, toDisplay, toDisplay, toDisplayInPixels, translateMnemonic, traverse, traverse, traverse, traverse, traverse, traverseEscape, traverseGroup, traverseItem, traverseMnemonic, traversePage, traverseReturn, update, update, wantDragDropDetection, windowProc

Methods inherited from class Widget

_addListener, addDisposeListener, addListener, addTypedListener, cellDataProc, checkBits, checkOpen, checkOrientation, checkParent, checkWidget, convertPangoFontDescriptionToCss, cssHandle, dispose, dpiChanged, enterMotionProc, error, filterProc, filters, fixMnemonic, fixMnemonic, fixMnemonic, focusProc, fontHeight, gdk_event_free, gdk_event_get_state, gdk_event_get_surface_or_window, gdk_pointer_grab, gdk_pointer_ungrab, gdk_surface_get_size, gdk_window_get_size, GdkSeatGrabPrepareFunc, gesturePressReleaseProc, getData, getData, getDisplay, getListeners, getName, getNameText, getStyle, getTypedListeners, gtk_adjustment_get, gtk_box_new, gtk_box_pack_end, gtk_box_set_child_packing, gtk_cell_renderer_get_preferred_size, gtk_change_value, gtk_clicked, gtk_close_request, gtk_configure_event, gtk_container_get_border_width_or_margin, gtk_container_set_border_width, gtk_create_menu_proxy, gtk_day_selected, gtk_day_selected_double_click, gtk_delete_event, gtk_delete_range, gtk_expand_collapse_cursor_row, gtk_grab_focus, gtk_hide, gtk_icon_release, gtk_input, gtk_map_event, gtk_menu_popped_up, gtk_month_changed, gtk_move_focus, gtk_output, gtk_row_activated, gtk_row_has_child_toggled, gtk_select, gtk_selection_done, gtk_show, gtk_size_allocate, gtk_start_interactive_search, gtk_status_icon_popup_menu, gtk_switch_page, gtk_test_collapse_row, gtk_test_expand_row, gtk_text_buffer_insert_text, gtk_timer, gtk_toggled, gtk_tree_view_column_cell_get_position, gtk_unmap, gtk_unmap_event, gtk_widget_get_preferred_size, gtk_widget_get_surface, gtk_widget_get_window, gtk_widget_hide, gtk_widget_show, gtk_widget_size_allocate, gtk_window_state_event, hooks, isAutoDirection, isDisposed, isListening, isValidSubclass, isValidThread, keyPressReleaseProc, leaveProc, mnemonicHit, mnemonicMatch, notifyCreationTracker, notifyDisposalTracker, notifyListeners, notifyProc, notifyState, postEvent, postEvent, removeDisposeListener, removeListener, removeListener, removeListener, removeTypedListener, rendererGetPreferredWidthProc, rendererRenderProc, rendererSnapshotProc, reskin, reskinWidget, scrollProc, sendEvent, sendEvent, sendEvent, sendEvent, sendIMKeyEvent, sendKeyEvent, sendSelectionEvent, sendSelectionEvent, setButtonState, setData, setData, setFontDescription, setInputState, setKeyState, setLocationState, setToolTipText, shellMapProc, sizeAllocateProc, sizeRequestProc, snapshotToDraw, timerProc, translateTraversal, windowActiveProc, windowProc, windowProc, windowProc, windowProc

Methods inherited from class Object

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

Field Details

MIN_ARROW_WIDTH

static final int MIN_ARROW_WIDTH

See Also:

• Constant Field Values

lastEventTime

int lastEventTime

imContext

long imContext

gdkEventKey

long gdkEventKey

entryHandle

long entryHandle

fixStart

int fixStart

fixEnd

int fixEnd

climbRate

double climbRate

LIMIT

public static final int LIMIT

the operating system limit for the number of characters that the text field in an instance of this class can hold

Since:

3.4

background

GdkRGBA background

Constructor Details

Spinner

public Spinner(Composite 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 composite control which will be the parent of the new instance (cannot be null)

style - the style of control to construct

Throws:

IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the parent is null

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.READ_ONLY
• SWT.WRAP
• Widget.checkSubclass()
• Widget.getStyle()

Method Details

addModifyListener

public void addModifyListener(ModifyListener listener)

Adds the listener to the collection of listeners who will be notified when the receiver's text is modified, by sending it one of the messages defined in the ModifyListener interface.

Parameters:

listener - the listener which should be notified

Throws:

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:

• ModifyListener
• removeModifyListener(ModifyListener)

addSelectionListener

public void addSelectionListener(SelectionListener listener)

Adds the listener to the collection of listeners who will be notified when the control is selected by the user, by sending it one of the messages defined in the SelectionListener interface.

widgetSelected is not called for texts. widgetDefaultSelected is typically called when ENTER is pressed in a single-line text.

Parameters:

listener - the listener which should be notified when the control is selected by the user

Throws:

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:

• SelectionListener
• removeSelectionListener(SelectionListener)
• SelectionEvent

addVerifyListener

void addVerifyListener(VerifyListener listener)

Adds the listener to the collection of listeners who will be notified when the receiver's text is verified, by sending it one of the messages defined in the VerifyListener interface.

Parameters:

listener - the listener which should be notified

Throws:

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:

• VerifyListener
• removeVerifyListener(VerifyListener)

checkStyle

static int checkStyle(int style)

checkSubclass

protected void checkSubclass()

Description copied from class: Widget

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.

Overrides:

checkSubclass in class Composite

computeSizeInPixels

Point computeSizeInPixels(int wHint,
 int hHint,
 boolean changed)

Overrides:

computeSizeInPixels in class Composite

computeTrimInPixels

Rectangle computeTrimInPixels(int x,
 int y,
 int width,
 int height)

Overrides:

computeTrimInPixels in class Scrollable

copy

public void copy()

Copies the selected text.

The current selection is copied to the clipboard.

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

createHandle

void createHandle(int index)

Overrides:

createHandle in class Composite

cut

public void cut()

Cuts the selected text.

The current selection is first copied to the clipboard and then deleted from the widget.

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

defaultBackground

GdkRGBA defaultBackground()

Overrides:

defaultBackground in class Control

deregister

void deregister()

Overrides:

deregister in class Composite

eventWindow

long eventWindow()

Overrides:

eventWindow in class Control

eventSurface

long eventSurface()

Overrides:

eventSurface in class Control

enterExitHandle

long enterExitHandle()

Overrides:

enterExitHandle in class Control

filterKey

boolean filterKey(long event)

Overrides:

filterKey in class Control

fixIM

void fixIM()

getBorderWidthInPixels

int getBorderWidthInPixels()

Overrides:

getBorderWidthInPixels in class Scrollable

getIncrement

public int getIncrement()

Returns the amount that the receiver's value will be modified by when the up/down arrows are pressed.

Returns:

the increment

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

getMaximum

public int getMaximum()

Returns the maximum value which the receiver will allow.

Returns:

the maximum

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

getMinimum

public int getMinimum()

Returns the minimum value which the receiver will allow.

Returns:

the minimum

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

getPageIncrement

public int getPageIncrement()

Returns the amount that the receiver's position will be modified by when the page up/down keys are pressed.

Returns:

the page increment

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

getSelection

public int getSelection()

Returns the selection, which is the receiver's position.

Returns:

the selection

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

getText

public String getText()

Returns a string containing a copy of the contents of the receiver's text field, or an empty string if there are no contents.

Returns:

the receiver's text

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

getTextLimit

public int getTextLimit()

Returns the maximum number of characters that the receiver's text field is capable of holding. If this has not been changed by setTextLimit(), it will be the constant Spinner.LIMIT.

Returns:

the text limit

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:

• LIMIT

getDigits

public int getDigits()

Returns the number of decimal places used by the receiver.

Returns:

the digits

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

getDecimalSeparator

String getDecimalSeparator()

gtk_activate

long gtk_activate(long widget)

Overrides:

gtk_activate in class Widget

gtk_changed

long gtk_changed(long widget)

Overrides:

gtk_changed in class Widget

gtk_commit

long gtk_commit(long imContext,
 long text)

Overrides:

gtk_commit in class Control

gtk_delete_text

long gtk_delete_text(long widget,
 long start_pos,
 long end_pos)

Overrides:

gtk_delete_text in class Widget

gtk3_event_after

long gtk3_event_after(long widget,
 long gdkEvent)

Overrides:

gtk3_event_after in class Control

gtk_focus_out_event

long gtk_focus_out_event(long widget,
 long event)

Overrides:

gtk_focus_out_event in class Composite

gtk_insert_text

long gtk_insert_text(long widget,
 long new_text,
 long new_text_length,
 long position)

Overrides:

gtk_insert_text in class Widget

gtk3_key_press_event

long gtk3_key_press_event(long widget,
 long event)

Overrides:

gtk3_key_press_event in class Composite

gtk_populate_popup

long gtk_populate_popup(long widget,
 long menu)

Overrides:

gtk_populate_popup in class Widget

gtk_value_changed

long gtk_value_changed(long range)

Overrides:

gtk_value_changed in class Widget

hookEvents

void hookEvents()

Overrides:

hookEvents in class Composite

imContext

long imContext()

paintWindow

long paintWindow()

Overrides:

paintWindow in class Control

paintSurface

long paintSurface()

Overrides:

paintSurface in class Control

paste

public void paste()

Pastes text from clipboard.

The selected text is deleted from the widget and new text inserted from the clipboard.

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

register

void register()

Overrides:

register in class Composite

releaseWidget

void releaseWidget()

Overrides:

releaseWidget in class Composite

removeModifyListener

public void removeModifyListener(ModifyListener listener)

Removes the listener from the collection of listeners who will be notified when the receiver's text is modified.

Parameters:

listener - the listener which should no longer be notified

Throws:

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:

• ModifyListener
• addModifyListener(ModifyListener)

removeSelectionListener

public void removeSelectionListener(SelectionListener listener)

Removes the listener from the collection of listeners who will be notified when the control is selected by the user.

Parameters:

listener - the listener which should no longer be notified

Throws:

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:

• SelectionListener
• addSelectionListener(SelectionListener)

removeVerifyListener

void removeVerifyListener(VerifyListener listener)

Removes the listener from the collection of listeners who will be notified when the control is verified.

Parameters:

listener - the listener which should be notified

Throws:

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:

• VerifyListener
• addVerifyListener(VerifyListener)

getContextBackgroundGdkRGBA

GdkRGBA getContextBackgroundGdkRGBA()

Overrides:

getContextBackgroundGdkRGBA in class Control

setBackgroundGdkRGBA

void setBackgroundGdkRGBA(long context,
 long handle,
 GdkRGBA rgba)

Overrides:

setBackgroundGdkRGBA in class Control

setCursor

void setCursor(long cursor)

Overrides:

setCursor in class Control

setIncrement

public void setIncrement(int value)

Sets the amount that the receiver's value will be modified by when the up/down arrows are pressed to the argument, which must be at least one.

Parameters:

value - the new increment (must be greater than zero)

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

setMaximum

public void setMaximum(int value)

Sets the maximum value that the receiver will allow. This new value will be ignored if it is less than the receiver's current minimum value. If the new maximum is applied then the receiver's selection value will be adjusted if necessary to fall within its new range.

Parameters:

value - the new maximum, which must be greater than or equal to the current minimum

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

setMinimum

public void setMinimum(int value)

Sets the minimum value that the receiver will allow. This new value will be ignored if it is greater than the receiver's current maximum value. If the new minimum is applied then the receiver's selection value will be adjusted if necessary to fall within its new range.

Parameters:

value - the new minimum, which must be less than or equal to the current maximum

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

setPageIncrement

public void setPageIncrement(int value)

Sets the amount that the receiver's position will be modified by when the page up/down keys are pressed to the argument, which must be at least one.

Parameters:

value - the page increment (must be greater than zero)

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

setSelection

public void setSelection(int value)

Sets the selection, which is the receiver's position, to the argument. If the argument is not within the range specified by minimum and maximum, it will be adjusted to fall within this range.

Parameters:

value - the new selection (must be zero or greater)

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

setTextLimit

public void setTextLimit(int limit)

Sets the maximum number of characters that the receiver's text field is capable of holding to be the argument.

To reset this value to the default, use setTextLimit(Spinner.LIMIT). Specifying a limit value larger than Spinner.LIMIT sets the receiver's limit to Spinner.LIMIT.

Parameters:

limit - new text limit

Throws:

IllegalArgumentException -

• ERROR_CANNOT_BE_ZERO - if the limit is zero

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:

• LIMIT

setDigits

public void setDigits(int value)

Sets the number of decimal places used by the receiver.

The digit setting is used to allow for floating point values in the receiver. For example, to set the selection to a floating point value of 1.37 call setDigits() with a value of 2 and setSelection() with a value of 137. Similarly, if getDigits() has a value of 2 and getSelection() returns 137 this should be interpreted as 1.37. This applies to all numeric APIs.

Parameters:

value - the new digits (must be greater than or equal to zero)

Throws:

IllegalArgumentException -

• ERROR_INVALID_ARGUMENT - if the value is less than zero

SWTException -

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

setValues

public void setValues(int selection,
 int minimum,
 int maximum,
 int digits,
 int increment,
 int pageIncrement)

Sets the receiver's selection, minimum value, maximum value, digits, increment and page increment all at once.

Note: This is similar to setting the values individually using the appropriate methods, but may be implemented in a more efficient fashion on some platforms.

Parameters:

selection - the new selection value

minimum - the new minimum value

maximum - the new maximum value

digits - the new digits value

increment - the new increment value

pageIncrement - the new pageIncrement value

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

checkSubwindow

boolean checkSubwindow()

Overrides:

checkSubwindow in class Composite

translateTraversal

boolean translateTraversal(long event)

Overrides:

translateTraversal in class Composite

verifyText

String verifyText(String string,
 int start,
 int end)