Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> org >> eclipse >> swt >> [ widgets overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of org.eclipse.swt.widgets.Composite JAVADOC | Sourc code of org.eclipse.swt.widgets.Composite SOURCE | Download org.eclipse.swt.widgets.Composite DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.eclipse.swt.widgets
Class Composite  view Composite download Composite.java

java.lang.Object
  extended byorg.eclipse.swt.widgets.Widget
      extended byorg.eclipse.swt.widgets.Control
          extended byorg.eclipse.swt.widgets.Scrollable
              extended byorg.eclipse.swt.widgets.Composite
All Implemented Interfaces:
org.eclipse.swt.graphics.Drawable
Direct Known Subclasses:
Canvas, ColorProgressBar, Combo, CoolBar, Group, IconBar, TabFolder, Table, ToolBar, Tree
public class Composite
extends Scrollable

Instances of this class are controls which are capable of containing other controls.

Styles:
NO_BACKGROUND, NO_FOCUS, NO_MERGE_PAINTS, NO_REDRAW_RESIZE, NO_RADIO_GROUP, EMBEDDED
Events:
(none)

Note: The NO_BACKGROUND, NO_FOCUS, NO_MERGE_PAINTS, and NO_REDRAW_RESIZE styles are intended for use with Canvas. They can be used with Composite if you are drawing your own, but their behavior is undefined if they are used with subclasses of Composite other than Canvas.

This class may be subclassed by custom control implementors who are building controls that are constructed from aggregates of other controls.

Field Summary
 long embeddedHandle
           
(package private)  long imHandle
           
(package private)  Layout layout
           
(package private)  long socketHandle
           
(package private)  Control[] 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
(package private) Composite()
           
  Composite(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
(package private)  Control[] _getChildren()
           
(package private)  Control[] _getTabList()
           
protected  void checkSubclass()
          Checks that this class can be subclassed.
 org.eclipse.swt.graphics.Point computeSize(int wHint, int hHint, boolean changed)
          Returns the preferred size of the receiver.
(package private)  Control[] computeTabList()
           
(package private)  void createHandle(int index)
           
(package private)  void createHandle(int index, long parentHandle, boolean scrolled)
           
(package private)  void deregister()
           
(package private)  void enableWidget(boolean enabled)
           
(package private)  Menu[] findMenus(Control control)
           
(package private)  void fixChildren(Shell newShell, Shell oldShell, Decorations newDecorations, Decorations oldDecorations, Menu[] menus)
           
(package private)  void fixTabList(Control control)
           
(package private)  long focusHandle()
           
(package private)  boolean forceFocus(long focusHandle)
           
 Control[] getChildren()
          Returns an array containing the receiver's children.
(package private)  int getChildrenCount()
           
 Layout getLayout()
          Returns layout which is associated with the receiver, or null if one has not been set.
 Control[] getTabList()
          Gets the last specified tabbing order for the control.
(package private)  long gtk_button_press_event(long widget, long event)
           
(package private)  long gtk_expose_event(long widget, long eventPtr)
           
(package private)  long gtk_focus_in_event(long widget, long event)
           
(package private)  long gtk_focus_out_event(long widget, long event)
           
(package private)  long gtk_focus(long widget, long directionType)
           
(package private)  long gtk_key_press_event(long widget, long event)
           
(package private)  long gtk_realize(long widget)
           
(package private)  long gtk_scroll_child(long widget, long scrollType, long horizontal)
           
(package private)  long gtk_style_set(long widget, long previousStyle)
           
(package private)  boolean hasBorder()
           
(package private)  void hookEvents()
           
(package private)  boolean hooksKeys()
           
(package private)  long imHandle()
           
(package private)  boolean isTabGroup()
           
 void layout()
          If the receiver has a layout, asks the layout to lay out (that is, set the size and location of) the receiver's children.
 void layout(boolean changed)
          If the receiver has a layout, asks the layout to lay out (that is, set the size and location of) the receiver's children.
(package private)  org.eclipse.swt.graphics.Point minimumSize()
           
(package private)  void moveAbove(long child, long sibling)
           
(package private)  void moveBelow(long child, long sibling)
           
(package private)  long parentingHandle()
           
(package private)  void register()
           
(package private)  void releaseChildren()
           
(package private)  void releaseWidget()
           
(package private)  void removeControl(Control control)
           
(package private)  void resizeHandle(int width, int height)
           
(package private)  boolean setBounds(int x, int y, int width, int height, boolean move, boolean resize)
           
 boolean setFocus()
          Causes the receiver to have the keyboard focus, such that all keyboard events will be delivered to it.
 void setLayout(Layout layout)
          Sets the layout which is associated with the receiver to be the argument which may be null.
(package private)  boolean setTabGroupFocus(boolean next)
           
(package private)  boolean setTabItemFocus(boolean next)
           
 void setTabList(Control[] tabList)
          Sets the tabbing order for the specified controls to match the order that they occur in the argument list.
(package private)  boolean translateMnemonic(Event event, Control control)
           
(package private)  boolean translateTraversal(org.eclipse.swt.internal.gtk.GdkEventKey keyEvent)
           
(package private)  int traversalCode(int key, org.eclipse.swt.internal.gtk.GdkEventKey event)
           
 
Methods inherited from class org.eclipse.swt.widgets.Scrollable
clientHandle, computeTrim, createScrollBar, createWidget, 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, eventHandle, 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, mnemonicHit, mnemonicMatch, 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, setFontDescription, setForeground, setForegroundColor, 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, traversePage, 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_switch_page, 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

embeddedHandle

public long embeddedHandle

imHandle

long imHandle

socketHandle

long socketHandle

layout

Layout layout

tabList

Control[] tabList
Constructor Detail

Composite

Composite()

Composite

public Composite(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

_getChildren

Control[] _getChildren()

_getTabList

Control[] _getTabList()

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 Widget

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 Control

computeTabList

Control[] computeTabList()
Overrides:
computeTabList in class Control

createHandle

void createHandle(int index)
Overrides:
createHandle in class Widget

createHandle

void createHandle(int index,
                  long parentHandle,
                  boolean scrolled)

deregister

void deregister()
Overrides:
deregister in class Scrollable

enableWidget

void enableWidget(boolean enabled)
Overrides:
enableWidget in class Control

findMenus

Menu[] findMenus(Control control)
Overrides:
findMenus in class Control

fixChildren

void fixChildren(Shell newShell,
                 Shell oldShell,
                 Decorations newDecorations,
                 Decorations oldDecorations,
                 Menu[] menus)
Overrides:
fixChildren in class Control

fixTabList

void fixTabList(Control control)

focusHandle

long focusHandle()
Overrides:
focusHandle in class Control

forceFocus

boolean forceFocus(long focusHandle)
Overrides:
forceFocus in class Control

getChildren

public Control[] getChildren()
Returns an array containing the receiver's children.

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

getChildrenCount

int getChildrenCount()

getLayout

public Layout getLayout()
Returns layout which is associated with the receiver, or null if one has not been set.

getTabList

public Control[] getTabList()
Gets the last specified tabbing order for the control.

gtk_button_press_event

long gtk_button_press_event(long widget,
                            long event)
Overrides:
gtk_button_press_event in class Control

gtk_expose_event

long gtk_expose_event(long widget,
                      long eventPtr)
Overrides:
gtk_expose_event in class Control

gtk_key_press_event

long gtk_key_press_event(long widget,
                         long event)
Overrides:
gtk_key_press_event in class Control

gtk_focus

long gtk_focus(long widget,
               long directionType)
Overrides:
gtk_focus in class Control

gtk_focus_in_event

long gtk_focus_in_event(long widget,
                        long event)
Overrides:
gtk_focus_in_event in class Control

gtk_focus_out_event

long gtk_focus_out_event(long widget,
                         long event)
Overrides:
gtk_focus_out_event in class Control

gtk_realize

long gtk_realize(long widget)
Overrides:
gtk_realize in class Control

gtk_scroll_child

long gtk_scroll_child(long widget,
                      long scrollType,
                      long horizontal)
Overrides:
gtk_scroll_child in class Widget

gtk_style_set

long gtk_style_set(long widget,
                   long previousStyle)
Overrides:
gtk_style_set in class Widget

hasBorder

boolean hasBorder()

hookEvents

void hookEvents()
Overrides:
hookEvents in class Control

hooksKeys

boolean hooksKeys()

imHandle

long imHandle()
Overrides:
imHandle in class Control

isTabGroup

boolean isTabGroup()
Overrides:
isTabGroup in class Control

layout

public void layout()
If the receiver has a layout, asks the layout to lay out (that is, set the size and location of) the receiver's children. If the receiver does not have a layout, do nothing.

This is equivalent to calling layout(true).

layout

public void layout(boolean changed)
If the receiver has a layout, asks the layout to lay out (that is, set the size and location of) the receiver's children. If the the argument is true the layout must not rely on any cached information it is keeping about the children. If it is false the layout may (potentially) simplify the work it is doing by assuming that the state of the none of the receiver's children has changed since the last layout. If the receiver does not have a layout, do nothing.

moveAbove

void moveAbove(long child,
               long sibling)

moveBelow

void moveBelow(long child,
               long sibling)

minimumSize

org.eclipse.swt.graphics.Point minimumSize()

parentingHandle

long parentingHandle()

register

void register()
Overrides:
register in class Scrollable

releaseChildren

void releaseChildren()

releaseWidget

void releaseWidget()
Overrides:
releaseWidget in class Scrollable

removeControl

void removeControl(Control control)

resizeHandle

void resizeHandle(int width,
                  int height)
Overrides:
resizeHandle in class Scrollable

setBounds

boolean setBounds(int x,
                  int y,
                  int width,
                  int height,
                  boolean move,
                  boolean resize)
Overrides:
setBounds in class Control

setFocus

public boolean setFocus()
Description copied from class: Control
Causes the receiver to have the keyboard focus, such that all keyboard events will be delivered to it. Focus reassignment will respect applicable platform constraints.

Overrides:
setFocus in class Control

setLayout

public void setLayout(Layout layout)
Sets the layout which is associated with the receiver to be the argument which may be null.

setTabGroupFocus

boolean setTabGroupFocus(boolean next)
Overrides:
setTabGroupFocus in class Control

setTabItemFocus

boolean setTabItemFocus(boolean next)
Overrides:
setTabItemFocus in class Control

setTabList

public void setTabList(Control[] tabList)
Sets the tabbing order for the specified controls to match the order that they occur in the argument list.

translateMnemonic

boolean translateMnemonic(Event event,
                          Control control)
Overrides:
translateMnemonic in class Control

traversalCode

int traversalCode(int key,
                  org.eclipse.swt.internal.gtk.GdkEventKey event)
Overrides:
traversalCode in class Control

translateTraversal

boolean translateTraversal(org.eclipse.swt.internal.gtk.GdkEventKey keyEvent)
Overrides:
translateTraversal in class Control
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> org >> eclipse >> swt >> [ widgets overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of org.eclipse.swt.widgets.Composite JAVADOC | Sourc code of org.eclipse.swt.widgets.Composite SOURCE | Download org.eclipse.swt.widgets.Composite DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD