|
 |
|
|
org.eclipse.swt.widgets
Class TabItem
java.lang.Object
org.eclipse.swt.widgets.Widget
org.eclipse.swt.widgets.Item
org.eclipse.swt.widgets.TabItem
-
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.
-
See Also:
-
TabFolder, TabItem snippets,
Sample code and further information
-
Restriction:
- This class is not intended to be subclassed by clients.
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
|
protected void
|
checkSubclass
()
Checks that this class can be subclassed. |
Rectangle
|
getBounds
()
Returns a rectangle describing the receiver's size and location
relative to its parent. |
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
|
setText
(
String string)
Sets the receiver's text. |
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.
Widget
|
addDisposeListener,
addListener,
checkWidget,
dispose,
getData,
getData,
getDisplay,
getListeners,
getStyle,
isDisposed,
isListening,
notifyListeners,
removeDisposeListener,
removeListener,
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()
checkSubclass
protected void checkSubclass()
-
Description copied from class:
Widget
- Checks that this class can be subclassed.
The SWT class library is intended to be subclassed
only at specific, controlled points (most notably,
Composite and Canvas when
implementing new widgets). This method enforces this
rule unless it is overridden.
IMPORTANT: By providing an implementation of this
method that allows a subclass of a class which does not
normally allow subclassing to be created, the implementer
agrees to be fully responsible for the fact that any such
subclass will likely fail between SWT releases and will be
strongly platform specific. No support is provided for
user-written classes which are implemented in this fashion.
The ability to subclass outside of the allowed SWT classes
is intended purely to enable those not on the SWT development
team to implement patches in order to get around specific
limitations in advance of when those limitations can be
addressed by the team. Subclassing should not be attempted
without an intimate and detailed understanding of the hierarchy.
-
-
Overrides:
-
checkSubclass
in class
Item
-
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
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
-
Since:
- 3.4
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
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
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)
setText
public void setText(
String string)
- Sets the receiver's text. The string may include
the mnemonic character.
Mnemonics are indicated by an '&' that causes the next
character to be the mnemonic. When the user presses a
key sequence that matches the mnemonic, a selection
event occurs. On most platforms, the mnemonic appears
underlined but may be emphasised in a platform specific
manner. The mnemonic indicator character '&' can be
escaped by doubling it in the string, causing a single
'&' to be displayed.
-
-
Overrides:
-
setText
in class
Item
-
-
Parameters:
-
string - the new text
-
Throws:
-
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
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
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.
|
|
|