/*
Copyright (c) 2003-2006 THALES.
All rights reserved.
Permission is hereby granted, without written agreement and without
license or royalty fees, to use, copy, modify, and distribute this
software and its documentation for any purpose, provided that the
above copyright notice and the following two paragraphs appear in all
copies of this software.
IN NO EVENT SHALL THALES BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE
OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THALES HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
THALES SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS"
BASIS, AND THALES HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
Created on 01 sept. 2003
*/
package thales.vergil.navigable;
import java.awt.Color;
import javax.swing.JFrame;
import ptolemy.actor.gui.Effigy;
import ptolemy.actor.gui.PtolemyEffigy;
import ptolemy.actor.gui.Tableau;
import ptolemy.actor.gui.TableauFactory;
import ptolemy.kernel.CompositeEntity;
import ptolemy.kernel.util.IllegalActionException;
import ptolemy.kernel.util.NameDuplicationException;
import ptolemy.kernel.util.NamedObj;
import ptolemy.kernel.util.Workspace;
import ptolemy.moml.LibraryAttribute;
import thales.actor.gui.NavigableEffigy;
import thales.vergil.SingleWindowApplication;
//////////////////////////////////////////////////////////////////////////
//// NavigableActorGraphTableau
/**
A simple copy of the ActorGraphFrame with additional functionalities for
navigation
@author Jérôme Blanc & Benoit Masson, Thales Research and Technology, 01 sept. 2003
@version $Id$
@since Ptolemy II 3.1
@Pt.ProposedRating Red (jerome.blanc)
@Pt.AcceptedRating Red (cxh)
*/
public class NavigableActorGraphTableau extends Tableau {
/** Create a tableau in the specified workspace.
* @param workspace The workspace.
*/
public NavigableActorGraphTableau(Workspace workspace)
throws IllegalActionException, NameDuplicationException {
super(workspace);
}
/** Create a tableau with the specified container and name, with
* no specified default library.
* @param container The container.
* @param name The name.
*/
public NavigableActorGraphTableau(PtolemyEffigy container, String name)
throws IllegalActionException, NameDuplicationException {
this(container, name, null);
}
/** Create a tableau with the specified container, name, and
* default library.
* @param container The container.
* @param name The name.
* @param defaultLibrary The default library, or null to not specify one.
*/
public NavigableActorGraphTableau(PtolemyEffigy container, String name,
LibraryAttribute defaultLibrary) throws IllegalActionException,
NameDuplicationException {
super(container, name);
NamedObj model = container.getModel();
if (model == null) {
return;
}
if (!(model instanceof CompositeEntity)) {
throw new IllegalActionException(this,
"Cannot graphically edit a model "
+ "that is not a CompositeEntity. Model is a "
+ model);
}
CompositeEntity entity = (CompositeEntity) model;
NavigableActorGraphFrame frame = new NavigableActorGraphFrame(entity,
this, defaultLibrary);
setFrame(frame);
frame.setBackground(BACKGROUND_COLOR);
}
/* (non-Javadoc)
* @see ptolemy.actor.gui.Tableau#show()
*/
public void show() {
JFrame frame = getFrame();
if (frame != null) {
if (!frame.isVisible()) {
frame.pack();
}
SingleWindowApplication._mainFrame.selectTab(frame.getName());
}
}
///////////////////////////////////////////////////////////////////
//// private members ////
// The background color.
private static Color BACKGROUND_COLOR = new Color(0xe5e5e5);
///////////////////////////////////////////////////////////////////
//// public inner classes ////
/** A factory that creates graph editing tableaux for Ptolemy models.
*/
public static class Factory extends TableauFactory {
/** Create an factory with the given name and container.
* @param container The container.
* @param name The name.
* @exception IllegalActionException If the container is incompatible
* with this attribute.
* @exception NameDuplicationException If the name coincides with
* an attribute already in the container.
*/
public Factory(NamedObj container, String name)
throws IllegalActionException, NameDuplicationException {
super(container, name);
}
/** Create a tableau in the default workspace with no name for the
* given Effigy. The tableau will created with a new unique name
* in the given model effigy. If this factory cannot create a tableau
* for the given effigy (perhaps because the effigy is not of the
* appropriate subclass) then return null.
* It is the responsibility of callers of this method to check the
* return value and call show().
*
* @param effigy The model effigy.
* @return A new ActorGraphTableau, if the effigy is a
* PtolemyEffigy, or null otherwise.
* @exception Exception If an exception occurs when creating the
* tableau.
*/
public Tableau createTableau(Effigy effigy) throws Exception {
if (effigy instanceof NavigableEffigy) {
// First see whether the effigy already contains a RunTableau.
NavigableActorGraphTableau tableau = (NavigableActorGraphTableau) effigy
.getEntity("navigableGraphTableau");
if (tableau == null) {
// Check to see whether this factory contains a
// default library.
LibraryAttribute library = (LibraryAttribute) getAttribute(
"_library", LibraryAttribute.class);
tableau = new NavigableActorGraphTableau(
(PtolemyEffigy) effigy, "navigableGraphTableau",
library);
}
// Don't call show() here, it is called for us in
// TableauFrame.ViewMenuListener.actionPerformed()
return tableau;
} else {
return null;
}
}
}
}