org.eclipse.swt.widgets
Class TableItem

java.lang.Object
  |
  +--org.eclipse.swt.widgets.Widget
        |
        +--org.eclipse.swt.widgets.Item
              |
              +--org.eclipse.swt.widgets.TableItem

public class TableItem

extends Item

Safe: Instances of this class represent a selectable user interface object that represents an item in a table.

Styles:

(none)

Events:

(none)

IMPORTANT: This class is not intended to be subclassed.

Field Summary

(package private) int	background
(package private) int	foreground
(package private) Table	parent

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

image, 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

TableItem(Table parent, int style)
Enabled: Constructs a new instance of this class given its parent (which must be a Table) and a style value describing its behavior and appearance.

TableItem(Table parent, int style, int index)
Enabled: Constructs a new instance of this class given its parent (which must be a Table), 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.
Color	getBackground() Enabled: Returns the receiver's background color.
Rectangle	getBounds(int index) Enabled: Returns a rectangle describing the receiver's size and location relative to its parent at a column in the table.
boolean	getChecked() Enabled: Returns true if the receiver is checked, and false otherwise.
Display	getDisplay() Suppressed:
Color	getForeground() Enabled: Returns the foreground color that the receiver will use to draw.
boolean	getGrayed() Enabled: Returns true if the receiver is grayed, and false otherwise.
Image	getImage(int index) Enabled: Returns the image stored at the given column index in the receiver, or null if the image has not been set or if the column does not exist.
Rectangle	getImageBounds(int index) Enabled: Returns a rectangle describing the size and location relative to its parent of an image at a column in the table.
int	getImageIndent() Enabled: Gets the image indent.
Table	getParent() Suppressed: Returns the receiver's parent, which must be a Table.
String	getText(int index) Enabled: Returns the text stored at the given column index in the receiver, or empty string if the text has not been set.
(package private) void	redraw()
(package private) void	releaseChild()
(package private) void	releaseWidget()
void	setBackground(Color color) Enabled: Sets the receiver's background color to the color specified by the argument, or to the default system color for the item if the argument is null.
void	setChecked(boolean checked) Enabled: Sets the checked state of the checkbox for this item.
void	setForeground(Color color) Enabled: Sets the receiver's foreground color to the color specified by the argument, or to the default system color for the item if the argument is null.
void	setGrayed(boolean grayed) Enabled: Sets the grayed state of the checkbox for this item.
void	setImage(Image image) Enabled:
void	setImage(Image[] images) Enabled: Sets the image for multiple columns in the Table.
void	setImage(int index, Image image) Enabled: Sets the receiver's image at a column.
void	setImageIndent(int indent) Enabled: Sets the image indent.
void	setText(int index, String string) Enabled: Sets the receiver's text at a column
void	setText(String string) Enabled:
void	setText(String[] strings) Enabled: Sets the text for multiple columns in the table.

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

getImage, getNameText, getText

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

addDisposeListener, addListener, checkBits, checkOrientation, checkParent, checkWidget, destroyWidget, dispose, error, filters, getData, getData, getName, getStyle, hooks, isDisposed, isListening, isValidSubclass, isValidThread, mbcsToWcs, mbcsToWcs, notifyListeners, postEvent, postEvent, 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

parent

Table parent

background

int background

foreground

int foreground

Constructor Detail

TableItem

public TableItem(Table parent,
                 int style)

Enabled: Constructs a new instance of this class given its parent (which must be a Table) 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 composite control which will be the parent of the new instance (cannot be null)

style - the style of control to construct

See Also:

SWT, Widget.checkSubclass(), Widget.getStyle()

TableItem

public TableItem(Table parent,
                 int style,
                 int index)

Enabled: Constructs a new instance of this class given its parent (which must be a Table), 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 composite control which will be the parent of the new instance (cannot be null)

style - the style of control to construct

index - the index to store the receiver in its parent

See Also:

