Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> eclipse >> swt >> [ widgets overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

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:

org.eclipse.swt.graphics.Drawable

---

public class Button

extends Control

Instances of this class represent a selectable user interface object that issues notification when pressed and released.

Styles:

ARROW, CHECK, PUSH, RADIO, TOGGLE, FLAT

UP, DOWN, LEFT, RIGHT, CENTER

Events:

Selection

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 intended to be subclassed only within the SWT implementation.

---

Field Summary
(package private)  long	arrowHandle
(package private)  long	boxHandle
(package private)  long	groupHandle
(package private)  org.eclipse.swt.graphics.Image	image
(package private)  long	imageHandle
(package private)  long	labelHandle
(package private)  boolean	selected
(package private)  java.lang.String	text

 

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

accessible, cursor, drawCount, enableWindow, fixedHandle, font, layoutData, menu, parent, redrawWindow, toolTipText

 

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

ACTIVATE, BUTTON_PRESS_EVENT, BUTTON_RELEASE_EVENT, CANVAS, CHANGED, CLICKED, COMMIT, CONFIGURE_EVENT, data, DEFAULT_HEIGHT, DEFAULT_WIDTH, DELETE_EVENT, DELETE_RANGE, DELETE_TEXT, DISABLED, display, DISPOSED, ENTER_NOTIFY_EVENT, EVENT, EVENT_AFTER, eventTable, EXPOSE_EVENT, FOCUS, FOCUS_IN_EVENT, FOCUS_OUT_EVENT, handle, HANDLE, HIDE, INSERT_TEXT, KEY_PRESS_EVENT, KEY_RELEASE_EVENT, KEYED_DATA, LEAVE_NOTIFY_EVENT, MAP_EVENT, MENU, MNEMONIC_ACTIVATE, MOTION_NOTIFY_EVENT, OBSCURED, POPUP_MENU, PREEDIT_CHANGED, REALIZE, ROW_ACTIVATED, SCROLL_CHILD, SELECT, SHOW, SHOW_HELP, SIZE_ALLOCATE, state, style, STYLE_SET, SWITCH_PAGE, TEST_COLLAPSE_ROW, TEST_EXPAND_ROW, TOGGLED, UNMAP_EVENT, UNREALIZE, VALUE_CHANGED, VISIBILITY_NOTIFY_EVENT, WINDOW_STATE_EVENT

 

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(org.eclipse.swt.events.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.
(package private) static int	checkStyle(int style)
org.eclipse.swt.graphics.Point	computeSize(int wHint, int hHint, boolean changed)           Returns the preferred size of the receiver.
(package private)  void	createHandle(int index)
(package private)  void	createWidget(int index)
(package private)  void	deregister()
(package private)  long	fontHandle()
int	getAlignment()           Returns a value which describes the position of the text or image in the receiver.
org.eclipse.swt.graphics.Image	getImage()           Returns the receiver's image if it has one, or null if it does not.
(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)  long	gtk_button_press_event(long widget, long event)
(package private)  long	gtk_clicked(long widget)
(package private)  long	gtk_focus_in_event(long widget, long event)
(package private)  long	gtk_focus_out_event(long widget, long event)
(package private)  long	gtk_key_press_event(long widget, long event)
(package private)  void	hookEvents()
(package private)  boolean	mnemonicHit(char key)
(package private)  boolean	mnemonicMatch(char key)
(package private)  void	register()
(package private)  void	releaseHandle()
(package private)  void	releaseWidget()
void	removeSelectionListener(org.eclipse.swt.events.SelectionListener listener)           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)           Controls how text, images and arrows will be displayed in the receiver.
(package private)  void	setBackgroundColor(org.eclipse.swt.internal.gtk.GdkColor color)
(package private)  boolean	setBounds(int x, int y, int width, int height, boolean move, boolean resize)
(package private)  void	setFontDescription(long font)
(package private)  void	setForegroundColor(org.eclipse.swt.internal.gtk.GdkColor color)
void	setImage(org.eclipse.swt.graphics.Image image)           Sets the receiver's image to the argument, which may be null indicating that no image should be displayed.
(package private)  void	setOrientation()
(package private)  boolean	setRadioSelection(boolean value)
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)  int	traversalCode(int key, org.eclipse.swt.internal.gtk.GdkEventKey event)

 

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

