org.eclipse.swt.widgets
Class Button

java.lang.Object
  |
  +--org.eclipse.swt.widgets.Widget
        |
        +--org.eclipse.swt.widgets.Control
              |
              +--org.eclipse.swt.widgets.Button

All Implemented Interfaces:

Drawable

public class Button

extends Control

Safe:

Field Summary

(package private) static org.eclipse.swt.internal.win32.TCHAR	ButtonClass
(package private) static int	ButtonProc
(package private) static int	CheckHeight
(package private) static int	CheckWidth
(package private) Image	image

Fields inherited from class org.eclipse.swt.widgets.Control

ACCENTS, accessible, background, drawCount, foreground, handle, hCursor, layoutData, menu, parent, toolTipText

Fields inherited from class org.eclipse.swt.widgets.Widget

CANVAS, COMCTL32_MAJOR, COMCTL32_MINOR, data, DEFAULT_HEIGHT, DEFAULT_WIDTH, DISABLED, DISPOSED, eventTable, HIDDEN, keys, MAJOR, MINOR, Mnemonic, state, style, values

Constructor Summary

Button(Composite parent, int style)
Enabled: 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) Enabled: 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.
(package private) int	callWindowProc(int msg, int wParam, int lParam)
(package private) static int	checkStyle(int style)
(package private) void	click()
Point	computeSize(int wHint, int hHint, boolean changed) Enabled:
(package private) int	defaultBackground()
(package private) int	defaultForeground()
int	getAlignment() Enabled: Returns a value which describes the position of the text or image in the receiver.
(package private) boolean	getDefault()
Image	getImage() Enabled: Returns the receiver's image if it has one, or null if it does not.
(package private) String	getNameText()
boolean	getSelection() Enabled: Returns true if the receiver is selected, and false otherwise.
String	getText() Enabled: Returns the receiver's text, which will be an empty string if it has never been set.
(package private) boolean	isTabItem()
(package private) boolean	mnemonicHit(char ch)
(package private) boolean	mnemonicMatch(char key)
(package private) void	releaseWidget()
void	removeSelectionListener(SelectionListener listener) Enabled: Removes the listener from the collection of listeners who will be notified when the control is selected.
(package private) void	selectRadio()
void	setAlignment(int alignment) Enabled: Controls how text, images and arrows will be displayed in the receiver.
(package private) void	setDefault(boolean value)
boolean	setFocus() Suppressed:
void	setImage(Image image) Enabled: Sets the receiver's image to the argument, which may be null indicating that no image should be displayed.
(package private) boolean	setRadioFocus()
(package private) boolean	setRadioSelection(boolean value)
(package private) boolean	setSavedFocus()
void	setSelection(boolean selected) Enabled: Sets the selection state of the receiver, if it is of type CHECK, RADIO, or TOGGLE.
void	setText(String string) Enabled: Sets the receiver's text.
(package private) int	widgetStyle()
(package private) org.eclipse.swt.internal.win32.TCHAR	windowClass()
(package private) int	windowProc()
(package private) org.eclipse.swt.internal.win32.LRESULT	WM_GETDLGCODE(int wParam, int lParam)
(package private) org.eclipse.swt.internal.win32.LRESULT	WM_KILLFOCUS(int wParam, int lParam)
(package private) org.eclipse.swt.internal.win32.LRESULT	WM_SETFOCUS(int wParam, int lParam)
(package private) org.eclipse.swt.internal.win32.LRESULT	wmCommandChild(int wParam, int lParam)
(package private) org.eclipse.swt.internal.win32.LRESULT	wmDrawChild(int wParam, int lParam)

Methods inherited from class org.eclipse.swt.widgets.Control

