/*******************************************************************************
* Copyright (c) 2000, 2009 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.internal.*;
import org.eclipse.swt.internal.motif.*;
import org.eclipse.swt.graphics.*;
import org.eclipse.swt.*;
/**
* Instances of this class provide an etched border
* with an optional title.
* <p>
* Shadow styles are hints and may not be honoured
* by the platform. To create a group with the
* default shadow style for the platform, do not
* specify a shadow style.
* <dl>
* <dt><b>Styles:</b></dt>
* <dd>SHADOW_ETCHED_IN, SHADOW_ETCHED_OUT, SHADOW_IN, SHADOW_OUT, SHADOW_NONE</dd>
* <dt><b>Events:</b></dt>
* <dd>(none)</dd>
* </dl>
* <p>
* Note: Only one of the above styles may be specified.
* </p><p>
* IMPORTANT: This class is <em>not</em> intended to be subclassed.
* </p>
*
* @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a>
* @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
* @noextend This class is not intended to be subclassed by clients.
*/
public class Group extends Composite {
int labelHandle;
String text = "";
/**
* 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
* lists the style constants that are applicable to the class.
* Style bits are also inherited from superclasses.
* </p>
*
* @param parent a composite control which will be the parent of the new instance (cannot be null)
* @param style the style of control 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#SHADOW_ETCHED_IN
* @see SWT#SHADOW_ETCHED_OUT
* @see SWT#SHADOW_IN
* @see SWT#SHADOW_OUT
* @see SWT#SHADOW_NONE
* @see Widget#checkSubclass
* @see Widget#getStyle
*/
public Group (Composite parent, int style) {
super (parent, checkStyle (style));
}
static int checkStyle (int style) {
style |= SWT.NO_FOCUS;
/*
* Even though it is legal to create this widget
* with scroll bars, they serve no useful purpose
* because they do not automatically scroll the
* widget's client area. The fix is to clear
* the SWT style.
*/
return style & ~(SWT.H_SCROLL | SWT.V_SCROLL);
}
protected void checkSubclass () {
if (!isValidSubclass ()) error (SWT.ERROR_INVALID_SUBCLASS);
}
public Point computeSize (int wHint, int hHint, boolean changed) {
Point size = super.computeSize (wHint, hHint, changed);
if (OS.XtIsManaged (labelHandle)) {
int [] argList = {
OS.XmNshadowThickness, 0,
OS.XmNmarginWidth, 0,
};
OS.XtGetValues (handle, argList, argList.length / 2);
int thickness = argList [1];
int marginWidth = argList [3];
int borderWidth = getBorderWidth ();
int [] argList2 = {OS.XmNchildHorizontalSpacing, 0};
OS.XtGetValues (labelHandle, argList2, argList2.length / 2);
XtWidgetGeometry result = new XtWidgetGeometry ();
OS.XtQueryGeometry (labelHandle, null, result);
int titleWidth = result.width + 2 * (argList2 [1] + marginWidth + thickness + borderWidth);
size.x = Math.max (size.x, titleWidth);
}
return size;
}
public Rectangle computeTrim (int x, int y, int width, int height) {
checkWidget();
int trimX, trimY, trimWidth, trimHeight;
int [] argList = {
OS.XmNshadowThickness, 0,
OS.XmNmarginWidth, 0,
OS.XmNmarginHeight, 0
};
OS.XtGetValues (handle, argList, argList.length / 2);
int thickness = argList [1];
int marginWidth = argList [3];
int marginHeight = argList [5];
int borderWidth = getBorderWidth ();
trimX = x - marginWidth - thickness - borderWidth;
trimY = y - marginHeight - thickness - borderWidth;
trimWidth = width + ((marginWidth + thickness + borderWidth) * 2);
trimHeight = height + ((marginHeight + thickness + borderWidth) * 2);
if (OS.XtIsManaged (labelHandle)) {
int [] argList2 = {OS.XmNy, 0, OS.XmNheight, 0};
OS.XtGetValues (labelHandle, argList2, argList2.length / 2);
int titleHeight = ((short) argList2 [1]) + argList2 [3];
trimY = y - titleHeight;
trimHeight = height + titleHeight + (marginHeight + thickness + borderWidth);
}
return new Rectangle (trimX, trimY, trimWidth, trimHeight);
}
void createHandle (int index) {
state |= THEME_BACKGROUND;
/*
* Feature in Motif. When a widget is managed or unmanaged,
* it may request and be granted, a new size in the OS. This
* behavior is unwanted. The fix is to create a parent for
* the list that will disallow geometry requests.
*/
int border = (style & SWT.BORDER) != 0 ? 1 : 0;
int [] argList1 = {
OS.XmNancestorSensitive, 1,
OS.XmNborderWidth, border,
};
int parentHandle = parent.handle;
formHandle = OS.XmCreateForm (parentHandle, null, argList1, argList1.length / 2);
if (formHandle == 0) error (SWT.ERROR_NO_HANDLES);
int [] argList2 = {
OS.XmNshadowType, shadowType (),
OS.XmNtopAttachment, OS.XmATTACH_FORM,
OS.XmNbottomAttachment, OS.XmATTACH_FORM,
OS.XmNleftAttachment, OS.XmATTACH_FORM,
OS.XmNrightAttachment, OS.XmATTACH_FORM,
OS.XmNresizable, 0,
};
handle = OS.XmCreateFrame (formHandle, null, argList2, argList2.length / 2);
if (handle == 0) error (SWT.ERROR_NO_HANDLES);
int [] argList3 = {OS.XmNframeChildType, OS.XmFRAME_TITLE_CHILD};
labelHandle = OS.XmCreateLabel (handle, null, argList3, argList3.length / 2);
if (labelHandle == 0) error (SWT.ERROR_NO_HANDLES);
int [] argList4 = {OS.XmNforeground, 0, OS.XmNbackground, 0};
OS.XtGetValues (handle, argList4, argList4.length / 2);
OS.XtSetValues (labelHandle, argList4, argList4.length / 2);
}
void deregister () {
super.deregister ();
display.removeWidget (labelHandle);
}
void enableWidget (boolean enabled) {
super.enableWidget (enabled);
enableHandle (enabled, labelHandle);
}
int fontHandle () {
return labelHandle;
}
public Rectangle getClientArea () {
checkWidget();
/*
* Bug in Motif. For some reason, if a form has not been realized,
* calling XtResizeWidget () on the form does not lay out properly.
* The fix is to force the widget to be realized by forcing the shell
* to be realized.
*/
if (!OS.XtIsRealized (handle)) getShell ().realizeWidget ();
int [] argList = {
OS.XmNwidth, 0,
OS.XmNheight, 0,
OS.XmNshadowThickness, 0,
OS.XmNmarginWidth, 0,
OS.XmNmarginHeight, 0
};
OS.XtGetValues (handle, argList, argList.length / 2);
int thickness = argList [5];
int marginWidth = argList [7];
int marginHeight = argList [9];
int borderWidth = getBorderWidth ();
int x = marginWidth + thickness + borderWidth;
int y = marginHeight + thickness + borderWidth;
int width = argList [1] - ((marginWidth + thickness + borderWidth) * 2);
int height = argList [3] - ((marginHeight + thickness + borderWidth) * 2);
if (OS.XtIsManaged (labelHandle)) {
int [] argList2 = {OS.XmNy, 0, OS.XmNheight, 0};
OS.XtGetValues (labelHandle, argList2, argList2.length / 2);
y = ((short) argList2 [1]) + argList2 [3];
height = argList [3] - y - (marginHeight + thickness + borderWidth);
}
return new Rectangle (x, y, width, height);
}
/**
* Returns the receiver's text, which is the string that the
* is used as the <em>title</em>. If the text has not previously
* been set, returns an empty string.
*
* @return the text
*
* @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 String getText () {
checkWidget();
return text;
}
void hookEvents () {
super.hookEvents ();
int windowProc = display.windowProc;
OS.XtAddEventHandler (labelHandle, OS.ButtonPressMask, false, windowProc, BUTTON_PRESS);
OS.XtAddEventHandler (labelHandle, OS.ButtonReleaseMask, false, windowProc, BUTTON_RELEASE);
OS.XtAddEventHandler (labelHandle, OS.PointerMotionMask, false, windowProc, POINTER_MOTION);
}
boolean mnemonicHit (char key) {
return setFocus ();
}
boolean mnemonicMatch (char key) {
char mnemonic = findMnemonic (getText ());
if (mnemonic == '\0') return false;
return Character.toUpperCase (key) == Character.toUpperCase (mnemonic);
}
void propagateWidget (boolean enabled) {
super.propagateWidget (enabled);
propagateHandle (enabled, labelHandle, OS.None);
}
void redrawWidget (int x, int y, int width, int height, boolean redrawAll, boolean allChildren, boolean trim) {
super.redrawWidget (x, y, width, height, redrawAll, allChildren, trim);
short [] root_x = new short [1], root_y = new short [1];
OS.XtTranslateCoords (handle, (short) x, (short) y, root_x, root_y);
short [] label_x = new short [1], label_y = new short [1];
OS.XtTranslateCoords (labelHandle, (short) 0, (short) 0, label_x, label_y);
redrawHandle (root_x [0] - label_x [0], root_y [0] - label_y [0], width, height, redrawAll, labelHandle);
}
void register () {
super.register ();
display.addWidget (labelHandle, this);
}
void releaseHandle () {
super.releaseHandle ();
labelHandle = 0;
}
void setBackgroundPixel (int pixel) {
super.setBackgroundPixel (pixel);
int [] argList = {OS.XmNforeground, 0};
OS.XtGetValues (labelHandle, argList, argList.length / 2);
OS.XmChangeColor (labelHandle, pixel);
OS.XtSetValues (labelHandle, argList, argList.length / 2);
}
void setForegroundPixel (int pixel) {
int [] argList = {OS.XmNforeground, pixel};
OS.XtSetValues (labelHandle, argList, argList.length / 2);
super.setForegroundPixel (pixel);
}
void setParentBackground () {
super.setParentBackground ();
if (labelHandle != 0) setParentBackground (labelHandle);
}
/**
* Sets the receiver's text, which is the string that will
* be displayed as the receiver's <em>title</em>, to the argument,
* which may not be null. The string may include the mnemonic character.
* </p>
* Mnemonics are indicated by an '&' that causes the next
* character to be the mnemonic. When the user presses a
* key sequence that matches the mnemonic, focus is assigned
* to the first child of the group. On most platforms, the
* mnemonic appears underlined but may be emphasised in a
* platform specific manner. The mnemonic indicator character
* '&' can be escaped by doubling it in the string, causing
* a single '&' to be displayed.
* </p>
* @param string the new text
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the text is null</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 setText (String string) {
checkWidget();
if (string == null) error (SWT.ERROR_NULL_ARGUMENT);
text = string;
char [] text = new char [string.length ()];
string.getChars (0, text.length, text, 0);
int mnemonic = fixMnemonic (text);
byte [] buffer = Converter.wcsToMbcs (getCodePage (), text, true);
int xmString = OS.XmStringParseText (
buffer,
0,
OS.XmFONTLIST_DEFAULT_TAG,
OS.XmCHARSET_TEXT,
null,
0,
0);
if (xmString == 0) error (SWT.ERROR_CANNOT_SET_TEXT);
if (mnemonic == 0) mnemonic = OS.XK_VoidSymbol;
int [] argList = {
OS.XmNlabelType, OS.XmSTRING,
OS.XmNlabelString, xmString,
OS.XmNmnemonic, mnemonic,
};
OS.XtSetValues (labelHandle, argList, argList.length / 2);
if (xmString != 0) OS.XmStringFree (xmString);
if (string.length () == 0) {
OS.XtUnmanageChild (labelHandle);
} else {
OS.XtManageChild (labelHandle);
}
}
int shadowType () {
if ((style & SWT.SHADOW_IN) != 0) return OS.XmSHADOW_IN;
if ((style & SWT.SHADOW_OUT) != 0) return OS.XmSHADOW_OUT;
if ((style & SWT.SHADOW_ETCHED_IN) != 0) return OS.XmSHADOW_ETCHED_IN;
if ((style & SWT.SHADOW_ETCHED_OUT) != 0) return OS.XmSHADOW_ETCHED_OUT;
return OS.XmSHADOW_ETCHED_IN;
}
}
