org.eclipse.swt.widgets
Class Item

java.lang.Object
  |
  +--org.eclipse.swt.widgets.Widget
        |
        +--org.eclipse.swt.widgets.Item
Direct Known Subclasses:
CoolItem, CTabItem, MenuItem, TabItem, TableColumn, TableItem, TableTreeItem, ToolItem, TreeItem

public abstract class Item
extends Widget

Safe: This class is the abstract superclass of all non-windowed user interface objects that occur within specific controls. For example, a tree will contain tree items.

Styles:
(none)
Events:
(none)


Field Summary
(package private)  Image image
           
(package private)  String text
           
 
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
Item(Widget parent, int style)
          Enabled: Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.
Item(Widget parent, int style, int index)
          Enabled: Constructs a new instance of this class given its parent and 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
protected  void checkSubclass()
          Checks that this class can be subclassed.
 Image getImage()
          Enabled: Returns the receiver's image if it has one, or null if it does not.
(package private)  String getNameText()
           
 String getText()
          Enabled: Returns the receiver's text, which will be an empty string if it has never been set.
(package private)  void releaseWidget()
           
 void setImage(Image image)
          Enabled: Sets the receiver's image to the argument, which may be null indicating that no image should be displayed.
 void setText(String string)
          Enabled: Sets the receiver's text.
 
Methods inherited from class org.eclipse.swt.widgets.Widget
addDisposeListener, addListener, checkBits, checkOrientation, checkParent, checkWidget, destroyWidget, dispose, error, filters, getData, getData, getDisplay, getName, getStyle, hooks, isDisposed, isListening, isValidSubclass, isValidThread, mbcsToWcs, mbcsToWcs, notifyListeners, postEvent, postEvent, releaseChild, releaseHandle, 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

text

String text

image

Image image
Constructor Detail

Item

public Item(Widget parent,
            int style)
Enabled: Constructs a new instance of this class given its parent 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.

Parameters:
parent - a widget which will be the parent of the new instance (cannot be null)
style - the style of item to construct
See Also:
SWT, Widget.getStyle()

Item

public Item(Widget parent,
            int style,
            int index)
Enabled: Constructs a new instance of this class given its parent and 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.

Parameters:
parent - a widget which will be the parent of the new instance (cannot be null)
style - the style of item to construct
index - the index at which to store the receiver in its parent
See Also:
SWT, Widget.getStyle()
Method Detail

checkSubclass

protected void checkSubclass()
Description copied from class: Widget
Checks that this class can be subclassed.

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.

Overrides:
checkSubclass in class Widget

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

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

releaseWidget

void releaseWidget()
Overrides:
releaseWidget in class Widget

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)

setText

public void setText(String string)
Enabled: Sets the receiver's text.

Parameters:
string - the new text


comments?