public class Button extends Control
Note: Only one of the styles ARROW, CHECK, PUSH, RADIO, and TOGGLE may be specified.
Note: Only one of the styles LEFT, RIGHT, and CENTER may be specified.
Note: Only one of the styles UP, DOWN, LEFT, and RIGHT may be specified when the ARROW style is specified.
IMPORTANT: This class is not intended to be subclassed.
Modifier and Type | Field and Description |
---|---|
(package private) static TCHAR |
ButtonClass |
(package private) static int |
ButtonProc |
(package private) static int |
CHECK_HEIGHT |
(package private) static int |
CHECK_WIDTH |
(package private) static boolean |
COMMAND_LINK |
(package private) Image |
disabledImage |
(package private) boolean |
grayed |
(package private) static int |
ICON_HEIGHT |
(package private) static int |
ICON_WIDTH |
(package private) boolean |
ignoreMouse |
(package private) Image |
image |
(package private) Image |
image2 |
(package private) ImageList |
imageList |
(package private) static int |
MARGIN |
(package private) java.lang.String |
message |
(package private) java.lang.String |
text |
accessible, background, backgroundImage, cursor, drawCount, font, foreground, handle, layoutData, menu, parent, region, toolTipText
CANVAS, data, DEFAULT_HEIGHT, DEFAULT_WIDTH, DISABLED, display, DISPOSE_SENT, DISPOSED, DRAG_DETECT, DRAW_BACKGROUND, eventTable, FOREIGN_HANDLE, HIDDEN, IGNORE_WM_CHANGEUISTATE, KEYED_DATA, LAYOUT_CHANGED, LAYOUT_CHILD, LAYOUT_NEEDED, MAJOR, MINOR, MOVE_DEFERRED, MOVE_OCCURRED, PARENT_BACKGROUND, RELEASED, RESIZE_DEFERRED, RESIZE_OCCURRED, SKIN_NEEDED, state, style, THEME_BACKGROUND, TRACK_MOUSE
Constructor and Description |
---|
Button(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 |
---|---|
(package private) void |
_setImage(Image image) |
(package private) void |
_setText(java.lang.String text) |
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. |
(package private) int |
callWindowProc(int hwnd,
int msg,
int wParam,
int lParam) |
(package private) static int |
checkStyle(int style) |
(package private) void |
click() |
(package private) int |
computeLeftMargin() |
Point |
computeSize(int wHint,
int hHint,
boolean changed)
Returns the preferred size of the receiver.
|
(package private) void |
createHandle() |
(package private) int |
defaultBackground() |
(package private) int |
defaultForeground() |
(package private) void |
enableWidget(boolean enabled) |
int |
getAlignment()
Returns a value which describes the position of the
text or image in the receiver.
|
(package private) boolean |
getDefault() |
boolean |
getGrayed()
Returns
true if the receiver is grayed,
and false otherwise. |
Image |
getImage()
Returns the receiver's image if it has one, or null
if it does not.
|
(package private) java.lang.String |
getMessage()
Returns the widget message.
|
(package private) java.lang.String |
getNameText() |
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 or if the receiver is
an
ARROW button. |
(package private) boolean |
isTabItem() |
(package private) boolean |
mnemonicHit(char ch) |
(package private) boolean |
mnemonicMatch(char key) |
(package private) void |
releaseWidget() |
void |
removeSelectionListener(SelectionListener listener)
Removes the listener from the collection of listeners who will
be notified when the control is selected by the user.
|
(package private) void |
selectRadio() |
void |
setAlignment(int alignment)
Controls how text, images and arrows will be displayed
in the receiver.
|
(package private) void |
setDefault(boolean value) |
boolean |
setFocus()
Causes the receiver to have the keyboard focus,
such that all keyboard events will be delivered to it.
|
void |
setGrayed(boolean grayed)
Sets the grayed state of 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. |
(package private) void |
setMessage(java.lang.String message)
Sets the widget message.
|
(package private) boolean |
setRadioFocus(boolean tabbing) |
(package private) boolean |
setRadioSelection(boolean value) |
(package private) boolean |
setSavedFocus() |
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.
|
(package private) void |
updateImageList() |
(package private) void |
updateOrientation() |
(package private) void |
updateSelection(int flags) |
(package private) int |
widgetStyle() |
(package private) TCHAR |
windowClass() |
(package private) int |
windowProc() |
(package private) LRESULT |
WM_ERASEBKGND(int wParam,
int lParam) |
(package private) LRESULT |
WM_GETDLGCODE(int wParam,
int lParam) |
(package private) LRESULT |
WM_GETOBJECT(int wParam,
int lParam) |
(package private) LRESULT |
WM_KILLFOCUS(int wParam,
int lParam) |
(package private) LRESULT |
WM_LBUTTONDOWN(int wParam,
int lParam) |
(package private) LRESULT |
WM_LBUTTONUP(int wParam,
int lParam) |
(package private) LRESULT |
WM_SETFOCUS(int wParam,
int lParam) |
(package private) LRESULT |
WM_SIZE(int wParam,
int lParam) |
(package private) LRESULT |
WM_SYSCOLORCHANGE(int wParam,
int lParam) |
(package private) LRESULT |
WM_UPDATEUISTATE(int wParam,
int lParam) |
(package private) LRESULT |
wmColorChild(int wParam,
int lParam) |
(package private) LRESULT |
wmCommandChild(int wParam,
int lParam) |
(package private) LRESULT |
wmDrawChild(int wParam,
int lParam) |
addControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTouchListener, addTraverseListener, binarySearch, borderHandle, checkBackground, checkBorder, checkBuffered, checkComposited, checkGesture, checkHandle, checkMirrored, computeSize, computeTabGroup, computeTabList, computeTabRoot, createWidget, defaultFont, deregister, destroyWidget, dragDetect, dragDetect, dragDetect, drawBackground, drawBackground, drawBackground, drawImageBackground, drawThemeBackground, enableDrag, fillBackground, fillImageBackground, fillThemeBackground, findBackgroundControl, findBrush, findCursor, findImageControl, findMenus, findMnemonic, findThemeControl, fixChildren, fixFocus, forceFocus, forceResize, getAccessible, getBackground, getBackgroundImage, getBackgroundPixel, getBorderWidth, getBounds, getClipboardText, getCodePage, getCursor, getDragDetect, getDrawing, getEnabled, getFont, getForeground, getForegroundPixel, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getPath, getRegion, getShell, getSize, getToolTipText, getTouchEnabled, getVisible, hasCursor, hasFocus, internal_dispose_GC, internal_new_GC, isActive, isEnabled, isFocusAncestor, isFocusControl, isReparentable, isShowing, isTabGroup, isVisible, mapEvent, markLayout, menuShell, moveAbove, moveBelow, new_Accessible, new_GC, pack, pack, print, printWidget, redraw, redraw, redraw, redrawChildren, register, releaseHandle, releaseParent, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTouchListener, removeTraverseListener, sendFocusEvent, sendGestureEvent, sendMove, sendResize, sendTouchEvent, setBackground, setBackground, setBackgroundImage, setBackgroundImage, setBackgroundPixel, setBounds, setBounds, setBounds, setBounds, setCapture, setCursor, setCursor, setDefaultFont, setDragDetect, setEnabled, setFont, setForeground, setForegroundPixel, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRedraw, setRegion, setSize, setSize, setTabItemFocus, setToolTipText, setToolTipText, setTouchEnabled, setVisible, showWidget, sort, subclass, toControl, toControl, toDisplay, toDisplay, topHandle, translateAccelerator, translateMnemonic, translateMnemonic, translateTraversal, traverse, traverse, traverse, traverse, traverse, traverseEscape, traverseGroup, traverseItem, traverseMnemonic, traversePage, traverseReturn, unsubclass, update, update, updateBackgroundColor, updateBackgroundImage, updateBackgroundMode, updateFont, updateImages, updateLayout, widgetCreateStruct, widgetExtStyle, widgetParent, windowProc, WM_ACTIVATE, WM_CAPTURECHANGED, WM_CHANGEUISTATE, WM_CHAR, WM_CLEAR, WM_CLOSE, WM_COMMAND, WM_CONTEXTMENU, WM_CTLCOLOR, WM_CUT, WM_DESTROY, WM_DRAWITEM, WM_ENDSESSION, WM_ENTERIDLE, WM_GESTURE, WM_GETFONT, WM_GETMINMAXINFO, WM_HELP, WM_HOTKEY, WM_HSCROLL, WM_IME_CHAR, WM_IME_COMPOSITION_START, WM_IME_COMPOSITION, WM_IME_ENDCOMPOSITION, WM_INITMENUPOPUP, WM_INPUTLANGCHANGE, WM_KEYDOWN, WM_KEYUP, WM_LBUTTONDBLCLK, WM_MBUTTONDBLCLK, WM_MBUTTONDOWN, WM_MBUTTONUP, WM_MEASUREITEM, WM_MENUCHAR, WM_MENUSELECT, WM_MOUSEACTIVATE, WM_MOUSEHOVER, WM_MOUSEHWHEEL, WM_MOUSELEAVE, WM_MOUSEMOVE, WM_MOUSEWHEEL, WM_MOVE, WM_NCACTIVATE, WM_NCCALCSIZE, WM_NCHITTEST, WM_NCLBUTTONDOWN, WM_NCPAINT, WM_NOTIFY, WM_PAINT, WM_PALETTECHANGED, WM_PARENTNOTIFY, WM_PASTE, WM_PRINT, 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_SYSCHAR, WM_SYSCOMMAND, WM_SYSKEYDOWN, WM_SYSKEYUP, WM_TABLET_FLICK, WM_TIMER, WM_TOUCH, WM_UNDO, WM_UNINITMENUPOPUP, WM_VSCROLL, WM_WINDOWPOSCHANGED, WM_WINDOWPOSCHANGING, WM_XBUTTONDBLCLK, WM_XBUTTONDOWN, WM_XBUTTONUP, wmMeasureChild, wmNotify, wmNotifyChild, wmScrollChild
_addListener, addDisposeListener, addListener, checkBits, checkOpened, checkOrientation, checkParent, checkSubclass, checkWidget, DeferWindowPos, dispose, dragDetect, error, filters, findItem, fixMnemonic, fixMnemonic, getData, getData, getDisplay, getListeners, getName, getStyle, hooks, isDisposed, isListening, isValidSubclass, isValidThread, notifyListeners, postEvent, postEvent, release, releaseChildren, removeDisposeListener, removeListener, removeListener, reskin, reskinChildren, reskinWidget, sendDragEvent, sendDragEvent, sendEvent, sendEvent, sendEvent, sendEvent, sendKeyEvent, sendKeyEvent, sendMouseEvent, sendMouseEvent, sendMouseWheelEvent, sendSelectionEvent, sendSelectionEvent, setData, setData, setInputState, setKeyState, setLocationMask, setTabGroupFocus, SetWindowPos, showMenu, showMenu, toString, updateMenuLocation, wmCaptureChanged, wmChar, wmContextMenu, wmIMEChar, wmKeyDown, wmKeyUp, wmKillFocus, wmLButtonDblClk, wmLButtonDown, wmLButtonUp, wmMButtonDblClk, wmMButtonDown, wmMButtonUp, wmMouseHover, wmMouseHWheel, wmMouseLeave, wmMouseMove, wmMouseWheel, wmNCPaint, wmPaint, wmPrint, wmRButtonDblClk, wmRButtonDown, wmRButtonUp, wmSetFocus, wmSysChar, wmSysKeyDown, wmSysKeyUp, wmXButtonDblClk, wmXButtonDown, wmXButtonUp
java.lang.String text
java.lang.String message
Image image
Image image2
Image disabledImage
ImageList imageList
boolean ignoreMouse
boolean grayed
static final int MARGIN
static final int CHECK_WIDTH
static final int CHECK_HEIGHT
static final int ICON_WIDTH
static final int ICON_HEIGHT
static boolean COMMAND_LINK
static final int ButtonProc
static final TCHAR ButtonClass
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 constructjava.lang.IllegalArgumentException
- SWTException
- SWT.ARROW
,
SWT.CHECK
,
SWT.PUSH
,
SWT.RADIO
,
SWT.TOGGLE
,
SWT.FLAT
,
SWT.UP
,
SWT.DOWN
,
SWT.LEFT
,
SWT.RIGHT
,
SWT.CENTER
,
Widget.checkSubclass()
,
Widget.getStyle()
void _setImage(Image image)
void _setText(java.lang.String text)
public void addSelectionListener(SelectionListener listener)
SelectionListener
interface.
widgetSelected
is called when the control is selected by the user.
widgetDefaultSelected
is not called.
When the SWT.RADIO
style bit is set, the widgetSelected
method is
also called when the receiver loses selection because another item in the same radio group
was selected by the user. During widgetSelected
the application can use
getSelection()
to determine the current selected state of the receiver.
listener
- the listener which should be notifiedjava.lang.IllegalArgumentException
- SWTException
- SelectionListener
,
removeSelectionListener(org.eclipse.swt.events.SelectionListener)
,
SelectionEvent
int callWindowProc(int hwnd, int msg, int wParam, int lParam)
callWindowProc
in class Widget
static int checkStyle(int style)
void click()
int computeLeftMargin()
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 Control
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"void createHandle()
createHandle
in class Control
int defaultBackground()
defaultBackground
in class Control
int defaultForeground()
defaultForeground
in class Control
void enableWidget(boolean enabled)
enableWidget
in class Control
public int getAlignment()
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
).SWTException
- boolean getDefault()
public boolean getGrayed()
true
if the receiver is grayed,
and false otherwise. When the widget does not have
the CHECK
style, return false.SWTException
- public Image getImage()
SWTException
- java.lang.String getMessage()
SWT.COMMAND
, the message text
is displayed to provide further information for the user.SWTException
- java.lang.String getNameText()
getNameText
in class Widget
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()
ARROW
button.SWTException
- boolean mnemonicHit(char ch)
mnemonicHit
in class Control
boolean mnemonicMatch(char key)
mnemonicMatch
in class Control
void releaseWidget()
releaseWidget
in class Control
public void removeSelectionListener(SelectionListener listener)
listener
- the listener which should no longer be notifiedjava.lang.IllegalArgumentException
- SWTException
- SelectionListener
,
addSelectionListener(org.eclipse.swt.events.SelectionListener)
void selectRadio()
public void setAlignment(int alignment)
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
).alignment
- the new alignmentSWTException
- void setDefault(boolean value)
public boolean setFocus()
Control
setFocus
in class Control
true
if the control got focus, and false
if it was unable to.Control.forceFocus()
public void setImage(Image image)
null
indicating that no image should be displayed.
Note that a Button can display an image and text simultaneously on Windows (starting with XP), GTK+ and OSX. On other platforms, a Button that has an image and text set into it will display the image or text that was set most recently.
image
- the image to display on the receiver (may be null
)java.lang.IllegalArgumentException
- SWTException
- public void setGrayed(boolean grayed)
grayed
- the new grayed stateSWTException
- void setMessage(java.lang.String message)
SWT.COMMAND
, the message text
is displayed to provide further information for the user.message
- the new messagejava.lang.IllegalArgumentException
- SWTException
- boolean setRadioFocus(boolean tabbing)
setRadioFocus
in class Control
boolean setRadioSelection(boolean value)
setRadioSelection
in class Control
boolean setSavedFocus()
setSavedFocus
in class Control
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 stateSWTException
- 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 emphasized in a platform specific manner. The mnemonic indicator character '&' can be escaped by doubling it in the string, causing a single '&' to be displayed.
Note that a Button can display an image and text simultaneously on Windows (starting with XP), GTK+ and OSX. On other platforms, a Button that has an image and text set into it will display the image or text that was set most recently.
string
- the new textjava.lang.IllegalArgumentException
- SWTException
- void updateImageList()
void updateOrientation()
updateOrientation
in class Control
void updateSelection(int flags)
int widgetStyle()
widgetStyle
in class Control
TCHAR windowClass()
windowClass
in class Control
int windowProc()
windowProc
in class Control
LRESULT WM_ERASEBKGND(int wParam, int lParam)
WM_ERASEBKGND
in class Control
LRESULT WM_GETDLGCODE(int wParam, int lParam)
WM_GETDLGCODE
in class Control
LRESULT WM_GETOBJECT(int wParam, int lParam)
WM_GETOBJECT
in class Control
LRESULT WM_KILLFOCUS(int wParam, int lParam)
WM_KILLFOCUS
in class Control
LRESULT WM_LBUTTONDOWN(int wParam, int lParam)
WM_LBUTTONDOWN
in class Control
LRESULT WM_LBUTTONUP(int wParam, int lParam)
WM_LBUTTONUP
in class Control
LRESULT WM_SETFOCUS(int wParam, int lParam)
WM_SETFOCUS
in class Control
LRESULT WM_SYSCOLORCHANGE(int wParam, int lParam)
WM_SYSCOLORCHANGE
in class Control
LRESULT WM_UPDATEUISTATE(int wParam, int lParam)
WM_UPDATEUISTATE
in class Control
LRESULT wmCommandChild(int wParam, int lParam)
wmCommandChild
in class Control
LRESULT wmColorChild(int wParam, int lParam)
wmColorChild
in class Control
LRESULT wmDrawChild(int wParam, int lParam)
wmDrawChild
in class Control