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

Safe: 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.

Field Summary

(package private) Control	control
(package private) TabFolder	parent
(package private) String	toolTipText

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

image, text

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

CANVAS, COMCTL32_MAJOR, COMCTL32_MINOR, data, DEFAULT_HEIGHT, DEFAULT_WIDTH, DISABLED, DISPOSED, eventTable, HIDDEN, keys, MAJOR, MINOR, Mnemonic, state, style, values

Constructor Summary

TabItem(TabFolder parent, int style)
Enabled: 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)
Enabled: 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.
Control	getControl() Enabled: Returns the control that is used to fill the client area of the tab folder when the user selects the tab item.
Display	getDisplay() Suppressed:
TabFolder	getParent() Suppressed: Returns the receiver's parent, which must be a TabFolder.
String	getToolTipText() Enabled: Returns the receiver's tool tip text, or null if it has not been set.
(package private) void	releaseChild()
(package private) void	releaseWidget()
void	setControl(Control control) Enabled: 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) Enabled:
void	setText(String string) Enabled: Sets the receiver's text.
void	setToolTipText(String string) Enabled: 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.Item

getImage, getNameText, getText

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

addDisposeListener, addListener, checkBits, checkOrientation, checkParent, checkWidget, destroyWidget, dispose, error, filters, getData, getData, getName, getStyle, hooks, isDisposed, isListening, isValidSubclass, isValidThread, mbcsToWcs, mbcsToWcs, notifyListeners, postEvent, postEvent, releaseHandle, releaseResources, removeDisposeListener, removeListener, removeListener, sendEvent, sendEvent, sendEvent, sendEvent, setData, setData, setInputState, setKeyState, toString, wcsToMbcs, wcsToMbcs

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

parent

TabFolder parent

control

Control control

toolTipText

String toolTipText

Constructor Detail

TabItem

public TabItem(TabFolder parent,
               int style)

Enabled: 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

See Also:

SWT, Widget.checkSubclass(), Widget.getStyle()

TabItem

public TabItem(TabFolder parent,
               int style,
               int index)

Enabled: 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 index to store the receiver in its parent

See Also:

SWT, Widget.checkSubclass(), Widget.getStyle()

Method Detail

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()

Enabled: 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

getDisplay

public Display getDisplay()

Suppressed:

Specified by:

getDisplay in class Widget

Returns:

the receiver's display

getParent

public TabFolder getParent()

Suppressed: Returns the receiver's parent, which must be a TabFolder.

Returns:

the receiver's parent

getToolTipText

public String getToolTipText()

Enabled: Returns the receiver's tool tip text, or null if it has not been set.

Returns:

the receiver's tool tip text

releaseChild

void releaseChild()

Overrides:

releaseChild in class Widget

releaseWidget

void releaseWidget()

Overrides:

releaseWidget in class Item

setControl

public void setControl(Control control)

Enabled: 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)

setImage

public void setImage(Image image)

Enabled:

Overrides:

setImage in class Item

Parameters:

image - the image to display on the receiver (may be null)

setText

public void setText(String string)

Enabled: 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

setToolTipText

public void setToolTipText(String string)

Enabled: Sets the receiver's tool tip text to the argument, which may be null indicating that no tool tip text should be shown.

Parameters:

string - the new tool tip text (or null)