_getShell, addControlListener, addFocusListener, addHelpListener, addKeyListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addPaintListener, addTraverseListener, computeNativeSize, computeSize, computeTabGroup, computeTabList, computeTabRoot, defaultFont, drawGripper, enableWidget, eventHandle, filterKey, findMenus, fixChildren, fixFocus, focusHandle, forceFocus, forceFocus, getAccessible, getBackground, getBackgroundColor, getBaseColor, getBgColor, getBorderWidth, getBounds, getEnabled, getFgColor, getFont, getFontDescription, getForeground, getForegroundColor, getIMCaretPos, getLayoutData, getLocation, getMenu, getMonitor, getParent, getPath, getShell, getSize, getTextColor, getToolTipText, getVisible, gtk_button_release_event, gtk_commit, gtk_enter_notify_event, gtk_event_after, gtk_expose_event, gtk_focus, gtk_key_release_event, gtk_leave_notify_event, gtk_mnemonic_activate, gtk_motion_notify_event, gtk_popup_menu, gtk_preedit_changed, gtk_realize, gtk_show_help, gtk_unrealize, gtk_visibility_notify_event, hasFocus, hoverProc, imHandle, internal_dispose_GC, internal_new_GC, isEnabled, isFocusAncestor, isFocusControl, isReparentable, isShowing, isTabGroup, isTabItem, isVisible, menuShell, moveAbove, moveBelow, moveHandle, pack, pack, paintHandle, paintWindow, redraw, redraw, redrawWidget, releaseChild, removeControlListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removePaintListener, removeTraverseListener, resizeHandle, sendFocusEvent, sendHelpEvent, sendIMKeyEvent, sendKeyEvent, sendMouseEvent, setBackground, setBackgroundColor, setBounds, setBounds, setCapture, setCursor, setCursor, setEnabled, setFocus, setFont, setForeground, setInitialSize, setLayoutData, setLocation, setLocation, setMenu, setParent, setRedraw, setSize, setSize, setTabGroupFocus, setTabItemFocus, setToolTipText, setVisible, setZOrder, setZOrder, showMenu, sort, toControl, toControl, toDisplay, toDisplay, topHandle, translateMnemonic, translateMnemonic, translateTraversal, traverse, traverse, traverseEscape, traverseGroup, traverseItem, traverseMnemonic, traversePage, traverseReturn, update, update

 

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

addDisposeListener, addListener, checkBits, checkOrientation, checkParent, checkSubclass, checkWidget, destroyWidget, dispose, error, filterProc, filters, fixMnemonic, fontHeight, getData, getData, getDisplay, getName, getStyle, gtk_activate, gtk_changed, gtk_configure_event, gtk_delete_event, gtk_delete_range, gtk_delete_text, gtk_event, gtk_hide, gtk_insert_text, gtk_map_event, gtk_row_activated, gtk_scroll_child, gtk_select, gtk_show, gtk_size_allocate, gtk_style_set, gtk_switch_page, gtk_test_collapse_row, gtk_test_expand_row, gtk_timer, gtk_toggled, gtk_unmap_event, gtk_value_changed, gtk_window_state_event, hooks, isDisposed, isListening, isValidSubclass, isValidThread, isValidWidget, menuPositionProc, mnemonicHit, mnemonicMatch, notifyListeners, pixbufCellDataProc, postEvent, postEvent, releaseResources, removeDisposeListener, removeListener, removeListener, sendEvent, sendEvent, sendEvent, sendEvent, setData, setData, setInputState, setKeyState, shellMapProc, textCellDataProc, timerProc, toString, translateTraversal, treeSelectionProc, windowProc, windowProc, windowProc, windowProc

 

Methods inherited from class java.lang.Object

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

 

