Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> eclipse >> swt >> [ widgets overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.eclipse.swt.widgets
Class TabFolder  

java.lang.Object
  org.eclipse.swt.widgets.Widget
      org.eclipse.swt.widgets.Control
          org.eclipse.swt.widgets.Scrollable
              org.eclipse.swt.widgets.Composite
                  org.eclipse.swt.widgets.TabFolder

All Implemented Interfaces:

org.eclipse.swt.graphics.Drawable

---

public class TabFolder

extends Composite

Instances of this class implement the notebook user interface metaphor. It allows the user to select a notebook page from set of pages.

The item children that may be added to instances of this class must be of type TabItem. Control children are created and then set into a tab item using TabItem#setControl.

Note that although this class is a subclass of Composite, it does not make sense to set a layout on it.

Styles:

TOP, BOTTOM

Events:

Selection

Note: Only one of the styles TOP and BOTTOM may be specified.

IMPORTANT: This class is not intended to be subclassed.

---

Field Summary
(package private)  TabItem[]	items

 

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

embeddedHandle, imHandle, layout, socketHandle, tabList

 

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

horizontalBar, scrolledHandle, verticalBar

 

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

accessible, cursor, drawCount, enableWindow, fixedHandle, font, layoutData, menu, parent, redrawWindow, toolTipText

 

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

ACTIVATE, BUTTON_PRESS_EVENT, BUTTON_RELEASE_EVENT, CANVAS, CHANGED, CLICKED, COMMIT, CONFIGURE_EVENT, data, DEFAULT_HEIGHT, DEFAULT_WIDTH, DELETE_EVENT, DELETE_RANGE, DELETE_TEXT, DISABLED, display, DISPOSED, ENTER_NOTIFY_EVENT, EVENT, EVENT_AFTER, eventTable, EXPOSE_EVENT, FOCUS, FOCUS_IN_EVENT, FOCUS_OUT_EVENT, handle, HANDLE, HIDE, INSERT_TEXT, KEY_PRESS_EVENT, KEY_RELEASE_EVENT, KEYED_DATA, LEAVE_NOTIFY_EVENT, MAP_EVENT, MENU, MNEMONIC_ACTIVATE, MOTION_NOTIFY_EVENT, OBSCURED, POPUP_MENU, PREEDIT_CHANGED, REALIZE, ROW_ACTIVATED, SCROLL_CHILD, SELECT, SHOW, SHOW_HELP, SIZE_ALLOCATE, state, style, STYLE_SET, SWITCH_PAGE, TEST_COLLAPSE_ROW, TEST_EXPAND_ROW, TOGGLED, UNMAP_EVENT, UNREALIZE, VALUE_CHANGED, VISIBILITY_NOTIFY_EVENT, WINDOW_STATE_EVENT

 

Constructor Summary

TabFolder(Composite parent, int style)           Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

 

Method Summary
void	addSelectionListener(org.eclipse.swt.events.SelectionListener listener)           Adds the listener to the collection of listeners who will be notified when the receiver's selection changes, by sending it one of the messages defined in the SelectionListener interface.
(package private) static int	checkStyle(int style)
(package private)  long	clientHandle()
org.eclipse.swt.graphics.Point	computeSize(int wHint, int hHint, boolean changed)           Returns the preferred size of the receiver.
org.eclipse.swt.graphics.Rectangle	computeTrim(int x, int y, int width, int height)           Given a desired client area for the receiver (as described by the arguments), returns the bounding rectangle which would be required to produce that client area.
(package private)  void	createHandle(int index)
(package private)  void	createItem(TabItem item, int index)
(package private)  void	createWidget(int index)
(package private)  void	destroyItem(TabItem item)
(package private)  long	eventHandle()
(package private)  void	fixPage()
TabItem	getItem(int index)           Returns the item at the given, zero-relative index in the receiver.
int	getItemCount()           Returns the number of items contained in the receiver.
TabItem[]	getItems()           Returns an array of TabItems which are the items in the receiver.
TabItem[]	getSelection()           Returns an array of TabItems that are currently selected in the receiver.
int	getSelectionIndex()           Returns the zero-relative index of the item which is currently selected in the receiver, or -1 if no item is selected.
(package private)  long	gtk_focus(long widget, long directionType)
(package private)  long	gtk_switch_page(long widget, long page, long page_num)
(package private)  void	hookEvents()
int	indexOf(TabItem item)           Searches the receiver's list starting at the first item (index 0) until an item is found that is equal to the argument, and returns the index of that item.
(package private)  org.eclipse.swt.graphics.Point	minimumSize(int wHint, int hHint, boolean flushCache)
(package private)  boolean	mnemonicHit(char key)
(package private)  boolean	mnemonicMatch(char key)
(package private)  void	releaseWidget()
(package private)  void	removeControl(Control control)
void	removeSelectionListener(org.eclipse.swt.events.SelectionListener listener)           Removes the listener from the collection of listeners who will be notified when the receiver's selection changes.
(package private)  boolean	setBounds(int x, int y, int width, int height, boolean move, boolean resize)
(package private)  void	setFontDescription(long font)
(package private)  void	setForegroundColor(org.eclipse.swt.internal.gtk.GdkColor color)
void	setSelection(int index)           Selects the item at the given zero-relative index in the receiver.
(package private)  void	setSelection(int index, boolean notify)
void	setSelection(TabItem[] items)           Sets the receiver's selection to be the given array of items.
(package private)  boolean	traversePage(boolean next)

 

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

_getChildren, _getTabList, checkSubclass, computeTabList, createHandle, deregister, enableWidget, findMenus, fixChildren, fixTabList, focusHandle, forceFocus, getChildren, getChildrenCount, getLayout, getTabList, gtk_button_press_event, gtk_expose_event, gtk_focus_in_event, gtk_focus_out_event, gtk_key_press_event, gtk_realize, gtk_scroll_child, gtk_style_set, hasBorder, hooksKeys, imHandle, isTabGroup, layout, layout, minimumSize, moveAbove, moveBelow, parentingHandle, register, releaseChildren, resizeHandle, setFocus, setLayout, setTabGroupFocus, setTabItemFocus, setTabList, translateMnemonic, translateTraversal, traversalCode

 

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

createScrollBar, getBorderWidth, getClientArea, getHorizontalBar, getVerticalBar, hScrollBarWidth, releaseHandle, setOrientation, topHandle, vScrollBarWidth

 

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

_getShell, addControlListener, addFocusListener, addHelpListener, addKeyListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addPaintListener, addTraverseListener, computeNativeSize, computeSize, computeTabGroup, computeTabRoot, defaultFont, drawGripper, filterKey, fixFocus, fontHandle, forceFocus, getAccessible, getBackground, getBackgroundColor, getBaseColor, getBgColor, getBounds, getEnabled, getFgColor, getFont, getFontDescription, getForeground, getForegroundColor, getIMCaretPos, getLayoutData, getLocation, getMenu, getMonitor, getParent, getPath, getShell, getSize, getTextColor, getToolTipText, getVisible, gtk_button_release_event, gtk_commit, gtk_enter_notify_event, gtk_event_after, gtk_key_release_event, gtk_leave_notify_event, gtk_mnemonic_activate, gtk_motion_notify_event, gtk_popup_menu, gtk_preedit_changed, gtk_show_help, gtk_unrealize, gtk_visibility_notify_event, hasFocus, hoverProc, internal_dispose_GC, internal_new_GC, isEnabled, isFocusAncestor, isFocusControl, isReparentable, isShowing, isTabItem, isVisible, menuShell, moveAbove, moveBelow, moveHandle, pack, pack, paintHandle, paintWindow, redraw, redraw, redrawWidget, releaseChild, removeControlListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removePaintListener, removeTraverseListener, sendFocusEvent, sendHelpEvent, sendIMKeyEvent, sendKeyEvent, sendMouseEvent, setBackground, setBackgroundColor, setBackgroundColor, setBounds, setBounds, setCapture, setCursor, setCursor, setEnabled, setFont, setForeground, setInitialSize, setLayoutData, setLocation, setLocation, setMenu, setParent, setRadioSelection, setRedraw, setSize, setSize, setToolTipText, setVisible, setZOrder, setZOrder, showMenu, sort, toControl, toControl, toDisplay, toDisplay, translateMnemonic, traverse, traverse, traverseEscape, traverseGroup, traverseItem, traverseMnemonic, traverseReturn, update, update

 

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

addDisposeListener, addListener, checkBits, checkOrientation, checkParent, checkWidget, destroyWidget, dispose, error, filterProc, filters, fixMnemonic, fontHeight, getData, getData, getDisplay, getName, getNameText, getStyle, gtk_activate, gtk_changed, gtk_clicked, gtk_configure_event, gtk_delete_event, gtk_delete_range, gtk_delete_text, gtk_event, gtk_hide, gtk_insert_text, gtk_map_event, gtk_row_activated, gtk_select, gtk_show, gtk_size_allocate, gtk_test_collapse_row, gtk_test_expand_row, gtk_timer, gtk_toggled, gtk_unmap_event, gtk_value_changed, gtk_window_state_event, hooks, isDisposed, isListening, isValidSubclass, isValidThread, isValidWidget, menuPositionProc, mnemonicHit, mnemonicMatch, notifyListeners, pixbufCellDataProc, postEvent, postEvent, releaseResources, removeDisposeListener, removeListener, removeListener, sendEvent, sendEvent, sendEvent, sendEvent, setData, setData, setInputState, setKeyState, shellMapProc, textCellDataProc, timerProc, toString, translateTraversal, treeSelectionProc, windowProc, windowProc, windowProc, windowProc

 

Methods inherited from class java.lang.Object

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

 

Field Detail

items

TabItem[] items

Constructor Detail

TabFolder

public TabFolder(Composite parent,
                 int style)

Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

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.

Method Detail

checkStyle

static int checkStyle(int style)

---

addSelectionListener

public void addSelectionListener(org.eclipse.swt.events.SelectionListener listener)

Adds the listener to the collection of listeners who will be notified when the receiver's selection changes, by sending it one of the messages defined in the SelectionListener interface.

When widgetSelected is called, the item field of the event object is valid. widgetDefaultSelected is not called.

---

clientHandle

long clientHandle()

Overrides:

clientHandle in class Scrollable

---

computeSize

public org.eclipse.swt.graphics.Point computeSize(int wHint,
                                                  int hHint,
                                                  boolean changed)

Description copied from class: Control

Returns the preferred size of the receiver.

The preferred size of a control is the size that it would best be displayed at. The width hint and height hint arguments allow the caller to ask a control questions such as "Given a particular width, how high does the control need to be to show all of the contents?" To indicate that the caller does not wish to constrain a particular dimension, the constant SWT.DEFAULT is passed for the hint.

If the changed flag is true, it indicates that the receiver's contents have changed, therefore any caches that a layout manager containing the control may have been keeping need to be flushed. When the control is resized, the changed flag will be false, so layout manager caches can be retained.

Overrides:

computeSize in class Composite

---

computeTrim

public org.eclipse.swt.graphics.Rectangle computeTrim(int x,
                                                      int y,
                                                      int width,
                                                      int height)

Description copied from class: Scrollable

Given a desired client area for the receiver (as described by the arguments), returns the bounding rectangle which would be required to produce that client area.

In other words, it returns a rectangle such that, if the receiver's bounds were set to that rectangle, the area of the receiver which is capable of displaying data (that is, not covered by the "trimmings") would be the rectangle described by the arguments (relative to the receiver's parent).

