|
Eclipse Remote Application Platform | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
public class Spinner
Instances of this class are selectable user interface objects that allow the user to enter and modify numeric values.
IMPORTANT: This class is not intended to be subclassed.
Field Summary | |
---|---|
static int |
LIMIT
the limit for the number of characters that the text field in an instance of this class can hold |
Constructor Summary | |
---|---|
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 | |
---|---|
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. |
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. |
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. |
java.lang.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 is capable of holding. |
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. |
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 textLimit)
Sets the maximum number of characters that the receiver 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. |
Methods inherited from class org.eclipse.swt.widgets.Composite |
---|
changed, getAdapter, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList |
Methods inherited from class org.eclipse.swt.widgets.Scrollable |
---|
getClientArea, getHorizontalBar, getVerticalBar |
Methods inherited from class org.eclipse.swt.widgets.Widget |
---|
addDisposeListener, addListener, checkSubclass, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, reskin, setData, setData, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int LIMIT
Constructor Detail |
---|
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 construct
java.lang.IllegalArgumentException
- SWTException
- SWT.READ_ONLY
,
SWT.WRAP
,
Widget.checkSubclass()
,
Widget.getStyle()
Method Detail |
---|
public int getDigits()
SWTException
- 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)
java.lang.IllegalArgumentException
- SWTException
- public int getIncrement()
SWTException
- public void setIncrement(int value)
value
- the new increment (must be greater than zero)
SWTException
- public int getMinimum()
SWTException
- public void setMinimum(int value)
value
- the new minimum, which must be less than or equals to the current maximum
SWTException
- public int getMaximum()
SWTException
- public void setMaximum(int value)
value
- the new maximum, which must be greater than or equal to the current minimum
SWTException
- public int getPageIncrement()
SWTException
- public void setPageIncrement(int value)
value
- the page increment (must be greater than zero)
SWTException
- public int getSelection()
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 value
SWTException
- public java.lang.String getText()
SWTException
- public void setTextLimit(int textLimit)
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 than Text.LIMIT
sets the
receiver's limit to Text.LIMIT
.
textLimit
- new text limit
java.lang.IllegalArgumentException
- SWTException
- LIMIT
public int getTextLimit()
If this has not been changed by setTextLimit()
,
it will be the constant Text.LIMIT
.
SWTException
- LIMIT
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
otherwise
Layout
,
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 area
Scrollable.getClientArea()
public void addModifyListener(ModifyListener listener)
ModifyListener
interface.
listener
- the listener which should be notified
java.lang.IllegalArgumentException
- SWTException
- ModifyListener
,
removeModifyListener(org.eclipse.swt.events.ModifyListener)
public void removeModifyListener(ModifyListener listener)
listener
- the listener which should no longer be notified
java.lang.IllegalArgumentException
- SWTException
- ModifyListener
,
addModifyListener(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 notified when the control is selected by the user
java.lang.IllegalArgumentException
- SWTException
- SelectionListener
,
removeSelectionListener(org.eclipse.swt.events.SelectionListener)
,
SelectionEvent
public void removeSelectionListener(SelectionListener listener)
listener
- the listener which should no longer be notified
java.lang.IllegalArgumentException
- SWTException
- SelectionListener
,
addSelectionListener(org.eclipse.swt.events.SelectionListener)
|
Eclipse Remote Application Platform | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright (c) EclipseSource and others 2002, 2013. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0