Field Detail

boxHandle

long boxHandle

---

labelHandle

long labelHandle

---

imageHandle

long imageHandle

---

arrowHandle

long arrowHandle

---

groupHandle

long groupHandle

---

selected

boolean selected

---

image

org.eclipse.swt.graphics.Image image

---

text

java.lang.String text

Constructor Detail

Button

public Button(Composite parent,
              int style)

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.

Method Detail

checkStyle

static int checkStyle(int style)

---

addSelectionListener

public void addSelectionListener(org.eclipse.swt.events.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.

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

---

computeSize

public org.eclipse.swt.graphics.Point computeSize(int wHint,
                                                  int hHint,
                                                  boolean changed)

Description copied from class: Control

Returns the preferred size of the receiver.

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.

Overrides:

computeSize in class Control

---

createHandle

void createHandle(int index)

Overrides:

createHandle in class Widget

---

createWidget

void createWidget(int index)

Overrides:

createWidget in class Control

---

deregister

void deregister()

Overrides:

deregister in class Control

---

fontHandle

long fontHandle()

Overrides:

fontHandle in class Control

---

getAlignment

public int getAlignment()

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).

---

getImage

public org.eclipse.swt.graphics.Image getImage()

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

---

getNameText

java.lang.String getNameText()

Overrides:

getNameText in class Widget

---

getSelection

public boolean getSelection()

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.

---

getText

public 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.

---

gtk_button_press_event

long gtk_button_press_event(long widget,
                            long event)

Overrides:

gtk_button_press_event in class Control

---

gtk_clicked

long gtk_clicked(long widget)

Overrides:

gtk_clicked in class Widget

---

gtk_focus_in_event

long gtk_focus_in_event(long widget,
                        long event)

Overrides:

gtk_focus_in_event in class Control

---

gtk_focus_out_event

long gtk_focus_out_event(long widget,
                         long event)

Overrides:

gtk_focus_out_event in class Control

---

gtk_key_press_event

long gtk_key_press_event(long widget,
                         long event)

Overrides:

gtk_key_press_event in class Control

---

hookEvents

void hookEvents()

Overrides:

hookEvents in class Control

---

mnemonicHit

boolean mnemonicHit(char key)

Overrides:

mnemonicHit in class Control

---

mnemonicMatch

boolean mnemonicMatch(char key)

Overrides:

mnemonicMatch in class Control

---

register

void register()

Overrides:

register in class Control

---

releaseHandle

void releaseHandle()

Overrides:

releaseHandle in class Control

---

releaseWidget

void releaseWidget()

Overrides:

releaseWidget in class Control

---

removeSelectionListener

public void removeSelectionListener(org.eclipse.swt.events.SelectionListener listener)

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

---

selectRadio

void selectRadio()

---

setAlignment

public void setAlignment(int alignment)

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).

---

setBackgroundColor

void setBackgroundColor(org.eclipse.swt.internal.gtk.GdkColor color)

Overrides:

setBackgroundColor in class Control

---

setBounds

boolean setBounds(int x,
                  int y,
                  int width,
                  int height,
                  boolean move,
                  boolean resize)

Overrides:

setBounds in class Control

---

setFontDescription

void setFontDescription(long font)

Overrides:

setFontDescription in class Control

---

setRadioSelection

boolean setRadioSelection(boolean value)

Overrides:

setRadioSelection in class Control

---

setForegroundColor

void setForegroundColor(org.eclipse.swt.internal.gtk.GdkColor color)

Overrides:

setForegroundColor in class Control

---

setImage

public void setImage(org.eclipse.swt.graphics.Image image)

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

---

setOrientation

void setOrientation()

Overrides:

setOrientation in class Widget

---

setSelection

public void setSelection(boolean selected)

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.

---

setText

public void setText(java.lang.String string)

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.

---

traversalCode

int traversalCode(int key,
                  org.eclipse.swt.internal.gtk.GdkEventKey event)

Overrides:

traversalCode in class Control

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> eclipse >> swt >> [ widgets overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---