|
|
|
|
org.eclipse.swt.widgets
Class TabItem
java.lang.Object
org.eclipse.swt.widgets.Widget
org.eclipse.swt.widgets.Item
org.eclipse.swt.widgets.TabItem
-
All Implemented Interfaces:
-
Adaptable
- public class TabItem
- extends
Item
Instances of this class represent a selectable user interface object
corresponding to a tab for a page in a tab folder.
-
Styles:
- (none)
-
Events:
- (none)
IMPORTANT: This class is not intended to be subclassed.
Constructor Summary
|
TabItem
(
TabFolder parent,
int style)
Constructs a new instance of this class given its parent
(which must be a TabFolder ) and a style value
describing its behavior and appearance. |
TabItem
(
TabFolder parent,
int style,
int index)
Constructs a new instance of this class given its parent
(which must be a TabFolder ), 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
|
Control
|
getControl
()
Returns the control that is used to fill the client area of
the tab folder when the user selects the tab item. |
TabFolder
|
getParent
()
Returns the receiver's parent, which must be a TabFolder . |
String
|
getToolTipText
()
Returns the receiver's tool tip text, or null if it has
not been set. |
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
|
setImage
(
Image image)
Sets the receiver's image to the argument, which may be
null indicating that no image should be displayed. |
void
|
setToolTipText
(
String toolTip)
Sets the receiver's tool tip text to the argument, which
may be null indicating that no tool tip text should be shown. |
Methods inherited from class org.eclipse.swt.widgets.
Widget
|
addDisposeListener,
addListener,
checkSubclass,
checkWidget,
dispose,
getAdapter,
getData,
getData,
getDisplay,
getStyle,
isDisposed,
notifyListeners,
removeDisposeListener,
removeListener,
setData,
setData,
toString
|
TabItem
public TabItem(
TabFolder parent,
int style)
- Constructs a new instance of this class given its parent
(which must be a
TabFolder ) 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:
-
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()
TabItem
public TabItem(
TabFolder parent,
int style,
int index)
- Constructs a new instance of this class given its parent
(which must be a
TabFolder ), 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:
-
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()
getParent
public
TabFolder getParent()
- Returns the receiver's parent, which must be a
TabFolder .
-
-
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
getControl
public
Control getControl()
- Returns the control that is used to fill the client area of
the tab folder when the user selects the tab item. If no
control has been set, return
null .
-
-
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
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
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)
setToolTipText
public void setToolTipText(
String toolTip)
- Sets the receiver's tool tip text to the argument, which
may be null indicating that no tool tip text 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:
- 1.2
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
-
Since:
- 1.2
Copyright (c) Innoopract Informationssysteme GmbH and others 2002, 2008. All rights reserved.
|
|
|