Class CTabItem
- 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
ConstructorDescriptionCTabItem
(CTabFolder parent, int style) Constructs a new instance of this class given its parent (which must be aCTabFolder
) 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 aCTabFolder
), 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 TypeMethodDescriptionvoid
dispose()
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 usedgetFont()
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 aCTabFolder
.Returns the selection foreground color that the receiver will use to paint textual information.boolean
Returnstrue
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
Returnstrue
if the item will be rendered in the visible area of the CTabFolder.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.void
setDisabledImage
(Image image) Deprecated.This image is not usedvoid
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
(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.void
Sets the receiver's image to the argument, which may be null indicating that no image should be displayed.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.void
setShowClose
(boolean close) Sets totrue
to indicate that the receiver's close button should be shown.void
Sets the text to display on the tab.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.Methods inherited from class org.eclipse.swt.widgets.Item
checkSubclass, getImage, getText
Methods inherited from class org.eclipse.swt.widgets.Widget
addDisposeListener, addListener, addTypedListener, checkWidget, getData, getData, getDisplay, getListeners, getStyle, getTypedListeners, isAutoDirection, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, removeTypedListener, reskin, setData, setData, toString
-
Constructor Details
-
CTabItem
Constructs a new instance of this class given its parent (which must be aCTabFolder
) 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 theint
"|" operator) two or more of thoseSWT
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
Constructs a new instance of this class given its parent (which must be aCTabFolder
), 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 theint
"|" operator) two or more of thoseSWT
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 constructindex
- 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 answertrue
when sent the messageisDisposed()
. 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. -
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
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.the disabled image is not usedGet 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
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
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
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
Returns the receiver's parent, which must be aCTabFolder
.- 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()Returnstrue
to indicate that the receiver's close button should be shown. Otherwise returnfalse
. 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
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()Returnstrue
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
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.This image is not usedSets 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
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
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
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
Description copied from class:Item
Sets the receiver's image to the argument, which may be null indicating that no image should be displayed. -
setShowClose
public void setShowClose(boolean close) Sets totrue
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
Sets the text to display on the tab. A carriage return '\n' allows to display multi line text.- Overrides:
setText
in classItem
- 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
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
-