skrueger/swing/DialogManager.java

package skrueger.swing;

import java.awt.Component;
import java.awt.event.WindowAdapter;
import java.awt.event.WindowEvent;
import java.util.HashMap;
import java.util.HashSet;

import javax.swing.JDialog;

import org.apache.log4j.Logger;

public abstract class DialogManager<KEY, DIALOG extends JDialog> {
        final static private Logger LOGGER = Logger.getLogger(DialogManager.class);

        public abstract class FactoryInterface {

                public abstract DIALOG create();

        }

        private HashMap<KEY, DIALOG> dialogCache = new HashMap<KEY, DIALOG>();

        /**
         * A {@link DialogManager} instance can be created for any extension of
         * {@link JDialog} that will implement the
         * {@link #getInstanceFor(Object, Component, Object...)} method.
         */
        public DialogManager() {
        }

        /**
         * This will be done with every dialog that an instance is required for.
         * 
         * @param dialog
         * @return
         */
        protected DIALOG bringup(DIALOG dialog) {
                if (!dialog.isVisible())
                        dialog.setVisible(true);
                dialog.toFront();

                return dialog;
        }

        public abstract DIALOG getInstanceFor(final KEY key, final Component owner,
                        final Object... constArgs);

        /**
         * @return Is there an open/visible dialog for the given layer id?
         */
        public boolean isVisibleFor(KEY key) {
                return dialogCache.containsKey(key) && dialogCache.get(key).isVisible();
        }

        /**
         * Will dispose any dialog that is registered to the given parent
         * {@link Component}
         * 
         * @param parent
         */
        public void disposeInstanceForParent(final Component parent) {

                final HashMap<KEY, JDialog> clonedHashMap = (HashMap<KEY, JDialog>) dialogCache
                                .clone();

                for (KEY chartId : clonedHashMap.keySet()) {
                        if (dialogCache.get(chartId).getParent() == parent) {
                                disposeInstanceFor(chartId);
                        }
                }
        }

        public boolean disposeInstanceFor(KEY chartId) {
                synchronized (dialogCache) {

                        final DIALOG dialog = dialogCache.get(chartId);
                        if (dialog != null) {
                                dialog.dispose();
                                dialogCache.remove(chartId);
                                return true;
                        }
                        return false;
                }
        }

        /**
         * Checks whether there already is an instance for that key and otherwise
         * will create the instance by invoking the {@link FactoryInterface} #create
         * method.
         * 
         * @param factory
         *            {@link FactoryInterface} that creates the DIALOG
         * 
         * @return Always a visible and inFront instance of DIALOG for the given
         *         key.
         */
        public DIALOG getInstanceFor(final KEY key, FactoryInterface factory) {
                DIALOG dialog;
                if (isVisibleFor(key)) {
                        dialog = dialogCache.get(key);
                } else {

                        dialog = factory.create();

                        dialogCache.put(key, dialog);

                        dialog.addWindowListener(new WindowAdapter() {
                                @Override
                                public void windowClosed(final WindowEvent e) {
                                        disposeInstanceFor(key);
                                }
                        });
                }
                return dialog;
        }