addControlListener, addFocusListener, addHelpListener, addKeyListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addPaintListener, addTraverseListener, checkOrientation, computeSize, computeTabGroup, computeTabList, computeTabRoot, createHandle, createWidget, defaultFont, deregister, destroyWidget, drawBackground, drawBackground, findBrush, findCursor, findMnemonic, fixFocus, forceFocus, forceResize, getAccessible, getBackground, getBackgroundPixel, getBorderWidth, getBounds, getCodePage, getDisplay, getEnabled, getFont, getForeground, getForegroundPixel, getLayoutData, getLocation, getMenu, getParent, getPath, getShell, getSize, getToolTipText, getVisible, hasCursor, hasFocus, internal_dispose_GC, internal_new_GC, isActive, isDisposed, isEnabled, isFocusAncestor, isFocusControl, isReparentable, isShowing, isTabGroup, isVisible, menuShell, moveAbove, moveBelow, new_Accessible, pack, pack, redraw, redraw, register, releaseHandle, removeControlListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removePaintListener, removeTraverseListener, sendKeyEvent, sendKeyEvent, sendMouseEvent, sendMouseEvent, setBackground, setBackgroundPixel, setBounds, setBounds, setBounds, setCapture, setCursor, setDefaultFont, setEnabled, setFont, setForeground, setForegroundPixel, setLayoutData, setLocation, setLocation, setMenu, setParent, setRedraw, setSize, setSize, setTabGroupFocus, setTabItemFocus, setToolTipText, setVisible, sort, subclass, toControl, toControl, toDisplay, toDisplay, transferActive, transferFocus, translateAccelerator, translateMnemonic, translateMnemonic, translateTraversal, traverse, traverse, traverseEscape, traverseGroup, traverseItem, traverseMnemonic, traversePage, traverseReturn, unsubclass, update, update, updateFont, widgetExtStyle, windowProc, WM_ACTIVATE, WM_CHAR, WM_CLEAR, WM_CLOSE, WM_COMMAND, WM_CONTEXTMENU, WM_CTLCOLOR, WM_CUT, WM_DESTROY, WM_DRAWITEM, WM_ENDSESSION, WM_ERASEBKGND, WM_GETFONT, WM_GETOBJECT, WM_HELP, WM_HOTKEY, WM_HSCROLL, WM_IME_CHAR, WM_IME_COMPOSITION, WM_INITMENUPOPUP, WM_KEYDOWN, WM_KEYUP, WM_LBUTTONDBLCLK, WM_LBUTTONDOWN, WM_LBUTTONUP, WM_MBUTTONDBLCLK, WM_MBUTTONDOWN, WM_MBUTTONUP, WM_MEASUREITEM, WM_MENUCHAR, WM_MENUSELECT, WM_MOUSEACTIVATE, WM_MOUSEHOVER, WM_MOUSELEAVE, WM_MOUSEMOVE, WM_MOUSEWHEEL, WM_MOVE, WM_NCACTIVATE, WM_NCCALCSIZE, WM_NCHITTEST, WM_NOTIFY, WM_PAINT, WM_PALETTECHANGED, WM_PASTE, WM_PRINTCLIENT, WM_QUERYENDSESSION, WM_QUERYNEWPALETTE, WM_QUERYOPEN, WM_RBUTTONDBLCLK, WM_RBUTTONDOWN, WM_RBUTTONUP, WM_SETCURSOR, WM_SETFONT, WM_SETREDRAW, WM_SETTINGCHANGE, WM_SHOWWINDOW, WM_SIZE, WM_SYSCHAR, WM_SYSCOLORCHANGE, WM_SYSCOMMAND, WM_SYSKEYDOWN, WM_SYSKEYUP, WM_TIMER, WM_UNDO, WM_VSCROLL, WM_WINDOWPOSCHANGING, wmColorChild, wmMeasureChild, wmNotifyChild, wmScrollChild

Methods inherited from class org.eclipse.swt.widgets.Widget

addDisposeListener, addListener, checkBits, checkParent, checkSubclass, checkWidget, dispose, error, filters, getData, getData, getName, getStyle, hooks, isListening, isValidSubclass, isValidThread, mbcsToWcs, mbcsToWcs, notifyListeners, postEvent, postEvent, releaseChild, releaseResources, removeDisposeListener, removeListener, removeListener, sendEvent, sendEvent, sendEvent, sendEvent, setData, setData, setInputState, setKeyState, toString, wcsToMbcs, wcsToMbcs

Methods inherited from class java.lang.Object

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

Field Detail

image

Image image

ButtonProc

static final int ButtonProc

ButtonClass

static final org.eclipse.swt.internal.win32.TCHAR ButtonClass

CheckWidth

static final int CheckWidth

CheckHeight

static final int CheckHeight

Constructor Detail

Button

public Button(Composite parent,
              int style)

Enabled: 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

See Also:

SWT.ARROW, SWT.CHECK, SWT.PUSH, SWT.RADIO, SWT.TOGGLE, SWT.FLAT, SWT.LEFT, SWT.RIGHT, SWT.CENTER, Widget.checkSubclass(), Widget.getStyle()

Method Detail

addSelectionListener

public void addSelectionListener(SelectionListener listener)

Enabled: 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.

widgetSelected is called when the control is selected. widgetDefaultSelected is not called.

Parameters:

listener - the listener which should be notified

See Also:

SelectionListener, removeSelectionListener(org.eclipse.swt.events.SelectionListener), SelectionEvent

callWindowProc

int callWindowProc(int msg,
                   int wParam,
                   int lParam)

Specified by:

