Class TableItem
- java.lang.Object
-
- org.eclipse.swt.widgets.Widget
-
- org.eclipse.swt.widgets.Item
-
- org.eclipse.swt.widgets.TableItem
-
-
Constructor Summary
Constructors Constructor Description TableItem(Table parent, int style)Constructs a new instance of this class given its parent (which must be aTable) and a style value describing its behavior and appearance.TableItem(Table parent, int style, int index)Constructs a new instance of this class given its parent (which must be aTable), 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description <T> TgetAdapter(java.lang.Class<T> adapter)Implementation of theAdaptableinterface.ColorgetBackground()Returns the receiver's background color.ColorgetBackground(int index)Returns the background color at the given column index in the receiver.RectanglegetBounds()Returns a rectangle describing the receiver's size and location relative to its parent.RectanglegetBounds(int index)Returns a rectangle describing the receiver's size and location relative to its parent at a column in the table.booleangetChecked()Returnstrueif the receiver is checked, and false otherwise.FontgetFont()Returns the font that the receiver will use to paint textual information for this item.FontgetFont(int index)Returns the font that the receiver will use to paint textual information for the specified cell in this item.ColorgetForeground()Returns the foreground color that the receiver will use to draw.ColorgetForeground(int index)Returns the foreground color at the given column index in the receiver.booleangetGrayed()Returnstrueif the receiver is grayed, and false otherwise.ImagegetImage()Returns the receiver's image if it has one, or null if it does not.ImagegetImage(int index)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.RectanglegetImageBounds(int index)Returns a rectangle describing the size and location relative to its parent of an image at a column in the table.intgetImageIndent()Gets the image indent.TablegetParent()Returns the receiver's parent, which must be aTable.java.lang.StringgetText()Returns the receiver's text, which will be an empty string if it has never been set.java.lang.StringgetText(int index)Returns the text stored at the given column index in the receiver, or empty string if the text has not been set.RectanglegetTextBounds(int index)Returns a rectangle describing the size and location relative to its parent of the text at a column in the table.voidsetBackground(int index, Color color)Sets the background color at the given column index in the receiver to the color specified by the argument, or to the default system color for the item if the argument is null.voidsetBackground(Color color)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.voidsetChecked(boolean checked)Sets the checked state of the checkbox for this item.voidsetFont(int index, Font font)Sets the font that the receiver will use to paint textual information for the specified cell in this item to the font specified by the argument, or to the default font for that kind of control if the argument is null.voidsetFont(Font font)Sets the font that the receiver will use to paint textual information for this item to the font specified by the argument, or to the default font for that kind of control if the argument is null.voidsetForeground(int index, Color color)Sets the foreground color at the given column index in the receiver to the color specified by the argument, or to the default system color for the item if the argument is null.voidsetForeground(Color color)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.voidsetGrayed(boolean grayed)Sets the grayed state of the checkbox for this item.voidsetImage(int index, Image image)Sets the receiver's image at a column.voidsetImage(Image image)Sets the receiver's image to the argument, which may be null indicating that no image should be displayed.voidsetImage(Image[] images)Sets the image for multiple columns in the table.voidsetText(int index, java.lang.String text)Sets the receiver's text at a columnvoidsetText(java.lang.String text)Sets the receiver's text.voidsetText(java.lang.String[] strings)Sets the text for multiple columns in the table.-
Methods inherited from class org.eclipse.swt.widgets.Widget
addDisposeListener, addListener, checkSubclass, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, reskin, setData, setData, toString
-
-
-
-
Constructor Detail
-
TableItem
public TableItem(Table parent, int style)
Constructs a new instance of this class given its parent (which must be aTable) 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
SWTwhich is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using theint"|" operator) two or more of thoseSWTstyle 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:
java.lang.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,Widget.checkSubclass(),Widget.getStyle()
-
TableItem
public TableItem(Table parent, int style, int index)
Constructs a new instance of this class given its parent (which must be aTable), 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
SWTwhich is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using theint"|" operator) two or more of thoseSWTstyle 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 constructindex- the zero-relative index to store the receiver in its parent- Throws:
java.lang.IllegalArgumentException-- ERROR_NULL_ARGUMENT - if the parent is null
- ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the parent (inclusive)
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,Widget.checkSubclass(),Widget.getStyle()
-
-
Method Detail
-
getAdapter
public <T> T getAdapter(java.lang.Class<T> adapter)
Description copied from class:WidgetImplementation of theAdaptableinterface.IMPORTANT: This method is not part of the RWT public API. It is marked public only so that it can be shared within the packages provided by RWT. It should never be accessed from application code.
- Specified by:
getAdapterin interfaceAdaptable- Overrides:
getAdapterin classWidget- Parameters:
adapter- the lookup class- Returns:
- an object that can be cast to the given class or
nullif there is no adapter associated with the given class.
-
getParent
public Table getParent()
Returns the receiver's parent, which must be aTable.- Returns:
- the receiver's parent
- 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(java.lang.String text)
Description copied from class:ItemSets the receiver's text.
-
setText
public void setText(int index, java.lang.String text)Sets the receiver's text at a column- Parameters:
index- the column indextext- the new text- Throws:
java.lang.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
-
setText
public void setText(java.lang.String[] strings)
Sets the text for multiple columns in the table.- Parameters:
strings- the array of new strings- Throws:
java.lang.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
- Since:
- 1.2
-
getText
public java.lang.String getText()
Description copied from class:ItemReturns the receiver's text, which will be an empty string if it has never been set.
-
getText
public java.lang.String getText(int index)
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
- 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
-
setImage
public void setImage(Image image)
Description copied from class:ItemSets the receiver's image to the argument, which may be null indicating that no image should be displayed.
-
setImage
public void setImage(int index, Image image)Sets the receiver's image at a column.- Parameters:
index- the column indeximage- the new image- Throws:
java.lang.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[] images)
Sets the image for multiple columns in the table.- Parameters:
images- the array of new images- Throws:
java.lang.IllegalArgumentException-- ERROR_NULL_ARGUMENT - if the array of images is null
- ERROR_INVALID_ARGUMENT - if one of the images 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
-
getImage
public Image getImage()
Description copied from class:ItemReturns the receiver's image if it has one, or null if it does not.
-
getImage
public Image getImage(int index)
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
- 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
-
setBackground
public void setBackground(Color color)
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)- Throws:
java.lang.IllegalArgumentException-- ERROR_INVALID_ARGUMENT - if the argument 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
-
getBackground
public Color getBackground()
Returns the receiver's background color.- Returns:
- the background color
- 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
-
setBackground
public void setBackground(int index, Color color)Sets the background color at the given column index in the receiver to the color specified by the argument, or to the default system color for the item if the argument is null.- Parameters:
index- the column indexcolor- the new color (or null)- Throws:
java.lang.IllegalArgumentException-- ERROR_INVALID_ARGUMENT - if the argument 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
-
getBackground
public Color getBackground(int index)
Returns the background color at the given column index in the receiver.- Parameters:
index- the column index- Returns:
- the background color
- 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
-
setForeground
public void setForeground(Color color)
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)- Throws:
java.lang.IllegalArgumentException-- ERROR_INVALID_ARGUMENT - if the argument 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
-
getForeground
public Color getForeground()
Returns the foreground color that the receiver will use to draw.- Returns:
- the receiver's foreground color
- 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
-
setForeground
public void setForeground(int index, Color color)Sets the foreground color at the given column index in the receiver to the color specified by the argument, or to the default system color for the item if the argument is null.- Parameters:
index- the column indexcolor- the new color (or null)- Throws:
java.lang.IllegalArgumentException-- ERROR_INVALID_ARGUMENT - if the argument 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
-
getForeground
public Color getForeground(int index)
Returns the foreground color at the given column index in the receiver.- Parameters:
index- the column index- Returns:
- the foreground color
- 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
-
setFont
public void setFont(Font font)
Sets the font that the receiver will use to paint textual information for this item to the font specified by the argument, or to the default font for that kind of control if the argument is null.- Parameters:
font- the new font (or null)- Throws:
java.lang.IllegalArgumentException-- ERROR_INVALID_ARGUMENT - if the argument 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
-
getFont
public Font getFont()
Returns the font that the receiver will use to paint textual information for this item.- Returns:
- the receiver's font
- 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
-
setFont
public void setFont(int index, Font font)Sets the font that the receiver will use to paint textual information for the specified cell in this item to the font specified by the argument, or to the default font for that kind of control if the argument is null.- Parameters:
index- the column indexfont- the new font (or null)- Throws:
java.lang.IllegalArgumentException-- ERROR_INVALID_ARGUMENT - if the argument 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
-
getFont
public Font getFont(int index)
Returns the font that the receiver will use to paint textual information for the specified cell in this item.- Parameters:
index- the column index- Returns:
- the receiver's font
- 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
-
setChecked
public void setChecked(boolean checked)
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- 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
-
getChecked
public boolean getChecked()
Returnstrueif the receiver is checked, and false otherwise. When the parent does not have theCHECKstyle, return false.- Returns:
- the checked state of the checkbox
- 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
-
setGrayed
public void setGrayed(boolean grayed)
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;- 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
-
getGrayed
public boolean getGrayed()
Returnstrueif the receiver is grayed, and false otherwise. When the parent does not have theCHECKstyle, return false.- Returns:
- the grayed state of the checkbox
- 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
-
getBounds
public Rectangle getBounds()
Returns a rectangle describing the receiver's size and location relative to its parent.- Returns:
- the receiver's bounding rectangle
- 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
-
getBounds
public Rectangle getBounds(int index)
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
- 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
-
getImageBounds
public Rectangle getImageBounds(int index)
Returns a rectangle describing the size and location relative to its parent of an image at a column in the table. An empty rectangle is returned if index exceeds the index of the table's last column.- Parameters:
index- the index that specifies the column- Returns:
- the receiver's bounding image rectangle
- 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
-
getImageIndent
public int getImageIndent()
Gets the image indent.- Returns:
- the indent
- 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
-
getTextBounds
public Rectangle getTextBounds(int index)
Returns a rectangle describing the size and location relative to its parent of the text at a column in the table. An empty rectangle is returned if index exceeds the index of the table's last column.- Parameters:
index- the index that specifies the column- Returns:
- the receiver's bounding text rectangle
- 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
-
-