/******************************************************************************* * Copyright (c) 2000, 2012 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ package org.eclipse.swt.widgets; import org.eclipse.swt.*; import org.eclipse.swt.internal.cairo.*; import org.eclipse.swt.internal.gtk.*; import org.eclipse.swt.graphics.*; /** * 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, DOUBLE_BUFFERED
*
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. *

* Note: The CENTER style, although undefined for composites, has the * same value as EMBEDDED which is used to embed widgets from other * widget toolkits into SWT. On some operating systems (GTK, Motif), this may cause * the children of this composite to be obscured. *

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

* * @see Canvas * @see Composite snippets * @see Sample code and further information */ public class Composite extends Scrollable { public int /*long*/ embeddedHandle; int /*long*/ imHandle, socketHandle; Layout layout; Control[] tabList; int layoutCount, backgroundMode; static final String NO_INPUT_METHOD = "org.eclipse.swt.internal.gtk.noInputMethod"; //$NON-NLS-1$ Composite () { /* Do nothing */ } /** * 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. *

* * @param parent a widget which will be the parent of the new instance (cannot be null) * @param style the style of widget to construct * * @exception IllegalArgumentException * @exception SWTException * * @see SWT#NO_BACKGROUND * @see SWT#NO_FOCUS * @see SWT#NO_MERGE_PAINTS * @see SWT#NO_REDRAW_RESIZE * @see SWT#NO_RADIO_GROUP * @see SWT#EMBEDDED * @see SWT#DOUBLE_BUFFERED * @see Widget#getStyle */ public Composite (Composite parent, int style) { super (parent, checkStyle (style)); } static int checkStyle (int style) { if (OS.INIT_CAIRO) { style &= ~SWT.NO_BACKGROUND; } style &= ~SWT.TRANSPARENT; return style; } Control [] _getChildren () { int /*long*/ parentHandle = parentingHandle (); int /*long*/ list = OS.gtk_container_get_children (parentHandle); if (list == 0) return new Control [0]; int count = OS.g_list_length (list); Control [] children = new Control [count]; int i = 0; int /*long*/ temp = list; while (temp != 0) { int /*long*/ handle = OS.g_list_data (temp); if (handle != 0) { Widget widget = display.getWidget (handle); if (widget != null && widget != this) { if (widget instanceof Control) { children [i++] = (Control) widget; } } } temp = OS.g_list_next (temp); } OS.g_list_free (list); if (i == count) return children; Control [] newChildren = new Control [i]; System.arraycopy (children, 0, newChildren, 0, i); return newChildren; } Control [] _getTabList () { if (tabList == null) return tabList; int count = 0; for (int i=0; i *
  • ERROR_INVALID_ARGUMENT - if the changed array is null any of its controls are null or have been disposed
  • *
  • ERROR_INVALID_PARENT - if any control in changed is not in the widget tree of the receiver
  • * * @exception SWTException * * @since 3.1 */ public void changed (Control[] changed) { checkWidget (); if (changed == null) error (SWT.ERROR_INVALID_ARGUMENT); for (int i=0; iThe offsetX and offsetY are used to map from * the gc origin to the origin of the parent image background. This is useful * to ensure proper alignment of the image background.

    * * @param gc the gc where the rectangle is to be filled * @param x the x coordinate of the rectangle to be filled * @param y the y coordinate of the rectangle to be filled * @param width the width of the rectangle to be filled * @param height the height of the rectangle to be filled * @param offsetX the image background x offset * @param offsetY the image background y offset * * @exception IllegalArgumentException * @exception SWTException * * @since 3.6 */ public void drawBackground (GC gc, int x, int y, int width, int height, int offsetX, int offsetY) { checkWidget (); if (gc == null) error (SWT.ERROR_NULL_ARGUMENT); if (gc.isDisposed ()) error (SWT.ERROR_INVALID_ARGUMENT); Control control = findBackgroundControl (); if (control != null) { GCData data = gc.getGCData (); int /*long*/ cairo = data.cairo; if (cairo != 0) { Cairo.cairo_save (cairo); if (control.backgroundImage != null) { Point pt = display.map (this, control, 0, 0); Cairo.cairo_translate (cairo, -pt.x - offsetX, -pt.y - offsetY); x += pt.x + offsetX; y += pt.y + offsetY; int /*long*/ surface = control.backgroundImage.surface; if (surface == 0) { int /*long*/ xDisplay = OS.gdk_x11_display_get_xdisplay(OS.gdk_display_get_default()); int /*long*/ xVisual = OS.gdk_x11_visual_get_xvisual (OS.gdk_visual_get_system()); int /*long*/ drawable = control.backgroundImage.pixmap; int /*long*/ xDrawable = OS.GDK_PIXMAP_XID (drawable); int [] w = new int [1], h = new int [1]; gdk_pixmap_get_size (drawable, w, h); surface = Cairo.cairo_xlib_surface_create (xDisplay, xDrawable, xVisual, w [0], h [0]); if (surface == 0) error (SWT.ERROR_NO_HANDLES); } else { Cairo.cairo_surface_reference(surface); } int /*long*/ pattern = Cairo.cairo_pattern_create_for_surface (surface); if (pattern == 0) error (SWT.ERROR_NO_HANDLES); Cairo.cairo_pattern_set_extend (pattern, Cairo.CAIRO_EXTEND_REPEAT); if ((data.style & SWT.MIRRORED) != 0) { double[] matrix = {-1, 0, 0, 1, 0, 0}; Cairo.cairo_pattern_set_matrix(pattern, matrix); } Cairo.cairo_set_source (cairo, pattern); Cairo.cairo_surface_destroy (surface); Cairo.cairo_pattern_destroy (pattern); } else { GdkColor color = control.getBackgroundColor (); Cairo.cairo_set_source_rgba (cairo, (color.red & 0xFFFF) / (float)0xFFFF, (color.green & 0xFFFF) / (float)0xFFFF, (color.blue & 0xFFFF) / (float)0xFFFF, data.alpha / (float)0xFF); } Cairo.cairo_rectangle (cairo, x, y, width, height); Cairo.cairo_fill (cairo); Cairo.cairo_restore (cairo); } else { int /*long*/ gdkGC = gc.handle; GdkGCValues values = new GdkGCValues (); OS.gdk_gc_get_values (gdkGC, values); if (control.backgroundImage != null) { Point pt = display.map (this, control, 0, 0); OS.gdk_gc_set_fill (gdkGC, OS.GDK_TILED); OS.gdk_gc_set_ts_origin (gdkGC, -pt.x - offsetX, -pt.y - offsetY); OS.gdk_gc_set_tile (gdkGC, control.backgroundImage.pixmap); OS.gdk_draw_rectangle (data.drawable, gdkGC, 1, x, y, width, height); OS.gdk_gc_set_fill (gdkGC, values.fill); OS.gdk_gc_set_ts_origin (gdkGC, values.ts_x_origin, values.ts_y_origin); } else { GdkColor color = control.getBackgroundColor (); OS.gdk_gc_set_foreground (gdkGC, color); OS.gdk_draw_rectangle (data.drawable, gdkGC, 1, x, y, width, height); color.pixel = values.foreground_pixel; OS.gdk_gc_set_foreground (gdkGC, color); } } } else { gc.fillRectangle (x, y, width, height); } } void enableWidget (boolean enabled) { if ((state & CANVAS) != 0) return; super.enableWidget (enabled); } Composite findDeferredControl () { return layoutCount > 0 ? this : parent.findDeferredControl (); } Menu [] findMenus (Control control) { if (control == this) return new Menu [0]; Menu result [] = super.findMenus (control); Control [] children = _getChildren (); for (int i=0; iSWT: * INHERIT_NONE, INHERIT_DEFAULT, * INHERTIT_FORCE. * * @return the background mode * * @exception SWTException
      *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
    • *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
    • *
    * * @see SWT * * @since 3.2 */ public int getBackgroundMode () { checkWidget (); return backgroundMode; } /** * Returns a (possibly empty) array containing the receiver's children. * Children are returned in the order that they are drawn. The topmost * control appears at the beginning of the array. Subsequent controls * draw beneath this control and appear later in the array. *

    * 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. *

    * * @return an array of children * * @see Control#moveAbove * @see Control#moveBelow * * @exception SWTException
      *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
    • *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
    • *
    */ public Control [] getChildren () { checkWidget(); return _getChildren (); } int getChildrenCount () { /* * NOTE: The current implementation will count * non-registered children. */ int /*long*/ list = OS.gtk_container_get_children (handle); if (list == 0) return 0; int count = OS.g_list_length (list); OS.g_list_free (list); return count; } public Rectangle getClientArea () { checkWidget(); if ((state & CANVAS) != 0) { if ((state & ZERO_WIDTH) != 0 && (state & ZERO_HEIGHT) != 0) { return new Rectangle (0, 0, 0, 0); } forceResize (); int /*long*/ clientHandle = clientHandle (); GtkAllocation allocation = new GtkAllocation(); gtk_widget_get_allocation (clientHandle, allocation); int width = (state & ZERO_WIDTH) != 0 ? 0 : allocation.width; int height = (state & ZERO_HEIGHT) != 0 ? 0 : allocation.height; return new Rectangle (0, 0, width, height); } return super.getClientArea(); } int getClientWidth() { if ((state & ZERO_WIDTH) != 0) return 0; GtkAllocation allocation = new GtkAllocation(); gtk_widget_get_allocation(clientHandle (), allocation); return allocation.width; } /** * Returns layout which is associated with the receiver, or * null if one has not been set. * * @return the receiver's layout or null * * @exception SWTException
      *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
    • *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
    • *
    */ public Layout getLayout () { checkWidget(); return layout; } /** * Returns true if the receiver has deferred * the performing of layout, and false otherwise. * * @return the receiver's deferred layout state * * @exception SWTException
      *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
    • *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
    • *
    * * @see #setLayoutDeferred(boolean) * @see #isLayoutDeferred() * * @since 3.1 */ public boolean getLayoutDeferred () { checkWidget (); return layoutCount > 0 ; } /** * Gets the (possibly empty) tabbing order for the control. * * @return tabList the ordered list of controls representing the tab order * * @exception SWTException
      *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
    • *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
    • *
    * * @see #setTabList */ public Control [] getTabList () { checkWidget (); Control [] tabList = _getTabList (); if (tabList == null) { int count = 0; Control [] list =_getChildren (); for (int i=0; itrue if the receiver or any ancestor * up to and including the receiver's nearest ancestor shell * has deferred the performing of layouts. Otherwise, false * is returned. * * @return the receiver's deferred layout state * * @exception SWTException
      *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
    • *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
    • *
    * * @see #setLayoutDeferred(boolean) * @see #getLayoutDeferred() * * @since 3.1 */ public boolean isLayoutDeferred () { checkWidget (); return findDeferredControl () != null; } boolean isTabGroup() { if ((state & CANVAS) != 0) return true; return super.isTabGroup(); } /** * 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). *

    *

    * Note: Layout is different from painting. If a child is * moved or resized such that an area in the parent is * exposed, then the parent will paint. If no child is * affected, the parent will not paint. *

    * * @exception SWTException
      *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
    • *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
    • *
    */ public void layout () { checkWidget (); layout (true); } /** * 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 argument is true the layout must not rely * on any information it has cached about the immediate children. If it * is false the layout may (potentially) optimize the * work it is doing by assuming that none of the receiver's * children has changed state since the last layout. * If the receiver does not have a layout, do nothing. *

    * If a child is resized as a result of a call to layout, the * resize event will invoke the layout of the child. The layout * will cascade down through all child widgets in the receiver's widget * tree until a child is encountered that does not resize. Note that * a layout due to a resize will not flush any cached information * (same as layout(false)). *

    *

    * Note: Layout is different from painting. If a child is * moved or resized such that an area in the parent is * exposed, then the parent will paint. If no child is * affected, the parent will not paint. *

    * * @param changed true if the layout must flush its caches, and false otherwise * * @exception SWTException
      *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
    • *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
    • *
    */ public void layout (boolean changed) { checkWidget (); if (layout == null) return; layout (changed, false); } /** * 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 changed argument is true the layout must not rely * on any information it has cached about its children. If it * is false the layout may (potentially) optimize the * work it is doing by assuming that none of the receiver's * children has changed state since the last layout. * If the all argument is true the layout will cascade down * through all child widgets in the receiver's widget tree, regardless of * whether the child has changed size. The changed argument is applied to * all layouts. If the all argument is false, the layout will * not cascade down through all child widgets in the receiver's widget * tree. However, if a child is resized as a result of a call to layout, the * resize event will invoke the layout of the child. Note that * a layout due to a resize will not flush any cached information * (same as layout(false)). *

    *

    * Note: Layout is different from painting. If a child is * moved or resized such that an area in the parent is * exposed, then the parent will paint. If no child is * affected, the parent will not paint. *

    * * @param changed true if the layout must flush its caches, and false otherwise * @param all true if all children in the receiver's widget tree should be laid out, and false otherwise * * @exception 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.1 */ public void layout (boolean changed, boolean all) { checkWidget (); if (layout == null && !all) return; markLayout (changed, all); updateLayout (all); } /** * Forces a lay out (that is, sets the size and location) of all widgets that * are in the parent hierarchy of the changed control up to and including the * receiver. The layouts in the hierarchy must not rely on any information * cached about the changed control or any of its ancestors. The layout may * (potentially) optimize the work it is doing by assuming that none of the * peers of the changed control have changed state since the last layout. * If an ancestor does not have a layout, skip it. *

    * Note: Layout is different from painting. If a child is * moved or resized such that an area in the parent is * exposed, then the parent will paint. If no child is * affected, the parent will not paint. *

    * * @param changed a control that has had a state change which requires a recalculation of its size * * @exception IllegalArgumentException
      *
    • ERROR_INVALID_ARGUMENT - if the changed array is null any of its controls are null or have been disposed
    • *
    • ERROR_INVALID_PARENT - if any control in changed is not in the widget tree of the receiver
    • *
    * @exception 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.1 */ public void layout (Control [] changed) { checkWidget (); if (changed == null) error (SWT.ERROR_INVALID_ARGUMENT); layout (changed, SWT.NONE); } /** * Forces a lay out (that is, sets the size and location) of all widgets that * are in the parent hierarchy of the changed control up to and including the * receiver. *

    * The parameter flags may be a combination of: *

    *
    SWT.ALL
    *
    all children in the receiver's widget tree should be laid out
    *
    SWT.CHANGED
    *
    the layout must flush its caches
    *
    SWT.DEFER
    *
    layout will be deferred
    *
    *

    *

    * When the changed array is specified, the flags SWT.ALL * and SWT.CHANGED have no effect. In this case, the layouts in the * hierarchy must not rely on any information cached about the changed control or * any of its ancestors. The layout may (potentially) optimize the * work it is doing by assuming that none of the peers of the changed * control have changed state since the last layout. * If an ancestor does not have a layout, skip it. *

    *

    * When the changed array is not specified, the flag SWT.ALL * indicates that the whole widget tree should be laid out. And the flag * SWT.CHANGED indicates that the layouts should flush any cached * information for all controls that are laid out. *

    *

    * The SWT.DEFER flag always causes the layout to be deferred by * calling Composite.setLayoutDeferred(true) and scheduling a call * to Composite.setLayoutDeferred(false), which will happen when * appropriate (usually before the next event is handled). When this flag is set, * the application should not call Composite.setLayoutDeferred(boolean). *

    *

    * Note: Layout is different from painting. If a child is * moved or resized such that an area in the parent is * exposed, then the parent will paint. If no child is * affected, the parent will not paint. *

    * * @param changed a control that has had a state change which requires a recalculation of its size * @param flags the flags specifying how the layout should happen * * @exception IllegalArgumentException
      *
    • ERROR_INVALID_ARGUMENT - if any of the controls in changed is null or has been disposed
    • *
    • ERROR_INVALID_PARENT - if any control in changed is not in the widget tree of the receiver
    • *
    * @exception 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.6 */ public void layout (Control [] changed, int flags) { checkWidget (); if (changed != null) { for (int i=0; i=0; i--) { update [i].updateLayout (false); } } else { if (layout == null && (flags & SWT.ALL) == 0) return; markLayout ((flags & SWT.CHANGED) != 0, (flags & SWT.ALL) != 0); if ((flags & SWT.DEFER) != 0) { setLayoutDeferred (true); display.addLayoutDeferred (this); } updateLayout ((flags & SWT.ALL) != 0); } } void markLayout (boolean changed, boolean all) { if (layout != null) { state |= LAYOUT_NEEDED; if (changed) state |= LAYOUT_CHANGED; } if (all) { Control [] children = _getChildren (); for (int i=0; i 0) x = oldWidth - controlWidth - x; int clientWidth = getClientWidth (); x = clientWidth - controlWidth - x; if (child.enableWindow != 0) { OS.gdk_window_move (child.enableWindow, x, y); } child.moveHandle (x, y); /* * Cause a size allocation this widget's topHandle. Note that * all calls to gtk_widget_size_allocate() must be preceded by * a call to gtk_widget_size_request(). */ GtkRequisition requisition = new GtkRequisition (); gtk_widget_size_request (topHandle, requisition); allocation.x = x; allocation.y = y; OS.gtk_widget_size_allocate (topHandle, allocation); Control control = child.findBackgroundControl (); if (control != null && control.backgroundImage != null) { if (child.isVisible ()) child.redrawWidget (0, 0, 0, 0, true, true, true); } } } Point minimumSize (int wHint, int hHint, boolean changed) { Control [] children = _getChildren (); Rectangle clientArea = getClientArea (); int width = 0, height = 0; for (int i=0; i=0; --i) { Control child = children [i]; if (child.getVisible ()) { Point location = child.getLocation (); child.printWidget (gc, drawable, depth, x + location.x, y + location.y); } } gc.setClipping (oldClip); oldClip.dispose (); newClip.dispose (); } void redrawChildren () { super.redrawChildren (); Control [] children = _getChildren (); for (int i = 0; i < children.length; i++) { Control child = children [i]; if ((child.state & PARENT_BACKGROUND) != 0) { child.redrawWidget (0, 0, 0, 0, true, false, true); child.redrawChildren (); } } } void register () { super.register (); if (socketHandle != 0) display.addWidget (socketHandle, this); } void releaseChildren (boolean destroy) { Control [] children = _getChildren (); for (int i=0; iSWT: * INHERIT_NONE, INHERIT_DEFAULT, * INHERIT_FORCE. * * @param mode the new background mode * * @exception SWTException
      *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
    • *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
    • *
    * * @see SWT * * @since 3.2 */ public void setBackgroundMode (int mode) { checkWidget (); backgroundMode = mode; Control[] children = _getChildren (); for (int i = 0; i < children.length; i++) { children [i].updateBackgroundMode (); } } int setBounds (int x, int y, int width, int height, boolean move, boolean resize) { int result = super.setBounds (x, y, width, height, move, resize); if ((result & RESIZED) != 0 && layout != null) { markLayout (false, false); updateLayout (false); } return result; } public boolean setFocus () { checkWidget(); Control [] children = _getChildren (); for (int i=0; i *
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • *
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
  • * */ public void setLayout (Layout layout) { checkWidget(); this.layout = layout; } /** * If the argument is true, causes subsequent layout * operations in the receiver or any of its children to be ignored. * No layout of any kind can occur in the receiver or any of its * children until the flag is set to false. * Layout operations that occurred while the flag was * true are remembered and when the flag is set to * false, the layout operations are performed in an * optimized manner. Nested calls to this method are stacked. * * @param defer the new defer state * * @exception SWTException
      *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
    • *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
    • *
    * * @see #layout(boolean) * @see #layout(Control[]) * * @since 3.1 */ public void setLayoutDeferred (boolean defer) { checkWidget(); if (!defer) { if (--layoutCount == 0) { if ((state & LAYOUT_CHILD) != 0 || (state & LAYOUT_NEEDED) != 0) { updateLayout (true); } } } else { layoutCount++; } } void setOrientation (boolean create) { super.setOrientation (create); if (!create) { int flags = SWT.RIGHT_TO_LEFT | SWT.LEFT_TO_RIGHT; int orientation = style & flags; Control [] children = _getChildren (); for (int i=0; i *
  • ERROR_INVALID_ARGUMENT - if a widget in the tabList is null or has been disposed
  • *
  • ERROR_INVALID_PARENT - if widget in the tabList is not in the same widget tree
  • * * @exception SWTException
      *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
    • *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
    • *
    */ public void setTabList (Control [] tabList) { checkWidget (); if (tabList != null) { for (int i=0; i