        /**
         * Disposes all open instances and removes them from the cache.
         * 
         * @return <code>true</code> if at least one window has been disposed.
         */
        public boolean disposeAll() {

                boolean atLeastOne = false;
                HashSet<KEY> tempKeys = new HashSet<KEY>(dialogCache.keySet());
                for (KEY key : tempKeys) {
                        DIALOG dialog = dialogCache.get(key);
                        if (dialog != null) {
                                dialog.dispose();
                                atLeastOne = true;
                        }
                }
                tempKeys.clear();
                dialogCache.clear();
                return atLeastOne;
        }

}
1	alfonx	420	package skrueger.swing;
2
3			import java.awt.Component;
4			import java.awt.event.WindowAdapter;
5			import java.awt.event.WindowEvent;
6			import java.util.HashMap;
7			import java.util.HashSet;
8
9			import javax.swing.JDialog;
10
11			import org.apache.log4j.Logger;
12
13	alfonx	421	public abstract class DialogManager<KEY, DIALOG extends JDialog> {
14			final static private Logger LOGGER = Logger.getLogger(DialogManager.class);
15	alfonx	420
16			public abstract class FactoryInterface {
17
18			public abstract DIALOG create();
19
20			}
21
22			private HashMap<KEY, DIALOG> dialogCache = new HashMap<KEY, DIALOG>();
23
24	alfonx	421	/**
25			* A {@link DialogManager} instance can be created for any extension of
26			* {@link JDialog} that will implement the
27			* {@link #getInstanceFor(Object, Component, Object...)} method.
28			*/
29	alfonx	420	public DialogManager() {
30			}
31
32			/**
33			* This will be done with every dialog that an instance is required for.
34			*
35			* @param dialog
36			* @return
37			*/
38			protected DIALOG bringup(DIALOG dialog) {
39			if (!dialog.isVisible())
40			dialog.setVisible(true);
41			dialog.toFront();
42
43			return dialog;
44			}
45
46			public abstract DIALOG getInstanceFor(final KEY key, final Component owner,
47			final Object... constArgs);
48
49			/**
50			* @return Is there an open/visible dialog for the given layer id?
51			*/
52			public boolean isVisibleFor(KEY key) {
53			return dialogCache.containsKey(key) && dialogCache.get(key).isVisible();
54			}
55
56			/**
57			* Will dispose any dialog that is registered to the given parent
58			* {@link Component}
59			*
60			* @param parent
61			*/
62			public void disposeInstanceForParent(final Component parent) {
63
64			final HashMap<KEY, JDialog> clonedHashMap = (HashMap<KEY, JDialog>) dialogCache
65			.clone();
66
67			for (KEY chartId : clonedHashMap.keySet()) {
68			if (dialogCache.get(chartId).getParent() == parent) {
69			disposeInstanceFor(chartId);
70			}
71			}
72			}
73
74			public boolean disposeInstanceFor(KEY chartId) {
75			synchronized (dialogCache) {
76
77			final DIALOG dialog = dialogCache.get(chartId);
78			if (dialog != null) {
79			dialog.dispose();
80	alfonx	421	dialogCache.remove(chartId);
81	alfonx	420	return true;
82			}
83			return false;
84			}
85			}
86
87			/**
88			* Checks whether there already is an instance for that key and otherwise
89			* will create the instance by invoking the {@link FactoryInterface} #create
90			* method.
91			*
92			* @param factory
93			* {@link FactoryInterface} that creates the DIALOG
94			*
95	alfonx	421	* @return Always a visible and inFront instance of DIALOG for the given
96			* key.
97	alfonx	420	*/
98			public DIALOG getInstanceFor(final KEY key, FactoryInterface factory) {
99			DIALOG dialog;
100			if (isVisibleFor(key)) {
101			dialog = dialogCache.get(key);
102			} else {
103
104			dialog = factory.create();
105
106			dialogCache.put(key, dialog);
107
108			dialog.addWindowListener(new WindowAdapter() {
109			@Override
110			public void windowClosed(final WindowEvent e) {
111			disposeInstanceFor(key);
112			}
113			});
114			}
115			return dialog;
116			}
117
118			/**
119	alfonx	421	* Disposes all open instances and removes them from the cache.
120	alfonx	420	*
121			* @return <code>true</code> if at least one window has been disposed.
122			*/
123			public boolean disposeAll() {
124	alfonx	421
125	alfonx	420	boolean atLeastOne = false;
126			HashSet<KEY> tempKeys = new HashSet<KEY>(dialogCache.keySet());
127			for (KEY key : tempKeys) {
128	alfonx	421	DIALOG dialog = dialogCache.get(key);
129	alfonx	420	if (dialog != null) {
130			dialog.dispose();
131			atLeastOne = true;
132			}
133			}
134			tempKeys.clear();
135			dialogCache.clear();
136			return atLeastOne;
137			}
138	alfonx	421
139	alfonx	420	}
Name	Value
svn:eol-style	native
svn:keywords	Id URL
svn:mime-type	text/plain