Class CTabItem


public class CTabItem extends Item
Instances of this class represent a selectable user interface object that represent a page in a notebook widget.
Styles:
SWT.CLOSE
Events:
(none)

IMPORTANT: This class is not intended to be subclassed.

See Also:
Restriction:
This class is not intended to be subclassed by clients.
  • Field Summary

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

    nativeZoom
  • Constructor Summary

    Constructors
    Constructor
    Description
    CTabItem(CTabFolder parent, int style)
    Constructs a new instance of this class given its parent (which must be a CTabFolder) and a style value describing its behavior and appearance.
    CTabItem(CTabFolder parent, int style, int index)
    Constructs a new instance of this class given its parent (which must be a CTabFolder), 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

    Modifier and Type
    Method
    Description
    void
    Disposes of the operating system resources associated with the receiver and all its descendants.
    Returns a rectangle describing the receiver's size and location relative to its parent.
    Gets the control that is displayed in the content area of the tab item.
    Deprecated.
    the disabled image is not used
    Returns the font that the receiver will use to paint textual information.
    Returns the foreground color that the receiver will use to paint textual information.
    Returns the receiver's parent, which must be a CTabFolder.
    Returns the selection foreground color that the receiver will use to paint textual information.
    boolean
    Returns true to indicate that the receiver's close button should be shown.
    Returns the receiver's tool tip text, or null if it has not been set.
    boolean
    Returns true if the item will be rendered in the visible area of the CTabFolder.
    void
    Sets the control that is used to fill the client area of the tab folder when the user selects the tab item.
    void
    Deprecated.
    This image is not used
    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
    Sets the foreground color that the receiver will use to paint textual information for this item to the color specified by the argument, or to the default foreground color for that kind of control if the argument is null.
    void
    setImage(Image image)
    Sets the receiver's image to the argument, which may be null indicating that no image should be displayed.
    void
    Sets the selection foreground color that the receiver will use to paint textual information for this item to the color specified by the argument, or to the default selection foreground color for that kind of control if the argument is null.
    void
    setShowClose(boolean close)
    Sets to true to indicate that the receiver's close button should be shown.
    void
    setText(String string)
    Sets the text to display on the tab.
    void
    Sets the receiver's tool tip text to the argument, which may be null indicating that the default tool tip for the control will be shown.

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

    checkSubclass, getImage, getText

    Methods inherited from class java.lang.Object

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

    • CTabItem

      public CTabItem(CTabFolder parent, int style)
      Constructs a new instance of this class given its parent (which must be a CTabFolder) 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 CTabFolder which will be the parent of the new instance (cannot be null)
      style - the style of control to construct
      Throws:
      IllegalArgumentException -
      • ERROR_NULL_ARGUMENT - if the parent is null
      SWTException -
      • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
      See Also:
    • CTabItem

      public CTabItem(CTabFolder parent, int style, int index)
      Constructs a new instance of this class given its parent (which must be a CTabFolder), 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 CTabFolder 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:
      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
      See Also:
  • Method Details

    • dispose

      public void dispose()
      Description copied from class: Widget
      Disposes of the operating system resources associated with the receiver and all its descendants. After this method has been invoked, the receiver and all descendants will answer true when sent the message isDisposed(). Any internal connections between the widgets in the tree will have been removed to facilitate garbage collection. This method does nothing if the widget is already disposed.

      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.

      Overrides:
      dispose in class Widget
      See Also:
    • getBounds

      public Rectangle getBounds()
      Returns a rectangle describing the receiver's size and location relative to its parent.
      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
    • getControl

      public Control getControl()
      Gets the control that is displayed in the content area of the tab item.
      Returns:
      the control
      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
    • getDisabledImage

      @Deprecated public Image getDisabledImage()
      Deprecated.
      the disabled image is not used
      Get the image displayed in the tab if the tab is disabled.
      Returns:
      the disabled image or null
      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
    • getForeground

      public Color getForeground()
      Returns the foreground color that the receiver will use to paint textual information.
      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
      Since:
      3.114
    • getSelectionForeground

      public Color getSelectionForeground()
      Returns the selection foreground color that the receiver will use to paint textual information.
      Returns:
      the receiver's selection 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
      Since:
      3.114
    • getFont

      public Font getFont()
      Returns the font that the receiver will use to paint textual information.
      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
      Since:
      3.0
    • getParent

      public CTabFolder getParent()
      Returns the receiver's parent, which must be a CTabFolder.
      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
    • getShowClose

      public boolean getShowClose()
      Returns true to indicate that the receiver's close button should be shown. Otherwise return false. The initial value is defined by the style (SWT.CLOSE) that was used to create the receiver.
      Returns:
      true if the close button should be shown
      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
      Since:
      3.4
    • getToolTipText

      public String getToolTipText()
      Returns the receiver's tool tip text, or null if it has not been set.
      Returns:
      the receiver's tool tip text
      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
    • isShowing

      public boolean isShowing()
      Returns true if the item will be rendered in the visible area of the CTabFolder. Returns false otherwise.
      Returns:
      true if the item will be rendered in the visible area of the CTabFolder. Returns false otherwise.
      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
      Since:
      3.0
    • setControl

      public void setControl(Control control)
      Sets the control that is used to fill the client area of the tab folder when the user selects the tab item.
      Parameters:
      control - the new control (or null)
      Throws:
      IllegalArgumentException -
      • ERROR_INVALID_ARGUMENT - if the control has been disposed
      • ERROR_INVALID_PARENT - if the control is not in the same widget tree
      SWTException -
      • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
    • setDisabledImage

      @Deprecated public void setDisabledImage(Image image)
      Deprecated.
      This image is not used
      Sets the image that is displayed if the tab item is disabled. Null will clear the image.
      Parameters:
      image - the image to be displayed when the item is disabled or null
      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:
      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
      Since:
      3.0
    • setForeground

      public void setForeground(Color color)
      Sets the foreground color that the receiver will use to paint textual information for this item to the color specified by the argument, or to the default foreground color for that kind of control if the argument is null.
      Parameters:
      color - the new color (or null)
      Throws:
      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
      Since:
      3.114
    • setSelectionForeground

      public void setSelectionForeground(Color color)
      Sets the selection foreground color that the receiver will use to paint textual information for this item to the color specified by the argument, or to the default selection foreground color for that kind of control if the argument is null.
      Parameters:
      color - the new color (or null)
      Throws:
      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
      Since:
      3.114
    • 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)
    • setShowClose

      public void setShowClose(boolean close)
      Sets to true to indicate that the receiver's close button should be shown. If the parent (CTabFolder) was created with SWT.CLOSE style, changing this value has no effect.
      Parameters:
      close - the new state of the close button
      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
      Since:
      3.4
    • setText

      public void setText(String string)
      Sets the text to display on the tab. A carriage return '\n' allows to display multi line text.
      Overrides:
      setText in class Item
      Parameters:
      string - the tab name
      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
    • setToolTipText

      public void setToolTipText(String string)
      Sets the receiver's tool tip text to the argument, which may be null indicating that the default tool tip for the control will be shown. For a control that has a default tool tip, such as the Tree control on Windows, setting the tool tip text to an empty string replaces the default, causing no tool tip text to be shown.

      The mnemonic indicator (character '&') is not displayed in a tool tip. To display a single '&' in the tool tip, the character '&' can be escaped by doubling it in the string.

      Parameters:
      string - the new tool tip text (or null)
      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