blob: 85b5077ba793890b196db71d917c6dacc0abb280 [file] [log] [blame]
package org.eclipse.swt.widgets;
/*
* (c) Copyright IBM Corp. 2000, 2001.
* All Rights Reserved
*/
import org.eclipse.swt.*;
import org.eclipse.swt.internal.*;
import org.eclipse.swt.internal.gtk.*;
import org.eclipse.swt.graphics.*;
/**
* Instances of this class are controls which are capable
* of containing other controls.
* <dl>
* <dt><b>Styles:</b></dt>
* <dd>NO_BACKGROUND, NO_FOCUS, NO_MERGE_PAINTS, NO_REDRAW_RESIZE</dd>
* <dt><b>Events:</b></dt>
* <dd>(none)</dd>
* </dl>
* <p>
* This class may be subclassed by custom control implementors
* who are building controls that are constructed from aggregates
* of other controls.
* </p>
*
* @see Canvas
*/
public class Composite extends Scrollable {
int topHandle, eventBoxHandle, fixedHandle, radioHandle;
Layout layout;
/*
* === CONSTRUCTORS ===
*/
Composite () {
/* Do nothing */
}
/**
* Constructs a new instance of this class given its parent
* and a style value describing its behavior and appearance.
* <p>
* The style value is either one of the style constants defined in
* class <code>SWT</code> which is applicable to instances of this
* class, or must be built by <em>bitwise OR</em>'ing together
* (that is, using the <code>int</code> "|" operator) two or more
* of those <code>SWT</code> style constants. The class description
* for all SWT widget classes should include a comment which
* describes the style constants which are applicable to the class.
* </p>
*
* @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 <ul>
* <li>ERROR_NULL_ARGUMENT - if the parent is null</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li>
* <li>ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass</li>
* </ul>
*
* @see SWT
* @see Widget#checkSubclass
* @see Widget#getStyle
*/
public Composite (Composite parent, int style) {
super (parent, style);
}
void createHandle (int index) {
state |= HANDLE;
topHandle = OS.gtk_event_box_new();
if (topHandle == 0) SWT.error (SWT.ERROR_NO_HANDLES);
scrolledHandle = OS.gtk_scrolled_window_new(0,0);
if (scrolledHandle == 0) error (SWT.ERROR_NO_HANDLES);
eventBoxHandle = OS.gtk_event_box_new();
if (eventBoxHandle == 0) SWT.error (SWT.ERROR_NO_HANDLES);
fixedHandle = OS.gtk_fixed_new ();
if (fixedHandle == 0) SWT.error (SWT.ERROR_NO_HANDLES);
handle = OS.gtk_drawing_area_new();
if (handle == 0) SWT.error (SWT.ERROR_NO_HANDLES);
OS.GTK_WIDGET_SET_FLAGS(handle, OS.GTK_CAN_FOCUS);
}
void configure() {
_connectParent();
OS.gtk_container_add(topHandle, scrolledHandle);
_fillBin(scrolledHandle, eventBoxHandle);
OS.gtk_container_add(eventBoxHandle, fixedHandle);
OS.gtk_fixed_put(fixedHandle, handle, (short)0,(short)0);
}
void setHandleStyle() {
setScrollingPolicy();
}
void showHandle() {
OS.gtk_widget_realize (topHandle);
OS.gtk_widget_show_now(topHandle);
OS.gtk_widget_show (scrolledHandle);
OS.gtk_widget_realize (eventBoxHandle);
OS.gtk_widget_show_now(eventBoxHandle);
OS.gtk_widget_realize (fixedHandle);
OS.gtk_widget_show_now(fixedHandle);
OS.gtk_widget_realize (handle);
OS.gtk_widget_show_now (handle);
}
void register () {
super.register ();
if (topHandle != 0) WidgetTable.put (topHandle, this);
if (eventBoxHandle != 0) WidgetTable.put (eventBoxHandle, this);
if (fixedHandle != 0) WidgetTable.put (fixedHandle, this);
}
void deregister () {
super.deregister ();
if (topHandle != 0) WidgetTable.remove (topHandle);
if (eventBoxHandle != 0) WidgetTable.remove (eventBoxHandle);
if (fixedHandle != 0) WidgetTable.remove (fixedHandle);
}
int topHandle() {
return topHandle;
}
int parentingHandle() {
return fixedHandle;
}
/**
* Answer whether the argument points to an OS widget that is
* implementing the receiver, i.e., one of my own handles
*/
boolean isMyHandle(int h) {
if (h==topHandle) return true;
if (h==eventBoxHandle) return true;
if (h==scrolledHandle) return true;
if (h==fixedHandle) return true;
if (h==handle) return true;
if (h==radioHandle) return true;
return false;
}
/*
* === GEOMETRY - PHYSICAL ===
*/
public void setBounds (int x, int y, int width, int height) {
super.setBounds (x, y, width, height);
layout();
}
public void setSize (int width, int height) {
super.setSize(width, height);
layout();
}
boolean _setSize(int width, int height) {
boolean differentExtent = UtilFuncs.setSize (topHandle(), width,height);
Point clientSize = UtilFuncs.getSize(fixedHandle);
OS.gtk_drawing_area_size(handle, width, height);
UtilFuncs.setSize (handle, clientSize.x, clientSize.y);
return differentExtent;
}
public Point computeSize (int wHint, int hHint, boolean changed) {
checkWidget ();
Point size;
if (layout != null) {
if (wHint == SWT.DEFAULT || hHint == SWT.DEFAULT) {
size = layout.computeSize (this, wHint, hHint, changed);
} else {
size = new Point (wHint, hHint);
}
} else {
size = minimumSize ();
}
if (size.x == 0) size.x = DEFAULT_WIDTH;
if (size.y == 0) size.y = DEFAULT_HEIGHT;
if (wHint != SWT.DEFAULT) size.x = wHint;
if (hHint != SWT.DEFAULT) size.y = hHint;
Rectangle trim = computeTrim (0, 0, size.x, size.y);
return new Point (trim.width, trim.height);
}
void initializeTrim() {
/* Temporary implementation - I just measured the scrollbars
* with one particular theme. The fair thing to do is get
* the real dimensions from gtk.
*/
trim = new Trim();
if ((style&SWT.H_SCROLL)!=0) trim.bottom=18;
if ((style&SWT.V_SCROLL)!=0) trim.right=18;
}
/*
* === GEOMETRY - LAYOUT ===
*/
/**
* 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 <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public Layout getLayout () {
checkWidget();
return layout;
}
/**
* Gets the last specified tabbing order for the control.
*
* @return tabList the ordered list of controls representing the tab order
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @see #setTabList
*/
public Control [] getTabList () {
return new Control [0];
}
/**
* Sets the layout which is associated with the receiver to be
* the argument which may be null.
*
* @param layout the receiver's new layout or null
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public void setLayout (Layout layout) {
if (!isValidThread ()) error (SWT.ERROR_THREAD_INVALID_ACCESS);
if (!isValidWidget ()) error (SWT.ERROR_WIDGET_DISPOSED);
this.layout = layout;
}
int _gdkWindow() {
int windowHandle = _gdkWindow(handle);
if (windowHandle==0) error(SWT.ERROR_UNSPECIFIED);
return windowHandle;
}
/**
* Returns an array containing the receiver's children.
* <p>
* 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.
* </p>
*
* @return an array of children
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public Control [] getChildren () {
checkWidget();
return _getChildren();
}
Control [] _getChildren () {
return _getChildren(parentingHandle());
}
/**
* Answer the array of the children of the specified handle,
* filtering out widgets we don't consider our children.
* That is, the OS may return some children that don't qualify
* as such under SWT terminology - e.g., Items are not children.
*/
Control [] _getChildren (int h) {
if (h==0) {
error(SWT.ERROR_UNSPECIFIED);
}
int list = OS.gtk_container_children (h);
int count = OS.g_list_length (list);
java.util.Vector children = new java.util.Vector();
for (int i=0; i<count; i++) {
int data = OS.g_list_nth_data (list, i);
if (!isMyHandle(data)) {
Control child = _childFromHandle(data);
if (child != null) children.addElement(child);
}
}
Control[] answer = new Control[children.size()];
children.copyInto(answer);
return answer;
}
/**
* Consider the argument a handle of one of the receiver's children.
* If the argument is not a handle to a widget, or the widget is
* not our child in SWT (not OS) terminology, return null.
*/
Control _childFromHandle(int h) {
Widget child = WidgetTable.get(h);
return (Control)child;
}
public Rectangle getClientArea () {
if (!isValidThread ()) error (SWT.ERROR_THREAD_INVALID_ACCESS);
if (!isValidWidget ()) error (SWT.ERROR_WIDGET_DISPOSED);
return _getClientArea ();
}
public Rectangle _getClientArea () {
Point size = _getClientAreaSize ();
return new Rectangle (0, 0, size.x, size.y);
}
Point _getClientAreaSize () {
return UtilFuncs.getSize(handle);
}
/**
* If the receiver has a layout, asks the layout to <em>lay out</em>
* (that is, set the size and location of) the receiver's children.
* If the receiver does not have a layout, do nothing.
* <p>
* This is equivalent to calling <code>layout(true)</code>.
* </p>
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public void layout () {
layout (true);
}
/**
* If the receiver has a layout, asks the layout to <em>lay out</em>
* (that is, set the size and location of) the receiver's children.
* If the the argument is <code>true</code> the layout must not rely
* on any cached information it is keeping about the children. If it
* is <code>false</code> 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.
*
* @param changed <code>true</code> if the layout must flush its caches, and <code>false</code> otherwise
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public void layout (boolean changed) {
if (!isValidThread ()) error (SWT.ERROR_THREAD_INVALID_ACCESS);
if (!isValidWidget ()) error (SWT.ERROR_WIDGET_DISPOSED);
if (layout == null) return;
layout.layout (this, changed);
}
Point minimumSize () {
Control [] children = _getChildren ();
int width = 0, height = 0;
for (int i=0; i<children.length; i++) {
Rectangle rect = children [i].getBounds ();
width = Math.max (width, rect.x + rect.width);
height = Math.max (height, rect.y + rect.height);
}
return new Point (width, height);
}
int processResize (int int0, int int1, int int2) {
sendEvent (SWT.Resize);
layout();
return 0;
}
int radioGroup() {
if (radioHandle==0) _initializeRadioGroup();
return OS.gtk_radio_button_group(radioHandle);
}
public void redraw () {
if (!isValidThread ()) error (SWT.ERROR_THREAD_INVALID_ACCESS);
if (!isValidWidget ()) error (SWT.ERROR_WIDGET_DISPOSED);
// Point size = _getSize();
// GtkWidget widget = new GtkWidget(handle);
// _redraw(0, 0, size.x, size.y, true);
OS.gtk_widget_queue_draw(handle);
}
void _initializeRadioGroup() {
radioHandle = OS.gtk_radio_button_new(0);
}
/**
* Adopt the widget h as our child.
*/
void _connectChild (int h) {
OS.gtk_fixed_put (parentingHandle(), h, (short)0, (short)0);
}
void releaseChildren () {
Control [] children = _getChildren ();
for (int i=0; i<children.length; i++) {
Control child = children [i];
if (child != null && !child.isDisposed ()) {
child.releaseWidget ();
child.releaseHandle ();
}
}
}
void releaseWidget () {
releaseChildren ();
super.releaseWidget ();
layout = null;
}
void releaseHandle () {
super.releaseHandle ();
topHandle = eventBoxHandle = fixedHandle = radioHandle = 0;
}
int processFocusIn(int int0, int int1, int int2) {
OS.GTK_WIDGET_SET_FLAGS(handle, OS.GTK_HAS_FOCUS);
return super.processFocusIn(int0, int1, int2);
}
int processFocusOut(int int0, int int1, int int2) {
OS.GTK_WIDGET_UNSET_FLAGS(handle, OS.GTK_HAS_FOCUS);
return super.processFocusOut(int0, int1, int2);
}
public boolean setFocus () {
if (!isValidThread ()) error (SWT.ERROR_THREAD_INVALID_ACCESS);
if (!isValidWidget ()) error (SWT.ERROR_WIDGET_DISPOSED);
Control [] children = _getChildren ();
for (int i=0; i<children.length; i++) {
Control child = children [i];
if (child.getVisible () && child.setFocus ()) return true;
}
return super.setFocus ();
}
/**
* Sets the tabbing order for the specified controls to
* match the order that they occur in the argument list.
*
* @param tabList the ordered list of controls representing the tab order; must not be null
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the tabList is null</li>
* <li>ERROR_INVALID_ARGUMENT - if a widget in the tabList is null or has been disposed</li>
* <li>ERROR_INVALID_PARENT - if widget in the tabList is not in the same widget tree</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public void setTabList (Control [] tabList) {
}
}