net.sf.ecl.datepicker
Class ToolButton

java.lang.Object
  org.eclipse.swt.widgets.Widget
      org.eclipse.swt.widgets.Control
          org.eclipse.swt.widgets.Scrollable
              org.eclipse.swt.widgets.Composite
                  net.sf.ecl.datepicker.ToolButton

All Implemented Interfaces:

Drawable

public final class ToolButton
extends Composite

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

Styles:

PUSH, CHECK, RADIO, DROP_DOWN, SEPARATOR

FLAT, RIGHT, SHADOW_OUT

Events:

Selection

Note: Only one of the styles PUSH, CHECK, RADIO, DROP_DOWN and SEPARATOR may be specified.

Author:

Alexey Afanasyev, Alexey Kharlamov

Field Summary

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

handle

Constructor Summary

ToolButton(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.
Point	computeSize(int wHint, int hHint, boolean changed)
Image	getDisabledImage() Returns the receiver's disabled image if it has one, or null if it does not.
Image	getHotImage() Returns the receiver's hot image if it has one, or null if it does not.
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.
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.
void	layout(boolean changed)
void	removeSelectionListener(SelectionListener listener) Removes the listener from the collection of listeners who will be notified when the control is selected.
void	setBackground(Color color)
void	setDisabledImage(Image image) Sets the receiver's disabled image to the argument, which may be null indicating that no disabled image should be displayed.
void	setEnabled(boolean enabled)
void	setFont(Font font)
void	setForeground(Color color)
void	setHotImage(Image image) Sets the receiver's hot image to the argument, which may be null indicating that no hot image should be displayed.
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.
void	setText(String text) Sets the receiver's text.
void	setToolTipText(String text)

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

changed, checkSubclass, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList

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

computeTrim, getClientArea, getHorizontalBar, getVerticalBar

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

addControlListener, addFocusListener, addHelpListener, addKeyListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addPaintListener, addTraverseListener, computeSize, forceFocus, getAccessible, getBackground, getBackgroundImage, getBorderWidth, getBounds, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getParent, getShell, getSize, getToolTipText, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, redraw, redraw, removeControlListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removePaintListener, removeTraverseListener, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setLayoutData, setLocation, setLocation, setMenu, setParent, setRedraw, setSize, setSize, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, update

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

addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, setData, setData, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolButton

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

Parameters:

parent - a composite control which will be the parent of the new instance (cannot be null)

style - the style of control to construct

Throws:

IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the parent is null

SWTException -

• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
• ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass

See Also:

SWT.PUSH, SWT.CHECK, SWT.RADIO, SWT.FLAT, SWT.RIGHT, Widget.checkSubclass(), Widget.getStyle()

Method Detail

addSelectionListener

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

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

Parameters:

listener - the listener which should be notified

Throws:

IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

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

computeSize

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

Overrides:

computeSize in class Composite

getDisabledImage

public Image getDisabledImage()

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

The disabled image is displayed when the receiver is disabled.

Returns:

the receiver's disabled image

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getHotImage

public Image getHotImage()

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

The hot image is displayed when the mouse enters the receiver.

Returns:

the receiver's hot image

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getImage

public Image getImage()

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

Returns:

the receiver's image

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

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 (which some platforms draw as a pushed in button). If the receiver is of any other type, this method returns false.

Returns:

the selection state

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getText

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

Returns:

the receiver's text

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

layout

public void layout(boolean changed)

Overrides:

layout in class Composite

removeSelectionListener

public void removeSelectionListener(SelectionListener listener)

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

Throws:

IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

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

setBackground

public void setBackground(Color color)

Overrides:

setBackground in class Control

setDisabledImage

public void setDisabledImage(Image image)

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

The disbled image is displayed when the receiver is disabled.

Parameters:

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

Throws:

IllegalArgumentException -

• ERROR_INVALID_ARGUMENT - if the image has been disposed

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setFont

public void setFont(Font font)

Overrides:

setFont in class Control

setForeground

public void setForeground(Color color)

Overrides:

setForeground in class Control

setHotImage

public void setHotImage(Image image)

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

The hot image is displayed when the mouse enters the receiver.

Parameters:

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

Throws:

IllegalArgumentException -

• ERROR_INVALID_ARGUMENT - if the image has been disposed

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setImage

public void setImage(Image image)

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)

Throws:

IllegalArgumentException -

• ERROR_INVALID_ARGUMENT - if the image has been disposed

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setSelection

public void setSelection(boolean selected)

Sets the selection state of the receiver.

When the receiver is of type CHECK or RADIO, it is selected when it is checked (which some platforms draw as a pushed in button).

Parameters:

selected - the new selection state

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setText

public void setText(String text)

Sets the receiver's text. The string may include the mnemonic character.

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

Throws:

IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the text is null

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setToolTipText

public void setToolTipText(String text)

Overrides:

setToolTipText in class Control

setEnabled

public void setEnabled(boolean enabled)

Overrides:

setEnabled in class Control