public class Spinner extends Composite
IMPORTANT: This class is not intended to be subclassed.
Constructor and 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.
|
Modifier and Type | Method and 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 sending
it one of the messages defined in the
SelectionListener
interface. |
protected void |
checkSubclass()
Checks that this class can be subclassed.
|
Point |
computeSize(int wHint,
int hHint,
boolean changed)
Returns the preferred size of the receiver.
|
Rectangle |
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.
|
void |
copy()
Copies the selected text.
|
void |
cut()
Cuts the selected text.
|
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.
|
void |
paste()
Pastes text from clipboard.
|
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.
|
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 |
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.
|
changed, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList
getClientArea, getHorizontalBar, getVerticalBar
addControlListener, addFocusListener, addHelpListener, addKeyListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addPaintListener, addTraverseListener, computeSize, forceFocus, getAccessible, getBackground, getBackgroundImage, getBorderWidth, getBounds, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getParent, getShell, getSize, getToolTipText, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, redraw, redraw, removeControlListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removePaintListener, removeTraverseListener, setBackground, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setEnabled, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setParent, setRedraw, setSize, setSize, setToolTipText, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, update
addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, setData, setData, toString
public Spinner(Composite parent, int style)
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.
parent
- a composite control which will be the parent of the new instance (cannot be null)style
- the style of control to constructIllegalArgumentException
- SWTException
- SWT.READ_ONLY
,
SWT.WRAP
,
Widget.checkSubclass()
,
Widget.getStyle()
protected void checkSubclass()
Widget
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.
checkSubclass
in class Composite
public void addModifyListener(ModifyListener listener)
ModifyListener
interface.listener
- the listener which should be notifiedIllegalArgumentException
- SWTException
- ModifyListener
,
removeModifyListener(org.eclipse.swt.events.ModifyListener)
public void addSelectionListener(SelectionListener listener)
SelectionListener
interface.
widgetSelected
is not called for texts.
widgetDefaultSelected
is typically called when ENTER is pressed in a single-line text.
listener
- the listener which should be notifiedIllegalArgumentException
- SWTException
- SelectionListener
,
removeSelectionListener(org.eclipse.swt.events.SelectionListener)
,
SelectionEvent
public Point computeSize(int wHint, int hHint, boolean changed)
Control
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.DEFAULT
is 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 be false
, so layout
manager caches can be retained.
computeSize
in class Composite
wHint
- the width hint (can be SWT.DEFAULT
)hHint
- the height hint (can be SWT.DEFAULT
)changed
- true
if the control's contents have changed, and false
otherwiseLayout
,
Control.getBorderWidth()
,
Control.getBounds()
,
Control.getSize()
,
Control.pack(boolean)
,
"computeTrim, getClientArea for controls that implement them"public Rectangle computeTrim(int x, int y, int width, int height)
Scrollable
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).
computeTrim
in class Scrollable
x
- the desired x coordinate of the client areay
- the desired y coordinate of the client areawidth
- the desired width of the client areaheight
- the desired height of the client areaScrollable.getClientArea()
public void copy()
The current selection is copied to the clipboard.
SWTException
- public void cut()
The current selection is first copied to the clipboard and then deleted from the widget.
SWTException
- public int getDigits()
SWTException
- public int getIncrement()
SWTException
- public int getMaximum()
SWTException
- public int getMinimum()
SWTException
- public int getPageIncrement()
SWTException
- public int getSelection()
SWTException
- public void paste()
The selected text is deleted from the widget and new text inserted from the clipboard.
SWTException
- public void removeModifyListener(ModifyListener listener)
listener
- the listener which should no longer be notifiedIllegalArgumentException
- SWTException
- ModifyListener
,
addModifyListener(org.eclipse.swt.events.ModifyListener)
public void removeSelectionListener(SelectionListener listener)
listener
- the listener which should no longer be notifiedIllegalArgumentException
- SWTException
- SelectionListener
,
addSelectionListener(org.eclipse.swt.events.SelectionListener)
public void setDigits(int value)
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.
value
- the new digits (must be greater than or equal to zero)IllegalArgumentException
- SWTException
- public void setIncrement(int value)
value
- the new increment (must be greater than zero)SWTException
- public void setMaximum(int value)
value
- the new maximum, which must be greater than the current minimumSWTException
- public void setMinimum(int value)
value
- the new minimum, which must be nonnegative and less than the current maximumSWTException
- public void setPageIncrement(int value)
value
- the page increment (must be greater than zero)SWTException
- public void setSelection(int value)
value
- the new selection (must be zero or greater)SWTException
- public void setValues(int selection, int minimum, int maximum, int digits, int increment, int pageIncrement)
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.
selection
- the new selection valueminimum
- the new minimum valuemaximum
- the new maximum valuedigits
- the new digits valueincrement
- the new increment valuepageIncrement
- the new pageIncrement valueSWTException
- Guidelines for using Eclipse APIs. Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.