Class Spinner
- Styles:
- READ_ONLY, WRAP
- Events:
- Selection, Modify
IMPORTANT: This class is not intended to be subclassed.
- Since:
- 1.0
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final intthe limit for the number of characters that the text field in an instance of this class can hold
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidaddModifyListener(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 theModifyListenerinterface.voidaddSelectionListener(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 theSelectionListenerinterface.computeSize(int wHint, int hHint, boolean changed) Returns the preferred size of the receiver.computeTrim(int x, int y, int width, int height) Given a desired client area for the receiver (as described by the arguments), returns the bounding rectangle which would be required to produce that client area.<T> TgetAdapter(Class<T> adapter) Implementation of theAdaptableinterface.intReturns the number of decimal places used by the receiver.intReturns the amount that the receiver's value will be modified by when the up/down arrows are pressed.intReturns the maximum value which the receiver will allow.intReturns the minimum value which the receiver will allow.intReturns the amount that the receiver's position will be modified by when the page up/down keys are pressed.intReturns the selection, which is the receiver's position.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.intReturns the maximum number of characters that the receiver is capable of holding.voidremoveModifyListener(ModifyListener listener) Removes the listener from the collection of listeners who will be notified when the receiver's text is modified.voidremoveSelectionListener(SelectionListener listener) Removes the listener from the collection of listeners who will be notified when the control is selected by the user.voidsetDigits(int value) Sets the number of decimal places used by the receiver.voidsetIncrement(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.voidsetMaximum(int value) Sets the maximum value that the receiver will allow.voidsetMinimum(int value) Sets the minimum value that the receiver will allow.voidsetPageIncrement(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.voidsetSelection(int value) Sets the selection, which is the receiver's position, to the argument.voidsetTextLimit(int textLimit) Sets the maximum number of characters that the receiver is capable of holding to be the argument.voidsetValues(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.Methods inherited from class org.eclipse.swt.widgets.Compositechanged, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabListMethods inherited from class org.eclipse.swt.widgets.ScrollablegetClientArea, getHorizontalBar, getVerticalBarMethods inherited from class org.eclipse.swt.widgets.ControladdControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addTouchListener, addTraverseListener, computeSize, forceFocus, getAccessible, getBackground, getBackgroundImage, getBorderWidth, getBounds, getCursor, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getShell, getSize, getToolTipText, getTouchEnabled, getVisible, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeTouchListener, removeTraverseListener, requestLayout, setBackground, setBackgroundImage, setBounds, setBounds, setCursor, setData, setEnabled, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRedraw, setSize, setSize, setToolTipText, setTouchEnabled, setVisible, toControl, toControl, toDisplay, toDisplay, updateMethods inherited from class org.eclipse.swt.widgets.WidgetaddDisposeListener, addListener, checkSubclass, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, reskin, setData, toString
- 
Field Details- 
LIMITpublic static final int LIMITthe limit for the number of characters that the text field in an instance of this class can hold- Since:
- 1.3
- See Also:
 
 
- 
- 
Constructor Details- 
SpinnerConstructs 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 SWTwhich is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using theint"|" operator) two or more of thoseSWTstyle 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:
 
 
- 
- 
Method Details- 
getDigitspublic 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
 
 
- 
setDigitspublic 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
 
- Since:
- 1.3
 
- 
getIncrementpublic 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
 
 
- 
setIncrementpublic 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
 
 
- 
getMinimumpublic 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
 
 
- 
setMinimumpublic 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 equals 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
 
 
- 
getMaximumpublic 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
 
 
- 
setMaximumpublic 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
 
 
- 
getPageIncrementpublic 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
 
 
- 
setPageIncrementpublic 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
 
 
- 
getSelectionpublic 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
 
 
- 
setSelectionpublic 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
 
 
- 
setValuespublic 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
 
 
- 
getTextReturns 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:
- 1.3
 
- 
setTextLimitpublic void setTextLimit(int textLimit) Sets the maximum number of characters that the receiver is capable of holding to be the argument.Instead of trying to set the text limit to zero, consider creating a read-only text widget. To reset this value to the default, use setTextLimit(Text.LIMIT). Specifying a limit value larger thanText.LIMITsets the receiver's limit toText.LIMIT.- Parameters:
- textLimit- 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:
- 1.3
- See Also:
 
- 
getTextLimitpublic int getTextLimit()Returns the maximum number of characters that the receiver is capable of holding.If this has not been changed by setTextLimit(), it will be the constantText.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:
- 1.3
- See Also:
 
- 
computeSizeDescription copied from class:ControlReturns the preferred size of the receiver.The preferred size of a control is the size that it would best be displayed at. The width hint and height hint arguments allow the caller to ask a control questions such as "Given a particular width, how high does the control need to be to show all of the contents?" To indicate that the caller does not wish to constrain a particular dimension, the constant SWT.DEFAULTis passed for the hint.If the changed flag is true, it indicates that the receiver's contents have changed, therefore any caches that a layout manager containing the control may have been keeping need to be flushed. When the control is resized, the changed flag will befalse, so layout manager caches can be retained.- Overrides:
- computeSizein class- Composite
- Parameters:
- wHint- the width hint (can be- SWT.DEFAULT)
- hHint- the height hint (can be- SWT.DEFAULT)
- changed-- trueif the control's contents have changed, and- falseotherwise
- Returns:
- the preferred size of the control.
- See Also:
- 
- Layout
- Control.getBorderWidth()
- Control.getBounds()
- Control.getSize()
- Control.pack(boolean)
- "computeTrim, getClientArea for controls that implement them"
 
 
- 
computeTrimDescription copied from class:ScrollableGiven a desired client area for the receiver (as described by the arguments), returns the bounding rectangle which would be required to produce that client area.In other words, it returns a rectangle such that, if the receiver's bounds were set to that rectangle, the area of the receiver which is capable of displaying data (that is, not covered by the "trimmings") would be the rectangle described by the arguments (relative to the receiver's parent). - Overrides:
- computeTrimin class- Scrollable
- Parameters:
- x- the desired x coordinate of the client area
- y- the desired y coordinate of the client area
- width- the desired width of the client area
- height- the desired height of the client area
- Returns:
- the required bounds to produce the given client area
- See Also:
 
- 
addModifyListenerAdds 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 theModifyListenerinterface.- 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:
 
- 
removeModifyListenerRemoves 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:
 
- 
addSelectionListenerAdds 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 theSelectionListenerinterface.widgetSelectedis not called for texts.widgetDefaultSelectedis 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
 
- Since:
- 1.2
- See Also:
 
- 
removeSelectionListenerRemoves 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
 
- Since:
- 1.2
- See Also:
 
- 
getAdapterDescription copied from class:WidgetImplementation of theAdaptableinterface.IMPORTANT: This method is not part of the RWT public API. It is marked public only so that it can be shared within the packages provided by RWT. It should never be accessed from application code. - Specified by:
- getAdapterin interface- Adaptable
- Overrides:
- getAdapterin class- Composite
- Parameters:
- adapter- the lookup class
- Returns:
- an object that can be cast to the given class or nullif there is no adapter associated with the given class.
 
 
-