|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.swt.widgets.Widget
org.eclipse.swt.widgets.Control
org.eclipse.swt.widgets.Button
public class Button
Instances of this class represent a selectable user interface object that issues notification when pressed and released.
Note: Only one of the styles CHECK, PUSH, RADIO, and TOGGLE may be specified.
Note: Only one of the styles LEFT, RIGHT, and CENTER may be specified.
IMPORTANT: This class is intended to be subclassed only within the SWT implementation.
Field Summary |
---|
Fields inherited from class org.eclipse.swt.widgets.Control |
---|
enableTraverse, internal_parent |
Fields inherited from class org.eclipse.swt.widgets.Widget |
---|
internal_handle, internal_style |
Constructor Summary | |
---|---|
Button(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 |
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. |
boolean |
allowTraverseByArrowKey(Event event)
|
int |
getAlignment()
Returns a value which describes the position of the text or image in the receiver. |
Image |
getImage()
Returns the receiver's image if it has one, or null if it does not. |
boolean |
getSelection()
Returns true if the receiver is selected,
and false otherwise. |
java.lang.String |
getText()
Returns the receiver's text, which will be an empty string if it has never been set. |
protected void |
internal_createHandle(int index)
|
protected int |
internal_getNativeStyle()
|
void |
removeSelectionListener(SelectionListener listener)
Removes the listener from the collection of listeners who will be notified when the control is selected. |
void |
setAlignment(int alignment)
Controls how text and images will be displayed in the receiver. |
void |
setImage(Image image)
Sets the receiver's image to the argument, which may be null indicating that no image should be displayed. |
void |
setSelection(boolean selected)
Sets the selection state of the receiver, if it is of type CHECK ,
RADIO , or TOGGLE . |
void |
setText(java.lang.String string)
Sets the receiver's text. |
protected boolean |
traverse(Event event)
|
Methods inherited from class org.eclipse.swt.widgets.Widget |
---|
addDisposeListener, addListener, checkSubclass, checkWidget, getData, getData, getDisplay, getStyle, internal_sendEvent, isDisposed, isListening, notifyListeners, removeDisposeListener, removeInternalFilter, removeListener, removeListener, sendEvent, setData, setData, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Button(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.CHECK
,
SWT.PUSH
,
SWT.RADIO
,
SWT.TOGGLE
,
SWT.FLAT
,
SWT.LEFT
,
SWT.RIGHT
,
SWT.CENTER
,
Widget.checkSubclass()
,
Widget.getStyle()
Method Detail |
---|
public void addSelectionListener(SelectionListener listener)
SelectionListener
interface.
widgetSelected
is called when the control is selected.
widgetDefaultSelected
is not called.
listener
- the listener which should be notified
java.lang.IllegalArgumentException
- SWTException
- SelectionListener
,
removeSelectionListener(org.eclipse.swt.events.SelectionListener)
,
SelectionEvent
protected void internal_createHandle(int index)
internal_createHandle
in class Widget
protected int internal_getNativeStyle()
internal_getNativeStyle
in class Control
public int getAlignment()
LEFT
, RIGHT
or CENTER
.
SWTException
- public Image getImage()
SWTException
- public boolean getSelection()
true
if the receiver is selected,
and false otherwise.
When the receiver is of type CHECK
or RADIO
,
it is selected when it is checked. When it is of type TOGGLE
,
it is selected when it is pushed in. If the receiver is of any other type,
this method returns false.
SWTException
- public java.lang.String getText()
SWTException
- 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)
public void setAlignment(int alignment)
LEFT
, RIGHT
or CENTER
.
alignment
- the new alignment
SWTException
- public void setImage(Image image)
null
indicating that no image should be displayed.
image
- the image to display on the receiver (may be null
)
java.lang.IllegalArgumentException
- SWTException
- public void setSelection(boolean selected)
CHECK
,
RADIO
, or TOGGLE
.
When the receiver is of type CHECK
or RADIO
,
it is selected when it is checked. When it is of type TOGGLE
,
it is selected when it is pushed in.
selected
- the new selection state
SWTException
- public void setText(java.lang.String string)
This method sets the button label. The label may include the mnemonic character but must not contain line delimiters.
Mnemonics are indicated by an '&' that causes the next character to be the mnemonic. When the user presses a key sequence that matches the mnemonic, a selection event occurs. On most platforms, the mnemonic appears underlined but may be emphasised in a platform specific manner. The mnemonic indicator character '&' can be escaped by doubling it in the string, causing a single '&' to be displayed.
string
- the new text
java.lang.IllegalArgumentException
- SWTException
- public boolean allowTraverseByArrowKey(Event event)
allowTraverseByArrowKey
in class Control
protected boolean traverse(Event event)
traverse
in class Control
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |