|
Eclipse Remote Application Platform | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.eclipse.swt.widgets.Widget org.eclipse.swt.widgets.Item org.eclipse.swt.custom.CTabItem
public class CTabItem
Instances of this class represent a selectable user interface object that represent a page in a notebook widget.
IMPORTANT: This class is not intended to be subclassed.
Constructor Summary | |
---|---|
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 | ||
---|---|---|
void |
dispose()
Disposes of the operating system resources associated with the receiver and all its descendents. |
|
|
getAdapter(java.lang.Class<T> adapter)
Implementation of the Adaptable interface. |
|
Rectangle |
getBounds()
Returns a rectangle describing the receiver's size and location relative to its parent. |
|
Control |
getControl()
Gets the control that is displayed in the content area of the tab item. |
|
Font |
getFont()
Returns the font that the receiver will use to paint textual information. |
|
CTabFolder |
getParent()
Returns the receiver's parent, which must be a CTabFolder . |
|
boolean |
getShowClose()
Returns true to indicate that the receiver's close button should be shown. |
|
java.lang.String |
getToolTipText()
Returns the receiver's tool tip text, or null if it has not been set. |
|
boolean |
isShowing()
Returns true 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 |
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 |
setImage(Image image)
Sets the receiver's image to the argument, which may be null indicating that no image should be displayed. |
|
void |
setShowClose(boolean close)
Sets to true to indicate that the receiver's close button should be shown. |
|
void |
setText(java.lang.String text)
Sets the receiver's text. |
|
void |
setToolTipText(java.lang.String toolTipText)
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, getText |
Methods inherited from class org.eclipse.swt.widgets.Widget |
---|
addDisposeListener, addListener, checkSubclass, checkWidget, getData, getData, getDisplay, getListeners, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, reskin, setData, setData, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public CTabItem(CTabFolder parent, int style)
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.
parent
- a CTabFolder which will be the parent of the new instance (cannot be null)style
- the style of control to construct
java.lang.IllegalArgumentException
- SWTException
- SWT
,
Widget.getStyle()
public CTabItem(CTabFolder parent, int style, int index)
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.
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
java.lang.IllegalArgumentException
- SWTException
- SWT
,
Widget.getStyle()
Method Detail |
---|
public <T> T getAdapter(java.lang.Class<T> adapter)
Widget
Adaptable
interface.
IMPORTANT: This method is not part of the RWT public API. It is marked public only so that it can be shared within the packages provided by RWT. It should never be accessed from application code.
getAdapter
in interface Adaptable
getAdapter
in class Widget
adapter
- the lookup class
null
if
there is no adapter associated with the given class.public CTabFolder getParent()
CTabFolder
.
SWTException
- public void setText(java.lang.String text)
Item
setText
in class Item
text
- the new textpublic void setImage(Image image)
Item
setImage
in class Item
image
- the image to display on the receiver (may be null)public void setFont(Font font)
Changing font works, but tab size is not adjusted accordingly.
font
- the new font (or null)
java.lang.IllegalArgumentException
- SWTException
- public Font getFont()
SWTException
- public Control getControl()
SWTException
- public void setControl(Control control)
control
- the new control (or null)
java.lang.IllegalArgumentException
- SWTException
- public void setToolTipText(java.lang.String toolTipText)
toolTipText
- the new tool tip text (or null)
SWTException
- public java.lang.String getToolTipText()
SWTException
- public void setShowClose(boolean close)
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.
close
- the new state of the close button
SWTException
- public boolean getShowClose()
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.
true
if the close button should be shown
SWTException
- public boolean isShowing()
true
if the item will be rendered in the visible area of the CTabFolder. Returns false otherwise.
true
if the item will be rendered in the visible area of the CTabFolder. Returns false otherwise.
SWTException
- public Rectangle getBounds()
SWTException
- public void dispose()
Widget
true
when sent the message isDisposed()
.
Any internal connections between the widgets in the tree will
have been removed to facilitate garbage collection.
NOTE: This method is not called recursively on the descendents
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.
dispose
in class Widget
Widget.addDisposeListener(org.eclipse.swt.events.DisposeListener)
,
Widget.removeDisposeListener(org.eclipse.swt.events.DisposeListener)
,
Widget.checkWidget()
|
Eclipse Remote Application Platform | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright (c) EclipseSource and others 2002, 2013. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0