001/*
002
003 Copyright (c) 2008-2009 The Regents of the University of California.
004 All rights reserved.
005 Permission is hereby granted, without written agreement and without
006 license or royalty fees, to use, copy, modify, and distribute this
007 software and its documentation for any purpose, provided that the above
008 copyright notice and the following two paragraphs appear in all copies
009 of this software.
010
011 IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
012 FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
013 ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
014 THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
015 SUCH DAMAGE.
016
017 THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
018 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
019 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
020 PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
021 CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
022 ENHANCEMENTS, OR MODIFICATIONS.
023
024 PT_COPYRIGHT_VERSION_2
025 COPYRIGHTENDKEY
026
027 */
028
029package ptolemy.actor.gui;
030
031import javax.swing.Box;
032
033import ptolemy.kernel.util.IllegalActionException;
034import ptolemy.kernel.util.Settable;
035
036/**
037 * An interface for Parameter classes that supply their own
038 * customized GUI element for modifying the query content.
039 *
040 * <p>See <a href="http://www.scms.waikato.ac.nz/~fracpete/downloads/ptolemy/custom_query_boxes/" target="_top">http://www.scms.waikato.ac.nz/~fracpete/downloads/ptolemy/custom_query_boxes/</a>
041 *
042 * @author  fracpete (fracpete at waikato dot ac dot nz)
043 * @version $Revision$
044 * @since Ptolemy II 8.0
045 * @Pt.ProposedRating Red (cxh)
046 * @Pt.AcceptedRating Red (cxh)
047 */
048public interface CustomQueryBoxParameter {
049
050    /**
051     * Create a customized query box for the given query.
052     *
053     * @param query                        the query to add the custom box to
054     * @param attribute                        the attribute the query box is associated with
055     * @return a query box.
056     * @exception IllegalActionException         if something goes wrong
057     */
058    public Box createQueryBox(PtolemyQuery query, Settable attribute)
059            throws IllegalActionException;
060}