001/*
002 * Copyright (c) 2010 The Regents of the University of California.
003 * All rights reserved.
004 *
005 * '$Author: berkley $'
006 * '$Date: 2010-04-28 00:12:36 +0000 (Wed, 28 Apr 2010) $' 
007 * '$Revision: 24000 $'
008 * 
009 * Permission is hereby granted, without written agreement and without
010 * license or royalty fees, to use, copy, modify, and distribute this
011 * software and its documentation for any purpose, provided that the above
012 * copyright notice and the following two paragraphs appear in all copies
013 * of this software.
014 *
015 * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
016 * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
017 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
018 * THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
019 * SUCH DAMAGE.
020 *
021 * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
022 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
023 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
024 * PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
025 * CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
026 * ENHANCEMENTS, OR MODIFICATIONS.
027 *
028 */
029
030package org.kepler.gui;
031
032import java.awt.Component;
033import java.awt.Window;
034
035import ptolemy.actor.gui.TableauFrame;
036import ptolemy.util.MessageHandler;
037
038/**
039 * A class to hold useful GUI utility methods.
040 */
041public class GUIUtil {
042
043        /**
044         * The getParentWindow method will return the Window that contains the
045         * supplied Component.
046         * 
047         * @param source
048         *      
049         */
050        public static Window getParentWindow(Component source) {
051            return (Window)_getParent(source, Window.class);
052        }
053        
054        /** Get the parent TableauFrame, if any, for a Component. */
055        public static TableauFrame getParentTableauFrame(Component source) {
056            return (TableauFrame)_getParent(source, TableauFrame.class);
057        }
058        
059        /** Get the parent of a Component. */
060        private static Component _getParent(Component source, Class<?> clazz) {
061                int recursionCount = 0;
062                while (!clazz.isInstance(source)) {
063                        source = (Component) source.getParent();
064                        recursionCount++;
065                        if (source == null || recursionCount > 20) {
066                                try {
067                                        MessageHandler.error("Window containing Component ("
068                                                        + source.toString() + ") not found");
069                                } catch (Exception ce) {
070                                        // Do nothing
071                                }
072                                return null;
073                        }
074                }
075                return (Window) source;
076        }
077
078}