Overrides:

computeTrim in class Scrollable

---

createHandle

void createHandle(int index)

Overrides:

createHandle in class Composite

---

createWidget

void createWidget(int index)

Overrides:

createWidget in class Scrollable

---

createItem

void createItem(TabItem item,
                int index)

---

fixPage

void fixPage()

---

destroyItem

void destroyItem(TabItem item)

---

eventHandle

long eventHandle()

Overrides:

eventHandle in class Control

---

getItem

public TabItem getItem(int index)

Returns the item at the given, zero-relative index in the receiver. Throws an exception if the index is out of range.

---

getItemCount

public int getItemCount()

Returns the number of items contained in the receiver.

---

getItems

public TabItem[] getItems()

Returns an array of TabItems which are the items in the receiver.

Note: This is not the actual structure used by the receiver to maintain its list of items, so modifying the array will not affect the receiver.

---

getSelection

public TabItem[] getSelection()

Returns an array of TabItems that are currently selected in the receiver. An empty array indicates that no items are selected.

Note: This is not the actual structure used by the receiver to maintain its selection, so modifying the array will not affect the receiver.

---

getSelectionIndex

public int getSelectionIndex()

Returns the zero-relative index of the item which is currently selected in the receiver, or -1 if no item is selected.

---

gtk_focus