SWT, Widget.checkSubclass(), 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 Item

getBackground

public Color getBackground()

Enabled: Returns the receiver's background color.

Returns:

the background color

Since:

2.0

getBounds

public Rectangle getBounds(int index)

Enabled: Returns a rectangle describing the receiver's size and location relative to its parent at a column in the table.

Parameters:

index - the index that specifies the column

Returns:

the receiver's bounding column rectangle

getChecked

public boolean getChecked()

Enabled: Returns true if the receiver is checked, and false otherwise. When the parent does not have the CHECK style, return false.

Returns:

the checked state of the checkbox

getDisplay

public Display getDisplay()

Suppressed:

Specified by:

getDisplay in class Widget

Returns:

the receiver's display

getForeground

public Color getForeground()

Enabled: Returns the foreground color that the receiver will use to draw.

Returns:

the receiver's foreground color

Since:

2.0

getGrayed

public boolean getGrayed()

Enabled: Returns true if the receiver is grayed, and false otherwise. When the parent does not have the CHECK style, return false.

Returns:

the grayed state of the checkbox

getImage

public Image getImage(int index)

Enabled: Returns the image stored at the given column index in the receiver, or null if the image has not been set or if the column does not exist.

Parameters:

index - the column index

Returns:

the image stored at the given column index in the receiver

getImageBounds

public Rectangle getImageBounds(int index)

Enabled: Returns a rectangle describing the size and location relative to its parent of an image at a column in the table.

Parameters:

index - the index that specifies the column

Returns:

the receiver's bounding image rectangle

getImageIndent

public int getImageIndent()

Enabled: Gets the image indent.

Returns:

the indent

getParent

public Table getParent()

Suppressed: Returns the receiver's parent, which must be a Table.

Returns:

the receiver's parent

getText

public String getText(int index)

Enabled: Returns the text stored at the given column index in the receiver, or empty string if the text has not been set.

Parameters:

index - the column index

Returns:

the text stored at the given column index in the receiver

redraw

void redraw()

releaseChild

void releaseChild()

Overrides:

releaseChild in class Widget

releaseWidget

void releaseWidget()

Overrides:

releaseWidget in class Item

setBackground

public void setBackground(Color color)

Enabled: Sets the receiver's background color to the color specified by the argument, or to the default system color for the item if the argument is null.

Parameters:

color - the new color (or null)

Since:

2.0

setChecked

public void setChecked(boolean checked)

Enabled: Sets the checked state of the checkbox for this item. This state change only applies if the Table was created with the SWT.CHECK style.

Parameters:

checked - the new checked state of the checkbox

setForeground

public void setForeground(Color color)

Enabled: Sets the receiver's foreground color to the color specified by the argument, or to the default system color for the item if the argument is null.

Parameters:

color - the new color (or null)

Since:

2.0

setGrayed

public void setGrayed(boolean grayed)

Enabled: Sets the grayed state of the checkbox for this item. This state change only applies if the Table was created with the SWT.CHECK style.

Parameters:

grayed - the new grayed state of the checkbox;

setImage

public void setImage(Image[] images)

Enabled: Sets the image for multiple columns in the Table.

Parameters:

images - the array of new images

setImage

public void setImage(int index,
                     Image image)

Enabled: Sets the receiver's image at a column.

Parameters:

index - the column index

image - the new image

setImage

public void setImage(Image image)

Enabled:

Overrides:

setImage in class Item

Parameters:

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

setImageIndent

public void setImageIndent(int indent)

Enabled: Sets the image indent.

Parameters:

indent - the new indent

setText

public void setText(String[] strings)

Enabled: Sets the text for multiple columns in the table.

Parameters:

strings - the array of new strings

setText

public void setText(int index,
                    String string)

Enabled: Sets the receiver's text at a column

Parameters:

index - the column index

string - the new text

setText

public void setText(String string)

Enabled:

Overrides:

setText in class Item

Parameters:

string - the new text