callWindowProc in class Control

checkStyle

static int checkStyle(int style)

click

void click()

computeSize

public Point computeSize(int wHint,
                         int hHint,
                         boolean changed)

Enabled:

Overrides:

computeSize in class Control

Parameters:

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

Returns:

the preferred size of the control.

See Also:

Layout, Control.getBorderWidth(), Control.getBounds(), Control.getSize(), Control.pack(), "computeTrim, getClientArea for controls that implement them"

defaultBackground

int defaultBackground()

Overrides:

defaultBackground in class Control

defaultForeground

int defaultForeground()

Overrides:

defaultForeground in class Control

getAlignment

public int getAlignment()

Enabled: Returns a value which describes the position of the text or image in the receiver. The value will be one of LEFT, RIGHT or CENTER unless the receiver is an ARROW button, in which case, the alignment will indicate the direction of the arrow (one of LEFT, RIGHT, UP or DOWN).

Returns:

the alignment

getDefault

boolean getDefault()

getImage

public Image getImage()

Enabled: Returns the receiver's image if it has one, or null if it does not.

Returns:

the receiver's image

getNameText

String getNameText()

Overrides:

getNameText in class Widget

getSelection

public boolean getSelection()

Enabled: Returns 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.

Returns:

the selection state

getText

public String getText()

Enabled: Returns the receiver's text, which will be an empty string if it has never been set.

Returns:

the receiver's text

isTabItem

boolean isTabItem()

Overrides:

isTabItem in class Control

mnemonicHit

boolean mnemonicHit(char ch)

Overrides:

mnemonicHit in class Control

mnemonicMatch

boolean mnemonicMatch(char key)

Overrides:

mnemonicMatch in class Control

releaseWidget

void releaseWidget()

Overrides:

releaseWidget in class Control

removeSelectionListener

public void removeSelectionListener(SelectionListener listener)

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

Parameters:

listener - the listener which should be notified

See Also:

SelectionListener, addSelectionListener(org.eclipse.swt.events.SelectionListener)

selectRadio

void selectRadio()

setAlignment

public void setAlignment(int alignment)

Enabled: Controls how text, images and arrows will be displayed in the receiver. The argument should be one of LEFT, RIGHT or CENTER unless the receiver is an ARROW button, in which case, the argument indicates the direction of the arrow (one of LEFT, RIGHT, UP or DOWN).

Parameters:

alignment - the new alignment

setDefault

void setDefault(boolean value)

setFocus

public boolean setFocus()

Suppressed:

Overrides:

setFocus in class Control

Returns:

true if the control got focus, and false if it was unable to.

See Also:

Control.forceFocus()

setImage

public void setImage(Image image)

Enabled: Sets the receiver's image to the argument, which may be null indicating that no image should be displayed.

Parameters:

image - the image to display on the receiver (may be null)

setRadioFocus

boolean setRadioFocus()

Overrides:

setRadioFocus in class Control

setRadioSelection

boolean setRadioSelection(boolean value)

Overrides:

setRadioSelection in class Control

setSavedFocus

boolean setSavedFocus()

Overrides:

setSavedFocus in class Control

setSelection

public void setSelection(boolean selected)

Enabled: Sets the selection state of the receiver, if it is of type 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.

Parameters:

selected - the new selection state

setText

public void setText(String string)

Enabled: Sets the receiver's text.

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.

Parameters:

string - the new text

widgetStyle

int widgetStyle()

Overrides:

widgetStyle in class Control

windowClass

org.eclipse.swt.internal.win32.TCHAR windowClass()

Specified by:

windowClass in class Control

windowProc

int windowProc()

Specified by:

windowProc in class Control

WM_GETDLGCODE

org.eclipse.swt.internal.win32.LRESULT WM_GETDLGCODE(int wParam,
                                                     int lParam)

Overrides:

WM_GETDLGCODE in class Control

WM_KILLFOCUS

org.eclipse.swt.internal.win32.LRESULT WM_KILLFOCUS(int wParam,
                                                    int lParam)

Overrides:

WM_KILLFOCUS in class Control

WM_SETFOCUS

org.eclipse.swt.internal.win32.LRESULT WM_SETFOCUS(int wParam,
                                                   int lParam)

Overrides:

WM_SETFOCUS in class Control

wmCommandChild

org.eclipse.swt.internal.win32.LRESULT wmCommandChild(int wParam,
                                                      int lParam)

Overrides:

wmCommandChild in class Control

wmDrawChild

org.eclipse.swt.internal.win32.LRESULT wmDrawChild(int wParam,
                                                   int lParam)

Overrides:

wmDrawChild in class Control