long gtk_focus(long widget,
               long directionType)

Overrides:

gtk_focus in class Composite

---

gtk_switch_page

long gtk_switch_page(long widget,
                     long page,
                     long page_num)

Overrides:

gtk_switch_page in class Widget

---

hookEvents

void hookEvents()

Overrides:

hookEvents in class Composite

---

indexOf

public int indexOf(TabItem item)

Searches the receiver's list starting at the first item (index 0) until an item is found that is equal to the argument, and returns the index of that item. If no item is found, returns -1.

---

minimumSize

org.eclipse.swt.graphics.Point minimumSize(int wHint,
                                           int hHint,
                                           boolean flushCache)

---

mnemonicHit

boolean mnemonicHit(char key)

Overrides:

mnemonicHit in class Control

---

mnemonicMatch

boolean mnemonicMatch(char key)

Overrides:

mnemonicMatch in class Control

---

releaseWidget

void releaseWidget()

Overrides:

releaseWidget in class Composite

---

removeControl

void removeControl(Control control)

Overrides:

removeControl in class Composite

---

removeSelectionListener

public void removeSelectionListener(org.eclipse.swt.events.SelectionListener listener)

Removes the listener from the collection of listeners who will be notified when the receiver's selection changes.

---

setBounds

boolean setBounds(int x,
                  int y,
                  int width,
                  int height,
                  boolean move,
                  boolean resize)

Overrides:

setBounds in class Composite

---

setFontDescription

void setFontDescription(long font)

Overrides:

setFontDescription in class Control

---

setForegroundColor

void setForegroundColor(org.eclipse.swt.internal.gtk.GdkColor color)

Overrides:

setForegroundColor in class Control

---

setSelection

public void setSelection(int index)

Selects the item at the given zero-relative index in the receiver. If the item at the index was already selected, it remains selected. The current selection is first cleared, then the new items are selected. Indices that are out of range are ignored.

---

setSelection

void setSelection(int index,
                  boolean notify)

---

setSelection

public void setSelection(TabItem[] items)

Sets the receiver's selection to be the given array of items. The current selected is first cleared, then the new items are selected.

---

traversePage

boolean traversePage(boolean next)

Overrides:

traversePage in class Control

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> eclipse >> swt >> [ widgets overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---