Class TableItem

  • All Implemented Interfaces:
    Adaptable

    public class TableItem
    extends Item
    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.

    Since:
    1.0
    • Constructor Summary

      Constructors 
      Constructor Description
      TableItem​(Table parent, int style)
      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)
      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

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      <T> T getAdapter​(java.lang.Class<T> adapter)
      Implementation of the Adaptable interface.
      Color getBackground()
      Returns the receiver's background color.
      Color getBackground​(int index)
      Returns the background color at the given column index in the receiver.
      Rectangle getBounds()
      Returns a rectangle describing the receiver's size and location relative to its parent.
      Rectangle getBounds​(int index)
      Returns a rectangle describing the receiver's size and location relative to its parent at a column in the table.
      boolean getChecked()
      Returns true if the receiver is checked, and false otherwise.
      Font getFont()
      Returns the font that the receiver will use to paint textual information for this item.
      Font getFont​(int index)
      Returns the font that the receiver will use to paint textual information for the specified cell in this item.
      Color getForeground()
      Returns the foreground color that the receiver will use to draw.
      Color getForeground​(int index)
      Returns the foreground color at the given column index in the receiver.
      boolean getGrayed()
      Returns true if the receiver is grayed, and false otherwise.
      Image getImage()
      Returns the receiver's image if it has one, or null if it does not.
      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.
      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.
      int getImageIndent()
      Gets the image indent.
      Table getParent()
      Returns the receiver's parent, which must be a Table.
      java.lang.String getText()
      Returns the receiver's text, which will be an empty string if it has never been set.
      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.
      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.
      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.
      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.
      void setChecked​(boolean checked)
      Sets the checked state of the checkbox for this item.
      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.
      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.
      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.
      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.
      void setGrayed​(boolean grayed)
      Sets the grayed state of the checkbox for this item.
      void setImage​(int index, Image image)
      Sets the receiver's image at a column.
      void setImage​(Image image)
      Sets the receiver's image to the argument, which may be null indicating that no image should be displayed.
      void setImage​(Image[] images)
      Sets the image for multiple columns in the table.
      void setText​(int index, java.lang.String text)
      Sets the receiver's text at a column
      void setText​(java.lang.String text)
      Sets the receiver's text.
      void setText​(java.lang.String[] strings)
      Sets the text for multiple columns in the table.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • TableItem

        public TableItem​(Table parent,
                         int style)
        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
        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 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 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: Widget
        Implementation of the Adaptable interface.

        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:
        getAdapter in interface Adaptable
        Overrides:
        getAdapter in class Widget
        Parameters:
        adapter - the lookup class
        Returns:
        an object that can be cast to the given class or null if there is no adapter associated with the given class.
      • getParent

        public Table getParent()
        Returns the receiver's parent, which must be a Table.
        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: Item
        Sets the receiver's text.
        Overrides:
        setText in class Item
        Parameters:
        text - the new text
      • setText

        public void setText​(int index,
                            java.lang.String text)
        Sets the receiver's text at a column
        Parameters:
        index - the column index
        text - 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: Item
        Returns the receiver's text, which will be an empty string if it has never been set.
        Overrides:
        getText in class Item
        Returns:
        the receiver's text
      • 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: Item
        Sets the receiver's image to the argument, which may be null indicating that no image should be displayed.
        Overrides:
        setImage in class Item
        Parameters:
        image - the image to display on the receiver (may be null)
      • setImage

        public void setImage​(int index,
                             Image image)
        Sets the receiver's image at a column.
        Parameters:
        index - the column index
        image - 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: Item
        Returns the receiver's image if it has one, or null if it does not.
        Overrides:
        getImage in class Item
        Returns:
        the receiver's image
      • 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 index
        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​(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 index
        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​(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 index
        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​(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()
        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
        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()
        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
        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