annotate dwtx/jface/resource/LocalResourceManager.d @ 9:6c14e54dfc11

completed /jface/resource/
author Frank Benoit <benoit@tionex.de>
date Sat, 29 Mar 2008 02:25:12 +0100
parents
children ea8ff534f622
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
1 /*******************************************************************************
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
2 * Copyright (c) 2004, 2006 IBM Corporation and others.
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 *
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * Contributors:
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
9 * IBM Corporation - initial API and implementation
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
10 * Port to the D programming language:
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
11 * Frank Benoit <benoit@tionex.de>
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12 *******************************************************************************/
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
13 module dwtx.jface.resource.LocalResourceManager;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15 import dwtx.jface.resource.AbstractResourceManager;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16 import dwtx.jface.resource.ResourceManager;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17 import dwtx.jface.resource.DeviceResourceDescriptor;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 import dwt.events.DisposeEvent;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 import dwt.events.DisposeListener;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 import dwt.graphics.Device;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 import dwt.graphics.Image;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 import dwt.widgets.Control;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 import dwt.dwthelper.utils;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 /**
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 * A local registry that shares its resources with some global registry.
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 * LocalResourceManager is typically used to safeguard against leaks. Clients
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 * can use a nested registry to allocate and deallocate resources in the
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 * global registry. Calling dispose() on the nested registry will deallocate
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 * everything allocated for the nested registry without affecting the rest
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 * of the global registry.
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 * <p>
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 * A nested registry can be used to manage the resources for, say, a dialog
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 * box.
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 * </p>
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 * @since 3.1
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 */
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 public final class LocalResourceManager : AbstractResourceManager {
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 private ResourceManager parentRegistry;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44 /**
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 * Creates a local registry that delegates to the given global registry
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46 * for all resource allocation and deallocation.
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47 *
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48 * @param parentRegistry global registry
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49 */
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
50 public this(ResourceManager parentRegistry) {
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
51 this.parentRegistry = parentRegistry;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52 }
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
54 /**
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
55 * Creates a local registry that wraps the given global registry. Anything
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
56 * allocated by this registry will be automatically cleaned up with the given
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
57 * control is disposed. Note that registries created in this way should not
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
58 * be used to allocate any resource that must outlive the given control.
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59 *
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
60 * @param parentRegistry global registry that handles resource allocation
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
61 * @param owner control whose disposal will trigger cleanup of everything
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62 * in the registry.
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63 */
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
64 public this(ResourceManager parentRegistry, Control owner) {
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65 this(parentRegistry);
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67 owner.addDisposeListener(new class DisposeListener {
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
68 /* (non-Javadoc)
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
69 * @see dwt.events.DisposeListener#widgetDisposed(dwt.events.DisposeEvent)
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70 */
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
71 public void widgetDisposed(DisposeEvent e) {
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72 this.outer.dispose();
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
73 }
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
74 });
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
75 }
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
76
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
77 /* (non-Javadoc)
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
78 * @see dwtx.jface.resource.ResourceManager#getDevice()
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
79 */
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80 public Device getDevice() {
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
81 return parentRegistry.getDevice();
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
82 }
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
83
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
84 /* (non-Javadoc)
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
85 * @see dwtx.jface.resource.AbstractResourceManager#allocate(dwtx.jface.resource.DeviceResourceDescriptor)
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
86 */
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
87 protected Object allocate(DeviceResourceDescriptor descriptor) {
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
88 return parentRegistry.create(descriptor);
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
89 }
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
90
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
91 /* (non-Javadoc)
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
92 * @see dwtx.jface.resource.AbstractResourceManager#deallocate(java.lang.Object, dwtx.jface.resource.DeviceResourceDescriptor)
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
93 */
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
94 protected void deallocate(Object resource,
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
95 DeviceResourceDescriptor descriptor) {
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
96
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
97 parentRegistry.destroy(descriptor);
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
98 }
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
99
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
100 /* (non-Javadoc)
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
101 * @see dwtx.jface.resource.ResourceManager#getDefaultImage()
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
102 */
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
103 protected Image getDefaultImage() {
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
104 return parentRegistry.getDefaultImage_();
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
105 }
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
106 }