|
|||||||||
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.Item
org.eclipse.swt.widgets.ToolItem
public class ToolItem
Instances of this class represent a selectable user interface object that represents a button in a tool bar.
Note: Only one of the styles CHECK, PUSH, RADIO, SEPARATOR and DROP_DOWN may be specified.
IMPORTANT: This class is not intended to be subclassed.
Field Summary |
---|
Fields inherited from class org.eclipse.swt.widgets.Widget |
---|
handle |
Constructor Summary | |
---|---|
ToolItem(ToolBar parent,
int style)
Constructs a new instance of this class given its parent (which must be a ToolBar ) and a style value
describing its behavior and appearance. |
|
ToolItem(ToolBar parent,
int style,
int index)
Constructs a new instance of this class given its parent (which must be a ToolBar ), a style value
describing its behavior and appearance, and the index
at which to place it in the items maintained by its parent. |
Method Summary | |
---|---|
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. |
protected void |
checkSubclass()
Checks that this class can be subclassed. |
void |
dispose()
Disposes of the operating system resources associated with the receiver and all its descendants. |
Rectangle |
getBounds()
Returns a rectangle describing the receiver's size and location relative to its parent. |
Control |
getControl()
Returns the control that is used to fill the bounds of the item when the item is a SEPARATOR . |
Image |
getDisabledImage()
Returns the receiver's disabled image if it has one, or null if it does not. |
boolean |
getEnabled()
Returns true if the receiver is enabled, and
false otherwise. |
Image |
getHotImage()
Returns the receiver's hot image if it has one, or null if it does not. |
ToolBar |
getParent()
Returns the receiver's parent, which must be a ToolBar . |
boolean |
getSelection()
Returns true if the receiver is selected,
and false otherwise. |
java.lang.String |
getToolTipText()
Returns the receiver's tool tip text, or null if it has not been set. |
int |
getWidth()
Gets the width of the receiver. |
boolean |
isEnabled()
Returns true if the receiver is enabled and all
of the receiver's ancestors are enabled, and false
otherwise. |
void |
removeSelectionListener(SelectionListener listener)
Removes the listener from the collection of listeners who will be notified when the control is selected by the user. |
void |
setControl(Control control)
Sets the control that is used to fill the bounds of the item when the item is a SEPARATOR . |
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)
Enables the receiver if the argument is true ,
and disables it otherwise. |
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(java.lang.String string)
Sets the receiver's text. |
void |
setToolTipText(java.lang.String string)
Sets the receiver's tool tip text to the argument, which may be null indicating that no tool tip text should be shown. |
void |
setWidth(int width)
Sets the width of the receiver, for SEPARATOR ToolItems. |
Methods inherited from class org.eclipse.swt.widgets.Item |
---|
getImage, getText |
Methods inherited from class org.eclipse.swt.widgets.Widget |
---|
addDisposeListener, addListener, checkWidget, getData, getData, getDisplay, getListeners, 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 |
---|
public ToolItem(ToolBar parent, int style)
ToolBar
) and a style value
describing its behavior and appearance. The item is added
to the end of the items maintained by its parent.
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.PUSH
,
SWT.CHECK
,
SWT.RADIO
,
SWT.SEPARATOR
,
SWT.DROP_DOWN
,
Widget.checkSubclass()
,
Widget.getStyle()
public ToolItem(ToolBar parent, int style, int index)
ToolBar
), a style value
describing its behavior and appearance, and the index
at which to place it in the items maintained by its parent.
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 constructindex
- the zero-relative index to store the receiver in its parent
java.lang.IllegalArgumentException
- SWTException
- SWT.PUSH
,
SWT.CHECK
,
SWT.RADIO
,
SWT.SEPARATOR
,
SWT.DROP_DOWN
,
Widget.checkSubclass()
,
Widget.getStyle()
Method Detail |
---|
public void addSelectionListener(SelectionListener listener)
SelectionListener
interface.
When widgetSelected
is called when the mouse is over the arrow portion of a drop-down tool,
the event object detail field contains the value SWT.ARROW
.
widgetDefaultSelected
is not called.
listener
- the listener which should be notified when the control is selected by the user,
java.lang.IllegalArgumentException
- SWTException
- SelectionListener
,
removeSelectionListener(org.eclipse.swt.events.SelectionListener)
,
SelectionEvent
protected void checkSubclass()
Widget
The SWT class library is intended to be subclassed
only at specific, controlled points (most notably,
Composite
and Canvas
when
implementing new widgets). This method enforces this
rule unless it is overridden.
IMPORTANT: By providing an implementation of this method that allows a subclass of a class which does not normally allow subclassing to be created, the implementer agrees to be fully responsible for the fact that any such subclass will likely fail between SWT releases and will be strongly platform specific. No support is provided for user-written classes which are implemented in this fashion.
The ability to subclass outside of the allowed SWT classes is intended purely to enable those not on the SWT development team to implement patches in order to get around specific limitations in advance of when those limitations can be addressed by the team. Subclassing should not be attempted without an intimate and detailed understanding of the hierarchy.
checkSubclass
in class Item
public void dispose()
Widget
true
when sent the message isDisposed()
.
Any internal connections between the widgets in the tree will
have been removed to facilitate garbage collection.
NOTE: This method is not called recursively on the descendants
of the receiver. This means that, widget implementers can not
detect when a widget is being disposed of by re-implementing
this method, but should instead listen for the Dispose
event.
dispose
in class Widget
Widget.addDisposeListener(org.eclipse.swt.events.DisposeListener)
,
Widget.removeDisposeListener(org.eclipse.swt.events.DisposeListener)
,
Widget.checkWidget()
public Rectangle getBounds()
SWTException
- public Control getControl()
SEPARATOR
.
SWTException
- public Image getDisabledImage()
The disabled image is displayed when the receiver is disabled.
SWTException
- public boolean getEnabled()
true
if the receiver is enabled, and
false
otherwise. A disabled control is typically
not selectable from the user interface and draws with an
inactive or "grayed" look.
SWTException
- isEnabled()
public Image getHotImage()
The hot image is displayed when the mouse enters the receiver.
SWTException
- public ToolBar getParent()
ToolBar
.
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 (which some platforms draw as a
pushed in button). If the receiver is of any other type, this method
returns false.
SWTException
- public java.lang.String getToolTipText()
SWTException
- public int getWidth()
SWTException
- public boolean isEnabled()
true
if the receiver is enabled and all
of the receiver's ancestors are enabled, and false
otherwise. A disabled control is typically not selectable from the
user interface and draws with an inactive or "grayed" look.
SWTException
- getEnabled()
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 setControl(Control control)
SEPARATOR
.
control
- the new control
java.lang.IllegalArgumentException
- SWTException
- public void setDisabledImage(Image image)
The disabled image is displayed when the receiver is disabled.
image
- the disabled image to display on the receiver (may be null)
java.lang.IllegalArgumentException
- SWTException
- public void setEnabled(boolean enabled)
true
,
and disables it otherwise.
A disabled control is typically not selectable from the user interface and draws with an inactive or "grayed" look.
enabled
- the new enabled state
SWTException
- public void setHotImage(Image image)
The hot image is displayed when the mouse enters the receiver.
image
- the hot image to display on the receiver (may be null)
java.lang.IllegalArgumentException
- SWTException
- public void setImage(Image image)
Item
setImage
in class Item
image
- the image to display on the receiver (may be null)public void setSelection(boolean selected)
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).
selected
- the new selection state
SWTException
- public void setText(java.lang.String string)
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.
setText
in class Item
string
- the new text
java.lang.IllegalArgumentException
- SWTException
- public void setToolTipText(java.lang.String string)
string
- the new tool tip text (or null)
SWTException
- public void setWidth(int width)
SEPARATOR
ToolItems.
width
- the new width
SWTException
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |