annotate dwtx/jface/dialogs/ControlEnableState.d @ 104:04b47443bb01

Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. These new wrappers now use the tango.util.containers instead of the tango.util.collections.
author Frank Benoit <benoit@tionex.de>
date Thu, 07 Aug 2008 15:01:33 +0200
parents 7615869f89e6
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
1 /*******************************************************************************
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
2 * Copyright (c) 2000, 2006 IBM Corporation and others.
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 *
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * Contributors:
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
9 * IBM Corporation - initial API and implementation
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
10 * Port to the D programming language:
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
11 * Frank Benoit <benoit@tionex.de>
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12 *******************************************************************************/
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
13 module dwtx.jface.dialogs.ControlEnableState;
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16 import dwt.widgets.Composite;
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17 import dwt.widgets.Control;
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 import dwt.dwthelper.utils;
104
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections.
Frank Benoit <benoit@tionex.de>
parents: 18
diff changeset
20 import dwtx.dwtxhelper.Collection;
18
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 /**
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 * Helper class to save the enable/disable state of a control including all its
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 * descendent controls.
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 */
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 public class ControlEnableState {
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 /**
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 * List of exception controls (element type: <code>Control</code>);
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 * <code>null</code> if none.
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 */
104
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections.
Frank Benoit <benoit@tionex.de>
parents: 18
diff changeset
31 private List exceptions = null;
18
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 /**
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 * List of saved states (element type: <code>ItemState</code>).
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 */
104
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections.
Frank Benoit <benoit@tionex.de>
parents: 18
diff changeset
36 private List states;
18
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 /**
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 * Internal class for recording the enable/disable state of a single
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 * control.
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 */
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 private class ItemState {
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43 /** the control */
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44 protected Control item;
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46 /** the state */
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47 protected bool state;
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49 /**
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
50 * Create a new instance of the receiver.
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
51 *
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52 * @param item
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53 * @param state
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
54 */
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
55 public this(Control item, bool state) {
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
56 this.item = item;
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
57 this.state = state;
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
58 }
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
60 /**
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
61 * Restore the enabled state to the original value.
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62 *
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63 */
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
64 public void restore() {
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65 if (item is null || item.isDisposed()) {
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66 return;
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67 }
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
68 item.setEnabled(state);
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
69 }
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70 }
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
71
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72 /**
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
73 * Creates a new object and saves in it the current enable/disable state of
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
74 * the given control and its descendents; the controls that are saved are
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
75 * also disabled.
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
76 *
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
77 * @param w
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
78 * the control
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
79 */
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80 protected this(Control w) {
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
81 this(w, null);
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
82 }
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
83
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
84 /**
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
85 * Creates a new object and saves in it the current enable/disable state of
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
86 * the given control and its descendents except for the given list of
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
87 * exception cases; the controls that are saved are also disabled.
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
88 *
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
89 * @param w
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
90 * the control
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
91 * @param exceptions
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
92 * the list of controls to not disable (element type:
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
93 * <code>Control</code>), or <code>null</code> if none
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
94 */
104
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections.
Frank Benoit <benoit@tionex.de>
parents: 18
diff changeset
95 protected this(Control w, List exceptions) {
18
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
96 // super();
104
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections.
Frank Benoit <benoit@tionex.de>
parents: 18
diff changeset
97 states = new ArrayList();
18
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
98 this.exceptions = exceptions;
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
99 readStateForAndDisable(w);
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
100 }
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
101
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
102 /**
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
103 * Saves the current enable/disable state of the given control and its
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
104 * descendents in the returned object; the controls are all disabled.
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
105 *
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
106 * @param w
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
107 * the control
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
108 * @return an object capturing the enable/disable state
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
109 */
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
110 public static ControlEnableState disable(Control w) {
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
111 return new ControlEnableState(w);
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
112 }
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
113
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
114 /**
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
115 * Saves the current enable/disable state of the given control and its
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
116 * descendents in the returned object except for the given list of exception
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
117 * cases; the controls that are saved are also disabled.
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
118 *
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
119 * @param w
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
120 * the control
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
121 * @param exceptions
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
122 * the list of controls to not disable (element type:
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
123 * <code>Control</code>)
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
124 * @return an object capturing the enable/disable state
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
125 */
104
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections.
Frank Benoit <benoit@tionex.de>
parents: 18
diff changeset
126 public static ControlEnableState disable(Control w, List exceptions) {
18
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
127 return new ControlEnableState(w, exceptions);
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
128 }
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
129
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
130 /**
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
131 * Recursively reads the enable/disable state for the given window and
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
132 * disables all controls.
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
133 * @param control Control
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
134 */
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
135 private void readStateForAndDisable(Control control) {
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
136 if ((exceptions !is null && exceptions.contains(control))) {
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
137 return;
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
138 }
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
139 if (auto c = cast(Composite)control ) {
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
140 Control[] children = c.getChildren();
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
141 for (int i = 0; i < children.length; i++) {
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
142 readStateForAndDisable(children[i]);
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
143 }
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
144 }
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
145 // XXX: Workaround for 1G2Q8SS: ITPUI:Linux - Combo box is not enabled
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
146 // in "File->New->Solution"
104
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections.
Frank Benoit <benoit@tionex.de>
parents: 18
diff changeset
147 states.add(new ItemState(control, control.getEnabled()));
18
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
148 control.setEnabled(false);
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
149 }
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
150
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
151 /**
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
152 * Restores the window enable state saved in this object.
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
153 */
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
154 public void restore() {
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
155 int size = states.size();
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
156 for (int i = 0; i < size; i++) {
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
157 (cast(ItemState) states.get(i)).restore();
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
158 }
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
159 }
7615869f89e6 ControlEnableState
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
160 }