annotate dwtx/jface/action/ControlContribution.d @ 192:c3583c6ec027

Added missing default cases for switch statements
author Frank Benoit <benoit@tionex.de>
date Mon, 03 Nov 2008 22:52:26 +0100
parents ea8ff534f622
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
24
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
1 /*******************************************************************************
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
2 * Copyright (c) 2000, 2006 IBM Corporation and others.
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 *
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * Contributors:
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
9 * IBM Corporation - initial API and implementation
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
10 * Port to the D programming language:
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
11 * Frank Benoit <benoit@tionex.de>
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12 *******************************************************************************/
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
13 module dwtx.jface.action.ControlContribution;
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15 import dwtx.jface.action.ContributionItem;
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17 import dwt.DWT;
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18 import dwt.widgets.Composite;
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 import dwt.widgets.Control;
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 import dwt.widgets.Menu;
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 import dwt.widgets.ToolBar;
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 import dwt.widgets.ToolItem;
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 import dwtx.core.runtime.Assert;
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 import dwt.dwthelper.utils;
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 /**
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 * An abstract contribution item implementation for adding an arbitrary
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 * DWT control to a tool bar.
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 * Note, however, that these items cannot be contributed to menu bars.
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 * <p>
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 * The <code>createControl</code> framework method must be implemented
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 * by concrete subclasses.
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 * </p>
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 */
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 public abstract class ControlContribution : ContributionItem {
43
ea8ff534f622 Fix override and super aliases
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
37 alias ContributionItem.fill fill;
24
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 /**
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 * Creates a control contribution item with the given id.
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 *
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 * @param id the contribution item id
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 */
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43 protected this(String id) {
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44 super(id);
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 }
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47 /**
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48 * Computes the width of the given control which is being added
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49 * to a tool bar. This is needed to determine the width of the tool bar item
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
50 * containing the given control.
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
51 * <p>
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52 * The default implementation of this framework method returns
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53 * <code>control.computeSize(DWT.DEFAULT, DWT.DEFAULT, true).x</code>.
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
54 * Subclasses may override if required.
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
55 * </p>
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
56 *
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
57 * @param control the control being added
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
58 * @return the width of the control
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59 */
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
60 protected int computeWidth(Control control) {
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
61 return control.computeSize(DWT.DEFAULT, DWT.DEFAULT, true).x;
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62 }
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
64 /**
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65 * Creates and returns the control for this contribution item
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66 * under the given parent composite.
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67 * <p>
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
68 * This framework method must be implemented by concrete
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
69 * subclasses.
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70 * </p>
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
71 *
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72 * @param parent the parent composite
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
73 * @return the new control
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
74 */
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
75 protected abstract Control createControl(Composite parent);
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
76
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
77 /**
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
78 * The control item implementation of this <code>IContributionItem</code>
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
79 * method calls the <code>createControl</code> framework method.
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80 * Subclasses must implement <code>createControl</code> rather than
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
81 * overriding this method.
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
82 */
43
ea8ff534f622 Fix override and super aliases
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
83 public override final void fill(Composite parent) {
24
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
84 createControl(parent);
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
85 }
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
86
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
87 /**
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
88 * The control item implementation of this <code>IContributionItem</code>
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
89 * method throws an exception since controls cannot be added to menus.
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
90 */
43
ea8ff534f622 Fix override and super aliases
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
91 public override final void fill(Menu parent, int index) {
24
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
92 Assert.isTrue(false, "Can't add a control to a menu");//$NON-NLS-1$
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
93 }
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
94
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
95 /**
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
96 * The control item implementation of this <code>IContributionItem</code>
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
97 * method calls the <code>createControl</code> framework method to
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
98 * create a control under the given parent, and then creates
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
99 * a new tool item to hold it.
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
100 * Subclasses must implement <code>createControl</code> rather than
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
101 * overriding this method.
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
102 */
43
ea8ff534f622 Fix override and super aliases
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
103 public override final void fill(ToolBar parent, int index) {
24
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
104 Control control = createControl(parent);
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
105 ToolItem ti = new ToolItem(parent, DWT.SEPARATOR, index);
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
106 ti.setControl(control);
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
107 ti.setWidth(computeWidth(control));
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
108 }
eb6b3e6de869 ControlContribution
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
109 }