projects/dwt2: org.eclipse.ui.forms/src/org/eclipse/ui/forms/widgets/Form.d annotate

author	Frank Benoit <benoit@tionex.de>
date	Sat, 14 Mar 2009 18:23:29 +0100
parents
children

rev	line source
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	1 /*******************************************************************************
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	2 * Copyright (c) 2000, 2007 IBM Corporation and others.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	3 * All rights reserved. This program and the accompanying materials
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	4 * are made available under the terms of the Eclipse Public License v1.0
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	5 * which accompanies this distribution, and is available at
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	6 * http://www.eclipse.org/legal/epl-v10.html
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	7 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	8 * Contributors:
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	9 * IBM Corporation - initial API and implementation
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	10 * Port to the D programming language:
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	11 * Frank Benoit <benoit@tionex.de>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	12 *******************************************************************************/
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	13 module org.eclipse.ui.forms.widgets.Form;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	14
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	15 import org.eclipse.ui.forms.widgets.SizeCache;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	16 import org.eclipse.ui.forms.widgets.FormText;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	17 import org.eclipse.ui.forms.widgets.ILayoutExtension;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	18 import org.eclipse.ui.forms.widgets.LayoutComposite;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	19
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	20 import org.eclipse.swt.SWT;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	21 import org.eclipse.swt.dnd.DragSourceListener;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	22 import org.eclipse.swt.dnd.DropTargetListener;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	23 import org.eclipse.swt.dnd.Transfer;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	24 import org.eclipse.swt.graphics.Color;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	25 import org.eclipse.swt.graphics.Font;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	26 import org.eclipse.swt.graphics.Image;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	27 import org.eclipse.swt.graphics.Point;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	28 import org.eclipse.swt.graphics.Rectangle;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	29 import org.eclipse.swt.widgets.Composite;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	30 import org.eclipse.swt.widgets.Control;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	31 import org.eclipse.swt.widgets.Layout;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	32 import org.eclipse.swt.widgets.Menu;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	33 import org.eclipse.jface.action.IMenuManager;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	34 import org.eclipse.jface.action.IToolBarManager;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	35 import org.eclipse.ui.forms.IFormColors;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	36 import org.eclipse.ui.forms.IMessage;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	37 import org.eclipse.ui.forms.events.IHyperlinkListener;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	38 import org.eclipse.ui.internal.forms.widgets.FormHeading;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	39 import org.eclipse.ui.internal.forms.widgets.FormUtil;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	40
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	41 import java.lang.all;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	42 import java.util.Set;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	43
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	44 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	45 * Form is a custom control that renders a title and an optional background
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	46 * image above the body composite. It can be used alone when part of parents
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	47 * that are scrolled. If scrolling is required, use <code>ScrolledForm</code>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	48 * instead because it has an instance of <code>Form</code> and adds scrolling
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	49 * capability.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	50 * <p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	51 * Form can have a title if set. If not set, title area will not be left empty -
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	52 * form body will be resized to fill the entire form. In addition, an optional
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	53 * title image can be set and is rendered to the left of the title (since 3.2).
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	54 * <p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	55 * Form can have a title drop down menu if the menu bar manager is not empty
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	56 * (since 3.3).
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	57 * <p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	58 * Form title can support drag and drop if drag and drop support methods are
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	59 * invoked. When used, additional decoration is rendered behind the title to
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	60 * reinforce the drag and drop ability (since 3.3).
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	61 * <p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	62 * The form supports status messages. These messages can have various severity
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	63 * (error, warning, info or none). If status hyperlink handler is specified, the
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	64 * messages with the specified severity other than none will be rendered as
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	65 * hyperlinks.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	66 * <p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	67 * Form can have a background image behind the title text. The image is tiled as
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	68 * many times as needed to fill the title area. Alternatively, gradient
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	69 * background can be painted vertically or horizontally.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	70 * <p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	71 * Form can be put in a 'busy' state. While in this state, title image is
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	72 * replaced with an animation that lasts as long as the 'busy' state is active.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	73 * <p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	74 * It is possible to create an optional head client control. When created, this
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	75 * control is placed in the form heading as a second row.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	76 * <p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	77 * Form has a custom layout manager that is wrap-enabled. If a form is placed in
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	78 * a composite whose layout manager implements ILayoutExtension, the body of the
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	79 * form will participate in wrapping as long as its layout manager implements
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	80 * ILayoutExtension as well.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	81 * <p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	82 * Children of the form should typically be created using FormToolkit to match
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	83 * the appearance and behaviour. When creating children, use the form body as a
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	84 * parent by calling 'getBody()' on the form instance. Example:
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	85 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	86 * <pre>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	87 * FormToolkit toolkit = new FormToolkit(parent.getDisplay());
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	88 * Form form = toolkit.createForm(parent);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	89 * form.setText("Sample form");
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	90 * form.getBody().setLayout(new GridLayout());
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	91 * toolkit.createButton(form.getBody(), "Checkbox", SWT.CHECK);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	92 * </pre>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	93 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	94 * <p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	95 * No layout manager has been set on the body. Clients are required to set the
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	96 * desired layout manager explicitly.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	97 * <p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	98 * Although the class is not final, it should not be subclassed.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	99 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	100 * @since 3.0
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	101 * @noextend This class is not intended to be subclassed by clients.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	102 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	103 public class Form : Composite {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	104 private FormHeading head;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	105
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	106 private Composite body_;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	107
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	108 private SizeCache body_Cache;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	109
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	110 private SizeCache headCache;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	111
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	112 private FormText selectionText;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	113
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	114 private class FormLayout : Layout, ILayoutExtension {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	115 public int computeMinimumWidth(Composite composite, bool flushCache) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	116 return computeSize(composite, 5, SWT.DEFAULT, flushCache).x;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	117 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	118
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	119 public int computeMaximumWidth(Composite composite, bool flushCache) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	120 return computeSize(composite, SWT.DEFAULT, SWT.DEFAULT, flushCache).x;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	121 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	122
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	123 public Point computeSize(Composite composite, int wHint, int hHint,
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	124 bool flushCache) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	125 if (flushCache) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	126 body_Cache.flush();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	127 headCache.flush();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	128 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	129 body_Cache.setControl(body_);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	130 headCache.setControl(head);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	131
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	132 int width = 0;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	133 int height = 0;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	134
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	135 Point hsize = headCache.computeSize(FormUtil.getWidthHint(wHint,
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	136 head), SWT.DEFAULT);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	137 width = Math.max(hsize.x, width);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	138 height = hsize.y;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	139
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	140 bool ignoreBody=getData(FormUtil.IGNORE_BODY) !is null;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	141
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	142 Point bsize;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	143 if (ignoreBody)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	144 bsize = new Point(0,0);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	145 else
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	146 bsize = body_Cache.computeSize(FormUtil.getWidthHint(wHint,
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	147 body_), SWT.DEFAULT);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	148 width = Math.max(bsize.x, width);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	149 height += bsize.y;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	150 return new Point(width, height);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	151 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	152
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	153 protected void layout(Composite composite, bool flushCache) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	154 if (flushCache) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	155 body_Cache.flush();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	156 headCache.flush();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	157 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	158 body_Cache.setControl(body_);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	159 headCache.setControl(head);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	160 Rectangle carea = composite.getClientArea();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	161
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	162 Point hsize = headCache.computeSize(carea.width, SWT.DEFAULT);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	163 headCache.setBounds(0, 0, carea.width, hsize.y);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	164 body_Cache
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	165 .setBounds(0, hsize.y, carea.width, carea.height - hsize.y);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	166 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	167 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	168
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	169 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	170 * Creates the form content control as a child of the provided parent.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	171 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	172 * @param parent
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	173 * the parent widget
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	174 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	175 public this(Composite parent, int style) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	176
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	177 body_Cache = new SizeCache();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	178 headCache = new SizeCache();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	179
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	180 super(parent, SWT.NO_BACKGROUND \| style);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	181 super.setLayout(new FormLayout());
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	182 head = new FormHeading(this, SWT.NULL);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	183 head.setMenu(parent.getMenu());
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	184 body_ = new LayoutComposite(this, SWT.NULL);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	185 body_.setMenu(parent.getMenu());
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	186 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	187
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	188 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	189 * Passes the menu to the form body.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	190 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	191 * @param menu
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	192 * the parent menu
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	193 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	194 public void setMenu(Menu menu) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	195 super.setMenu(menu);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	196 head.setMenu(menu);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	197 body_.setMenu(menu);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	198 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	199
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	200 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	201 * Fully delegates the size computation to the internal layout manager.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	202 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	203 public final Point computeSize(int wHint, int hHint, bool changed) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	204 return (cast(FormLayout) getLayout()).computeSize(this, wHint, hHint,
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	205 changed);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	206 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	207
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	208 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	209 * Prevents from changing the custom control layout.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	210 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	211 public final void setLayout(Layout layout) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	212 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	213
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	214 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	215 * Returns the title text that will be rendered at the top of the form.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	216 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	217 * @return the title text
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	218 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	219 public String getText() {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	220 return head.getText();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	221 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	222
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	223 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	224 * Returns the title image that will be rendered to the left of the title.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	225 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	226 * @return the title image or <code>null</code> if not set.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	227 * @since 3.2
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	228 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	229 public Image getImage() {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	230 return head.getImage();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	231 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	232
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	233 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	234 * Sets the foreground color of the form. This color will also be used for
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	235 * the body.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	236 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	237 * @param fg
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	238 * the foreground color
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	239 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	240 public void setForeground(Color fg) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	241 super.setForeground(fg);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	242 head.setForeground(fg);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	243 body_.setForeground(fg);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	244 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	245
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	246 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	247 * Sets the background color of the form. This color will also be used for
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	248 * the body.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	249 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	250 * @param bg
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	251 * the background color
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	252 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	253 public void setBackground(Color bg) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	254 super.setBackground(bg);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	255 head.setBackground(bg);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	256 body_.setBackground(bg);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	257 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	258
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	259 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	260 * Sets the font of the header text.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	261 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	262 * @param font
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	263 * the new font
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	264 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	265 public void setFont(Font font) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	266 super.setFont(font);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	267 head.setFont(font);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	268 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	269
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	270 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	271 * Sets the text to be rendered at the top of the form above the body as a
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	272 * title.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	273 * <p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	274 * <strong>Note:</strong> Mnemonics are indicated by an '&' that causes
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	275 * the next character to be the mnemonic. Mnemonics are not applicable in
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	276 * the case of the form title but need to be taken into acount due to the
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	277 * usage of the underlying widget that renders mnemonics in the title area.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	278 * The mnemonic indicator character '&' can be escaped by doubling it in
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	279 * the string, causing a single '&' to be displayed.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	280 * </p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	281 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	282 * @param text
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	283 * the title text
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	284 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	285 public void setText(String text) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	286 head.setText(text);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	287 layout();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	288 redraw();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	289 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	290
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	291 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	292 * Sets the image to be rendered to the left of the title. This image will
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	293 * be temporarily hidden in two cases:
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	294 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	295 * <ol>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	296 * <li>When the form is busy - replaced with a busy animation</li>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	297 * <li>When the form has message set - replaced with the image indicating
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	298 * message severity</li>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	299 * </ol>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	300 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	301 * @param image
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	302 * the title image or <code>null</code> to show no image.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	303 * @since 3.2
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	304 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	305 public void setImage(Image image) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	306 head.setImage(image);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	307 layout();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	308 redraw();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	309 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	310
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	311 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	312 * Sets the background colors to be painted behind the title text in a
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	313 * gradient. Note that this method will reset color previously set by
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	314 * {@link #setBackground(Color)}. This is necessary for the simulated
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	315 * transparency of the heading in all of its children control.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	316 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	317 * @param gradientColors
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	318 * the array of colors that form the gradient
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	319 * @param percents
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	320 * the partition of the overall space between the gradient colors
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	321 * @param vertical
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	322 * of <code>true</code>, the gradient will be rendered
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	323 * vertically, if <code>false</code> the orientation will be
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	324 * horizontal.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	325 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	326
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	327 public void setTextBackground(Color[] gradientColors, int[] percents,
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	328 bool vertical) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	329 head.setTextBackground(gradientColors, percents, vertical);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	330 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	331
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	332 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	333 * Returns the optional background image of the form head.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	334 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	335 * @return the background image or <code>null</code> if not specified.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	336 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	337 public Image getBackgroundImage() {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	338 return head.getHeadingBackgroundImage();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	339 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	340
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	341 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	342 * Sets the optional background image to be rendered behind the title
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	343 * starting at the position 0,0. If the image is smaller than the container
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	344 * in any dimension, it will be tiled.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	345 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	346 * @since 3.2
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	347 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	348 * @param backgroundImage
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	349 * the head background image.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	350 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	351 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	352 public void setBackgroundImage(Image backgroundImage) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	353 head.setHeadingBackgroundImage(backgroundImage);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	354 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	355
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	356 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	357 * Returns the tool bar manager that is used to manage tool items in the
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	358 * form's title area.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	359 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	360 * @return form tool bar manager
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	361 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	362 public IToolBarManager getToolBarManager() {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	363 return head.getToolBarManager();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	364 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	365
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	366 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	367 * Sets the tool bar vertical alignment relative to the header. Can be
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	368 * useful when there is more free space at the second row (with the head
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	369 * client).
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	370 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	371 * @param alignment
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	372 * SWT.TOP or SWT.BOTTOM
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	373 * @since 3.3
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	374 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	375
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	376 public void setToolBarVerticalAlignment(int alignment) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	377 head.setToolBarAlignment(alignment);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	378 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	379
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	380 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	381 * Returns the current tool bar alignment (if used).
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	382 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	383 * @return SWT.TOP or SWT.BOTTOM
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	384 * @since 3.3
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	385 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	386
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	387 public int getToolBarVerticalAlignment() {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	388 return head.getToolBarAlignment();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	389 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	390
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	391 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	392 * Returns the menu manager that is used to manage title area drop-down menu
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	393 * items.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	394 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	395 * @return title area drop-down menu manager
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	396 * @since 3.3
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	397 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	398 public IMenuManager getMenuManager() {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	399 return head.getMenuManager();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	400 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	401
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	402 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	403 * Updates the local tool bar manager if used. Does nothing if local tool
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	404 * bar manager has not been created yet.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	405 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	406 public void updateToolBar() {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	407 head.updateToolBar();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	408 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	409
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	410 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	411 * Returns the container that occupies the head of the form (the form area
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	412 * above the body). Use this container as a parent for the head client.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	413 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	414 * @return the head of the form.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	415 * @since 3.2
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	416 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	417 public Composite getHead() {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	418 return head;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	419 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	420
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	421 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	422 * Returns the optional head client if set.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	423 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	424 * @return the head client or <code>null</code> if not set.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	425 * @see #setHeadClient(Control)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	426 * @since 3.2
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	427 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	428 public Control getHeadClient() {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	429 return head.getHeadClient();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	430 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	431
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	432 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	433 * Sets the optional head client. Head client is placed after the form
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	434 * title. This option causes the tool bar to be placed in the second raw of
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	435 * the header (below the head client).
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	436 * <p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	437 * The head client must be a child of the composite returned by
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	438 * <code>getHead()</code> method.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	439 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	440 * @param headClient
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	441 * the optional child of the head
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	442 * @since 3.2
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	443 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	444 public void setHeadClient(Control headClient) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	445 head.setHeadClient(headClient);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	446 layout();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	447 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	448
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	449 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	450 * Returns the container that occupies the body of the form (the form area
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	451 * below the title). Use this container as a parent for the controls that
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	452 * should be in the form. No layout manager has been set on the form body.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	453 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	454 * @return Returns the body of the form.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	455 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	456 public Composite getBody() {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	457 return body_;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	458 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	459
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	460 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	461 * Tests if the background image is tiled to cover the entire area of the
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	462 * form heading.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	463 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	464 * @return <code>true</code> if heading background image is tiled,
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	465 * <code>false</code> otherwise.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	466 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	467 public bool isBackgroundImageTiled() {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	468 return head.isBackgroundImageTiled();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	469 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	470
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	471 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	472 * Sets whether the header background image is repeated to cover the entire
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	473 * heading area or not.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	474 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	475 * @param backgroundImageTiled
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	476 * set <code>true</code> to tile the image, or
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	477 * <code>false</code> to paint the background image only once
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	478 * at 0,0
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	479 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	480 public void setBackgroundImageTiled(bool backgroundImageTiled) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	481 head.setBackgroundImageTiled(backgroundImageTiled);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	482 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	483
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	484 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	485 * Returns the background image alignment.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	486 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	487 * @deprecated due to the underlying widget limitations, background image is
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	488 * either painted at 0,0 and/or tiled.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	489 * @return SWT.LEFT
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	490 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	491 public int getBackgroundImageAlignment() {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	492 return SWT.LEFT;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	493 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	494
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	495 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	496 * Sets the background image alignment.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	497 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	498 * @deprecated due to the underlying widget limitations, background image is
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	499 * always tiled and alignment cannot be controlled.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	500 * @param backgroundImageAlignment

12

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1 /*******************************************************************************

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

4 * are made available under the terms of the Eclipse Public License v1.0

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

5 * which accompanies this distribution, and is available at

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

6 * http://www.eclipse.org/legal/epl-v10.html

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

7 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

8 * Contributors:

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

9 * IBM Corporation - initial API and implementation

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

10 * Port to the D programming language:

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

11 * Frank Benoit <benoit@tionex.de>

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

12 *******************************************************************************/

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

13 module org.eclipse.ui.forms.widgets.Form;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

14

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

15 import org.eclipse.ui.forms.widgets.SizeCache;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

16 import org.eclipse.ui.forms.widgets.FormText;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

17 import org.eclipse.ui.forms.widgets.ILayoutExtension;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

18 import org.eclipse.ui.forms.widgets.LayoutComposite;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

19

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

20 import org.eclipse.swt.SWT;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

21 import org.eclipse.swt.dnd.DragSourceListener;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

22 import org.eclipse.swt.dnd.DropTargetListener;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

23 import org.eclipse.swt.dnd.Transfer;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

24 import org.eclipse.swt.graphics.Color;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

25 import org.eclipse.swt.graphics.Font;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

26 import org.eclipse.swt.graphics.Image;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

27 import org.eclipse.swt.graphics.Point;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

28 import org.eclipse.swt.graphics.Rectangle;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

29 import org.eclipse.swt.widgets.Composite;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

30 import org.eclipse.swt.widgets.Control;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

31 import org.eclipse.swt.widgets.Layout;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

32 import org.eclipse.swt.widgets.Menu;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

33 import org.eclipse.jface.action.IMenuManager;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

34 import org.eclipse.jface.action.IToolBarManager;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

35 import org.eclipse.ui.forms.IFormColors;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

36 import org.eclipse.ui.forms.IMessage;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

37 import org.eclipse.ui.forms.events.IHyperlinkListener;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

38 import org.eclipse.ui.internal.forms.widgets.FormHeading;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

39 import org.eclipse.ui.internal.forms.widgets.FormUtil;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

40

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

41 import java.lang.all;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

42 import java.util.Set;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

43

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

44 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

45 * Form is a custom control that renders a title and an optional background

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

46 * image above the body composite. It can be used alone when part of parents

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

47 * that are scrolled. If scrolling is required, use <code>ScrolledForm</code>

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

48 * instead because it has an instance of <code>Form</code> and adds scrolling

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

49 * capability.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

50 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

51 * Form can have a title if set. If not set, title area will not be left empty -

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

52 * form body will be resized to fill the entire form. In addition, an optional

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

53 * title image can be set and is rendered to the left of the title (since 3.2).

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

54 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

55 * Form can have a title drop down menu if the menu bar manager is not empty

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

56 * (since 3.3).

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

57 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

58 * Form title can support drag and drop if drag and drop support methods are

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

59 * invoked. When used, additional decoration is rendered behind the title to

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

60 * reinforce the drag and drop ability (since 3.3).

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

61 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

62 * The form supports status messages. These messages can have various severity

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

63 * (error, warning, info or none). If status hyperlink handler is specified, the

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

64 * messages with the specified severity other than none will be rendered as

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

65 * hyperlinks.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

66 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

67 * Form can have a background image behind the title text. The image is tiled as

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

68 * many times as needed to fill the title area. Alternatively, gradient

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

69 * background can be painted vertically or horizontally.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

70 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

71 * Form can be put in a 'busy' state. While in this state, title image is

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

72 * replaced with an animation that lasts as long as the 'busy' state is active.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

73 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

74 * It is possible to create an optional head client control. When created, this

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

75 * control is placed in the form heading as a second row.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

76 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

77 * Form has a custom layout manager that is wrap-enabled. If a form is placed in

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

78 * a composite whose layout manager implements ILayoutExtension, the body of the

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

79 * form will participate in wrapping as long as its layout manager implements

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

80 * ILayoutExtension as well.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

81 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

82 * Children of the form should typically be created using FormToolkit to match

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

83 * the appearance and behaviour. When creating children, use the form body as a

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

84 * parent by calling 'getBody()' on the form instance. Example:

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

85 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

86 * <pre>

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

87 * FormToolkit toolkit = new FormToolkit(parent.getDisplay());

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

88 * Form form = toolkit.createForm(parent);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

89 * form.setText("Sample form");

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

90 * form.getBody().setLayout(new GridLayout());

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

91 * toolkit.createButton(form.getBody(), "Checkbox", SWT.CHECK);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

92 * </pre>

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

93 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

94 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

95 * No layout manager has been set on the body. Clients are required to set the

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

96 * desired layout manager explicitly.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

97 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

98 * Although the class is not final, it should not be subclassed.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

99 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

100 * @since 3.0

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

101 * @noextend This class is not intended to be subclassed by clients.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

102 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

103 public class Form : Composite {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

104 private FormHeading head;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

105

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

106 private Composite body_;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

107

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

108 private SizeCache body_Cache;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

109

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

110 private SizeCache headCache;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

111

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

112 private FormText selectionText;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

113

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

114 private class FormLayout : Layout, ILayoutExtension {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

115 public int computeMinimumWidth(Composite composite, bool flushCache) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

116 return computeSize(composite, 5, SWT.DEFAULT, flushCache).x;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

117 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

118

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

119 public int computeMaximumWidth(Composite composite, bool flushCache) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

120 return computeSize(composite, SWT.DEFAULT, SWT.DEFAULT, flushCache).x;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

121 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

122

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

123 public Point computeSize(Composite composite, int wHint, int hHint,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

124 bool flushCache) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

125 if (flushCache) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

126 body_Cache.flush();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

127 headCache.flush();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

128 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

129 body_Cache.setControl(body_);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

130 headCache.setControl(head);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

131

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

132 int width = 0;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

133 int height = 0;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

134

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

135 Point hsize = headCache.computeSize(FormUtil.getWidthHint(wHint,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

136 head), SWT.DEFAULT);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

137 width = Math.max(hsize.x, width);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

138 height = hsize.y;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

139

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

140 bool ignoreBody=getData(FormUtil.IGNORE_BODY) !is null;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

141

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

142 Point bsize;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

143 if (ignoreBody)

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

144 bsize = new Point(0,0);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

145 else

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

146 bsize = body_Cache.computeSize(FormUtil.getWidthHint(wHint,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

147 body_), SWT.DEFAULT);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

148 width = Math.max(bsize.x, width);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

149 height += bsize.y;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

150 return new Point(width, height);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

151 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

152

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

153 protected void layout(Composite composite, bool flushCache) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

154 if (flushCache) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

155 body_Cache.flush();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

156 headCache.flush();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

157 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

158 body_Cache.setControl(body_);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

159 headCache.setControl(head);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

160 Rectangle carea = composite.getClientArea();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

161

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

162 Point hsize = headCache.computeSize(carea.width, SWT.DEFAULT);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

163 headCache.setBounds(0, 0, carea.width, hsize.y);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

164 body_Cache

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

165 .setBounds(0, hsize.y, carea.width, carea.height - hsize.y);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

166 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

167 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

168

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

169 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

170 * Creates the form content control as a child of the provided parent.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

171 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

172 * @param parent

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

173 * the parent widget

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

174 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

175 public this(Composite parent, int style) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

176

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

177 body_Cache = new SizeCache();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

178 headCache = new SizeCache();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

179

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

180 super(parent, SWT.NO_BACKGROUND | style);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

181 super.setLayout(new FormLayout());

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

182 head = new FormHeading(this, SWT.NULL);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

183 head.setMenu(parent.getMenu());

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

184 body_ = new LayoutComposite(this, SWT.NULL);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

185 body_.setMenu(parent.getMenu());

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

186 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

187

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

188 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

189 * Passes the menu to the form body.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

190 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

191 * @param menu

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

192 * the parent menu

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

193 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

194 public void setMenu(Menu menu) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

195 super.setMenu(menu);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

196 head.setMenu(menu);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

197 body_.setMenu(menu);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

198 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

199

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

200 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

201 * Fully delegates the size computation to the internal layout manager.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

202 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

203 public final Point computeSize(int wHint, int hHint, bool changed) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

204 return (cast(FormLayout) getLayout()).computeSize(this, wHint, hHint,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

205 changed);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

206 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

207

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

208 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

209 * Prevents from changing the custom control layout.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

210 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

211 public final void setLayout(Layout layout) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

212 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

213

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

214 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

215 * Returns the title text that will be rendered at the top of the form.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

216 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

217 * @return the title text

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

218 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

219 public String getText() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

220 return head.getText();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

221 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

222

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

223 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

224 * Returns the title image that will be rendered to the left of the title.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

225 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

226 * @return the title image or <code>null</code> if not set.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

227 * @since 3.2

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

228 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

229 public Image getImage() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

230 return head.getImage();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

231 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

232

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

233 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

234 * Sets the foreground color of the form. This color will also be used for

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

235 * the body.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

236 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

237 * @param fg

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

238 * the foreground color

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

239 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

240 public void setForeground(Color fg) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

241 super.setForeground(fg);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

242 head.setForeground(fg);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

243 body_.setForeground(fg);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

244 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

245

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

246 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

247 * Sets the background color of the form. This color will also be used for

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

248 * the body.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

249 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

250 * @param bg

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

251 * the background color

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

252 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

253 public void setBackground(Color bg) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

254 super.setBackground(bg);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

255 head.setBackground(bg);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

256 body_.setBackground(bg);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

257 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

258

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

259 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

260 * Sets the font of the header text.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

261 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

262 * @param font

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

263 * the new font

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

264 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

265 public void setFont(Font font) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

266 super.setFont(font);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

267 head.setFont(font);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

268 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

269

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

270 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

271 * Sets the text to be rendered at the top of the form above the body as a

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

272 * title.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

273 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

274 * Note: Mnemonics are indicated by an '&' that causes

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

275 * the next character to be the mnemonic. Mnemonics are not applicable in

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

276 * the case of the form title but need to be taken into acount due to the

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

277 * usage of the underlying widget that renders mnemonics in the title area.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

278 * The mnemonic indicator character '&' can be escaped by doubling it in

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

279 * the string, causing a single '&' to be displayed.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

280 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

281 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

282 * @param text

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

283 * the title text

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

284 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

285 public void setText(String text) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

286 head.setText(text);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

287 layout();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

288 redraw();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

289 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

290

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

291 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

292 * Sets the image to be rendered to the left of the title. This image will

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

293 * be temporarily hidden in two cases:

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

294 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

295 * <ol>

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

296 * <li>When the form is busy - replaced with a busy animation</li>

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

297 * <li>When the form has message set - replaced with the image indicating

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

298 * message severity</li>

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

299 * </ol>

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

300 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

301 * @param image

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

302 * the title image or <code>null</code> to show no image.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

303 * @since 3.2

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

304 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

305 public void setImage(Image image) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

306 head.setImage(image);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

307 layout();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

308 redraw();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

309 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

310

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

311 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

312 * Sets the background colors to be painted behind the title text in a

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

313 * gradient. Note that this method will reset color previously set by

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

314 * {@link #setBackground(Color)}. This is necessary for the simulated

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

315 * transparency of the heading in all of its children control.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

316 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

317 * @param gradientColors

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

318 * the array of colors that form the gradient

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

319 * @param percents

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

320 * the partition of the overall space between the gradient colors

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

321 * @param vertical

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

322 * of <code>true</code>, the gradient will be rendered

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

323 * vertically, if <code>false</code> the orientation will be

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

324 * horizontal.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

325 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

326

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

327 public void setTextBackground(Color[] gradientColors, int[] percents,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

328 bool vertical) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

329 head.setTextBackground(gradientColors, percents, vertical);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

330 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

331

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

332 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

333 * Returns the optional background image of the form head.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

334 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

335 * @return the background image or <code>null</code> if not specified.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

336 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

337 public Image getBackgroundImage() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

338 return head.getHeadingBackgroundImage();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

339 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

340

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

341 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

342 * Sets the optional background image to be rendered behind the title

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

343 * starting at the position 0,0. If the image is smaller than the container

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

344 * in any dimension, it will be tiled.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

345 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

346 * @since 3.2

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

347 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

348 * @param backgroundImage

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

349 * the head background image.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

350 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

351 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

352 public void setBackgroundImage(Image backgroundImage) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

353 head.setHeadingBackgroundImage(backgroundImage);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

354 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

355

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

356 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

357 * Returns the tool bar manager that is used to manage tool items in the

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

358 * form's title area.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

359 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

360 * @return form tool bar manager

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

361 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

362 public IToolBarManager getToolBarManager() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

363 return head.getToolBarManager();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

364 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

365

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

366 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

367 * Sets the tool bar vertical alignment relative to the header. Can be

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

368 * useful when there is more free space at the second row (with the head

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

369 * client).

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

370 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

371 * @param alignment

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

372 * SWT.TOP or SWT.BOTTOM

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

373 * @since 3.3

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

374 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

375

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

376 public void setToolBarVerticalAlignment(int alignment) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

377 head.setToolBarAlignment(alignment);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

378 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

379

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

380 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

381 * Returns the current tool bar alignment (if used).

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

382 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

383 * @return SWT.TOP or SWT.BOTTOM

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

384 * @since 3.3

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

385 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

386

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

387 public int getToolBarVerticalAlignment() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

388 return head.getToolBarAlignment();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

389 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

390

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

391 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

392 * Returns the menu manager that is used to manage title area drop-down menu

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

393 * items.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

394 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

395 * @return title area drop-down menu manager

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

396 * @since 3.3

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

397 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

398 public IMenuManager getMenuManager() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

399 return head.getMenuManager();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

400 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

401

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

402 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

403 * Updates the local tool bar manager if used. Does nothing if local tool

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

404 * bar manager has not been created yet.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

405 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

406 public void updateToolBar() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

407 head.updateToolBar();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

408 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

409

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

410 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

411 * Returns the container that occupies the head of the form (the form area

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

412 * above the body). Use this container as a parent for the head client.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

413 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

414 * @return the head of the form.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

415 * @since 3.2

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

416 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

417 public Composite getHead() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

418 return head;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

419 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

420

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

421 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

422 * Returns the optional head client if set.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

423 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

424 * @return the head client or <code>null</code> if not set.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

425 * @see #setHeadClient(Control)

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

426 * @since 3.2

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

427 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

428 public Control getHeadClient() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

429 return head.getHeadClient();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

430 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

431

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

432 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

433 * Sets the optional head client. Head client is placed after the form

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

434 * title. This option causes the tool bar to be placed in the second raw of

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

435 * the header (below the head client).

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

436 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

437 * The head client must be a child of the composite returned by

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

438 * <code>getHead()</code> method.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

439 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

440 * @param headClient

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

441 * the optional child of the head

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

442 * @since 3.2

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

443 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

444 public void setHeadClient(Control headClient) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

445 head.setHeadClient(headClient);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

446 layout();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

447 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

448

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

449 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

450 * Returns the container that occupies the body of the form (the form area

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

451 * below the title). Use this container as a parent for the controls that

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

452 * should be in the form. No layout manager has been set on the form body.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

453 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

454 * @return Returns the body of the form.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

455 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

456 public Composite getBody() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

457 return body_;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

458 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

459

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

460 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

461 * Tests if the background image is tiled to cover the entire area of the

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

462 * form heading.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

463 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

464 * @return <code>true</code> if heading background image is tiled,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

465 * <code>false</code> otherwise.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

466 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

467 public bool isBackgroundImageTiled() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

468 return head.isBackgroundImageTiled();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

469 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

470

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

471 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

472 * Sets whether the header background image is repeated to cover the entire

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

473 * heading area or not.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

474 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

475 * @param backgroundImageTiled

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

476 * set <code>true</code> to tile the image, or

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

477 * <code>false</code> to paint the background image only once

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

478 * at 0,0

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

479 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

480 public void setBackgroundImageTiled(bool backgroundImageTiled) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

481 head.setBackgroundImageTiled(backgroundImageTiled);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

482 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

483

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

484 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

485 * Returns the background image alignment.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

486 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

487 * @deprecated due to the underlying widget limitations, background image is

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

488 * either painted at 0,0 and/or tiled.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

489 * @return SWT.LEFT

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

490 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

491 public int getBackgroundImageAlignment() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

492 return SWT.LEFT;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

493 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

494

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

495 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

496 * Sets the background image alignment.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

497 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

498 * @deprecated due to the underlying widget limitations, background image is

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

499 * always tiled and alignment cannot be controlled.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

500 * @param backgroundImageAlignment

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

501 * The backgroundImageAlignment to set.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

502 * @since 3.1

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

503 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

504 public void setBackgroundImageAlignment(int backgroundImageAlignment) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

505 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

506

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

507 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

508 * Tests if background image is clipped.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

509 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

510 * @deprecated due to the underlying widget limitations, background image is

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

511 * always clipped.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

512 * @return true

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

513 * @since 3.1

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

514 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

515 public bool isBackgroundImageClipped() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

516 return true;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

517 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

518

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

519 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

520 * Sets whether the background image is clipped.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

521 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

522 * @deprecated due to the underlying widget limitations, background image is

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

523 * always clipped.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

524 * @param backgroundImageClipped

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

525 * the value to set

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

526 * @since 3.1

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

527 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

528 public void setBackgroundImageClipped(bool backgroundImageClipped) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

529 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

530

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

531 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

532 * Tests if the form head separator is visible.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

533 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

534 * @return <code>true</code> if the head/body separator is visible,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

535 * <code>false</code> otherwise

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

536 * @since 3.2

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

537 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

538 public bool isSeparatorVisible() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

539 return head.isSeparatorVisible();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

540 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

541

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

542 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

543 * If set, adds a separator between the head and body. Since 3.3, the colors

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

544 * that are used to render it are {@link IFormColors#H_BOTTOM_KEYLINE1} and

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

545 * {@link IFormColors#H_BOTTOM_KEYLINE2}.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

546 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

547 * @param addSeparator

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

548 * <code>true</code> to make the separator visible,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

549 * <code>false</code> otherwise.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

550 * @since 3.2

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

551 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

552 public void setSeparatorVisible(bool addSeparator) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

553 head.setSeparatorVisible(addSeparator);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

554 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

555

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

556 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

557 * Returns the color used to render the optional head separator. If gradient

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

558 * text background is used additional colors from the gradient will be used

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

559 * to render the separator.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

560 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

561 * @return separator color or <code>null</code> if not set.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

562 * @since 3.2

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

563 * @deprecated use <code>getHeadColor(IFormColors.H_BOTTOM_KEYLINE2)</code>

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

564 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

565

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

566 public Color getSeparatorColor() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

567 return head.getColor(IFormColors.H_BOTTOM_KEYLINE2);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

568 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

569

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

570 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

571 * Sets the color to be used to render the optional head separator.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

572 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

573 * @param separatorColor

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

574 * the color to render the head separator or <code>null</code>

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

575 * to use the default color.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

576 * @since 3.2

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

577 * @deprecated use

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

578 * <code>setHeadColor(IFormColors.H_BOTTOM_KEYLINE2, separatorColor)</code>

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

579 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

580 public void setSeparatorColor(Color separatorColor) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

581 head.putColor(IFormColors.H_BOTTOM_KEYLINE2, separatorColor);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

582 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

583

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

584 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

585 * Sets the color used to paint an aspect of the form heading.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

586 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

587 * @param key

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

588 * a valid form heading color key as defined in

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

589 * {@link IFormColors}. Relevant keys all start with an H_

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

590 * prefix.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

591 * @param color

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

592 * the color to use for the provided key

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

593 * @since 3.3

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

594 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

595

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

596 public void setHeadColor(String key, Color color) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

597 head.putColor(key, color);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

598 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

599

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

600 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

601 * Returns the color that is currently use to paint an aspect of the form

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

602 * heading, or <code>null</code> if not defined.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

603 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

604 * @param key

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

605 * the color key

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

606 * @return the color object or <code>null</code> if not set.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

607 * @since 3.3

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

608 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

609

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

610 public Color getHeadColor(String key) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

611 return head.getColor(key);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

612 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

613

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

614 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

615 * Sets the message for this form. Message text is rendered in the form head

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

616 * when shown.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

617 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

618 * @param message

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

619 * the message, or <code>null</code> to clear the message

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

620 * @see #setMessage(String, int)

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

621 * @since 3.2

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

622 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

623 public void setMessage(String message) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

624 this.setMessage(message, 0, null);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

625 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

626

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

627 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

628 * Sets the message for this form with an indication of what type of message

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

629 * it is.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

630 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

631 * The valid message types are one of <code>NONE</code>,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

632 * <code>INFORMATION</code>,<code>WARNING</code>, or

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

633 * <code>ERROR</code> defined in IMessageProvider interface.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

634 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

635 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

636 * @param newMessage

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

637 * the message, or <code>null</code> to clear the message

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

638 * @param newType

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

639 * the message type

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

640 * @see org.eclipse.jface.dialogs.IMessageProvider

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

641 * @since 3.2

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

642 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

643

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

644 public void setMessage(String newMessage, int newType) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

645 this.setMessage(newMessage, newType, null);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

646 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

647

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

648 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

649 * Sets the message for this form with an indication of what type of message

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

650 * it is.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

651 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

652 * The valid message types are one of <code>NONE</code>,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

653 * <code>INFORMATION</code>,<code>WARNING</code>, or

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

654 * <code>ERROR</code> defined in IMessageProvider interface.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

655 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

656 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

657 * In addition to the summary message, this method also sets an array of

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

658 * individual messages.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

659 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

660 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

661 * @param newMessage

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

662 * the message, or <code>null</code> to clear the message

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

663 * @param newType

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

664 * the message type

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

665 * @param children

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

666 * the individual messages that contributed to the overall

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

667 * message

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

668 * @see org.eclipse.jface.dialogs.IMessageProvider

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

669 * @since 3.3

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

670 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

671

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

672 public void setMessage(String newMessage, int newType, IMessage[] children) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

673 head.showMessage(newMessage, newType, children);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

674 layout();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

675 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

676

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

677 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

678 * Adds a message hyperlink listener. If at least one listener is present,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

679 * messages will be rendered as hyperlinks.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

680 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

681 * @param listener

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

682 * @see #removeMessageHyperlinkListener(IHyperlinkListener)

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

683 * @since 3.3

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

684 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

685 public void addMessageHyperlinkListener(IHyperlinkListener listener) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

686 head.addMessageHyperlinkListener(listener);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

687 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

688

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

689 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

690 * Remove the message hyperlink listener.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

691 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

692 * @param listener

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

693 * @see #addMessageHyperlinkListener(IHyperlinkListener)

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

694 * @since 3.3

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

695 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

696 public void removeMessageHyperlinkListener(IHyperlinkListener listener) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

697 head.removeMessageHyperlinkListener(listener);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

698 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

699

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

700 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

701 * Tests if the form is in the 'busy' state. Busy form displays 'busy'

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

702 * animation in the area of the title image.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

703 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

704 * @return <code>true</code> if busy, <code>false</code> otherwise.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

705 * @since 3.2

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

706 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

707

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

708 public bool isBusy() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

709 return head.isBusy();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

710 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

711

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

712 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

713 * Sets the form's busy state. Busy form will display 'busy' animation in

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

714 * the area of the title image.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

715 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

716 * @param busy

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

717 * the form's busy state

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

718 * @since 3.2

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

719 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

720

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

721 public void setBusy(bool busy) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

722 head.setBusy(busy);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

723 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

724

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

725 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

726 * Adds support for dragging items out of the form title area via a user

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

727 * drag-and-drop operation.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

728 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

729 * @param operations

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

730 * a bitwise OR of the supported drag and drop operation types (

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

731 * <code>DROP_COPY</code>,<code>DROP_LINK</code>, and

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

732 * <code>DROP_MOVE</code>)

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

733 * @param transferTypes

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

734 * the transfer types that are supported by the drag operation

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

735 * @param listener

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

736 * the callback that will be invoked to set the drag data and to

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

737 * cleanup after the drag and drop operation finishes

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

738 * @see org.eclipse.swt.dnd.DND

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

739 * @since 3.3

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

740 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

741 public void addTitleDragSupport(int operations, Transfer[] transferTypes,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

742 DragSourceListener listener) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

743 head.addDragSupport(operations, transferTypes, listener);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

744 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

745

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

746 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

747 * Adds support for dropping items into the form title area via a user

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

748 * drag-and-drop operation.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

749 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

750 * @param operations

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

751 * a bitwise OR of the supported drag and drop operation types (

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

752 * <code>DROP_COPY</code>,<code>DROP_LINK</code>, and

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

753 * <code>DROP_MOVE</code>)

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

754 * @param transferTypes

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

755 * the transfer types that are supported by the drop operation

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

756 * @param listener

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

757 * the callback that will be invoked after the drag and drop

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

758 * operation finishes

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

759 * @see org.eclipse.swt.dnd.DND

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

760 * @since 3.3

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

761 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

762 public void addTitleDropSupport(int operations, Transfer[] transferTypes,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

763 DropTargetListener listener) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

764 head.addDropSupport(operations, transferTypes, listener);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

765 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

766

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

767 /*

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

768 * (non-Javadoc)

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

769 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

770 * @see org.eclipse.jface.dialogs.IMessageProvider#getMessage()

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

771 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

772 public String getMessage() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

773 return head.getMessage();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

774 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

775

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

776 /*

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

777 * (non-Javadoc)

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

778 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

779 * @see org.eclipse.jface.dialogs.IMessageProvider#getMessageType()

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

780 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

781 public int getMessageType() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

782 return head.getMessageType();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

783 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

784

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

785 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

786 * Returns the children messages that the cause of the summary message

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

787 * currently set on the form.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

788 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

789 * @return an array of children messages or <code>null</code> if not set.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

790 * @see #setMessage(String, int, IMessage[])

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

791 * @since 3.3

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

792 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

793 public IMessage[] getChildrenMessages() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

794 return head.getChildrenMessages();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

795 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

796

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

797 void setSelectionText(FormText text) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

798 if (selectionText !is null && selectionText !is text) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

799 selectionText.clearSelection();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

800 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

801 this.selectionText = text;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

802 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

803 }

Mercurial > projects > dwt2

annotate org.eclipse.ui.forms/src/org/eclipse/ui/forms/widgets/Form.d @ 12:bc29606a740c