org.tango.pogo.gui.MultiClassesTree Maven / Gradle / Ivy
The newest version!
//+======================================================================
// $Source: $
//
// Project: Tango
//
// Description: java source code for display JTree
//
// $Author: pascal_verdier $
//
// Copyright (C) : 2004,2005,2006,2007,2008,2009,2009,2010,2011,2012,2013,2014
// European Synchrotron Radiation Facility
// BP 220, Grenoble 38043
// FRANCE
//
// This file is part of Tango.
//
// Tango is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Tango is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Tango. If not, see notFoundClassList = new ArrayList<>();
private EditClasses editedClasses = new EditClasses();
private boolean modified = false;
private LoadedClasses loadedClasses = new LoadedClasses();
private static JFileChooser chooser = null;
private static final Color background = Color.white;
//===============================================================
//===============================================================
public MultiClassesTree(JFrame parent, PogoMultiClasses multiClasses) throws PogoException {
super();
this.parent = parent;
initComponents();
buildTree(new TangoServer(multiClasses));
createClassNodes(root, multiClasses.getClasses());
expandChildren(root);
setSelectionPath(null);
}
//===============================================================
//===============================================================
public MultiClassesTree(JFrame parent, TangoServer server) {
super();
this.parent = parent;
initComponents();
buildTree(server);
}
//===============================================================
//===============================================================
private void initComponents() {
String homeDir = System.getenv("SOURCE_PATH");
if (homeDir == null) {
homeDir = System.getProperty("SOURCE_PATH");
if (homeDir == null)
homeDir = new File("").getAbsolutePath();
}
chooser = new JFileChooser(new File(homeDir).getAbsolutePath());
chooser.setFileFilter(PogoGUI.pogoFilter);
menu = new MultiClassesTreePopupMenu(this);
setBackground(background);
}
//===============================================================
//===============================================================
private void buildTree(TangoServer server) {
// Create the nodes.
root = new DefaultMutableTreeNode(server);
// Create the tree that allows one selection at a time.
getSelectionModel().setSelectionMode
(TreeSelectionModel.SINGLE_TREE_SELECTION);
// Create Tree and Tree model
treeModel = new DefaultTreeModel(root);
setModel(treeModel);
//Enable tool tips.
ToolTipManager.sharedInstance().registerComponent(this);
// Set the icon for leaf nodes.
TangoRenderer renderer = new TangoRenderer();
setCellRenderer(renderer);
// Listen for collapse tree
addTreeExpansionListener(new TreeExpansionListener() {
public void treeCollapsed(TreeExpansionEvent e) {
//collapsedPerformed(e);
}
public void treeExpanded(TreeExpansionEvent e) {
//expandedPerformed(e);
}
});
// Add Action listener
addMouseListener(new MouseAdapter() {
/*
public void mousePressed (MouseEvent evt) {
treeMousePressed (evt); // for Drag
}
public void mouseReleased (MouseEvent evt) {
treeMouseReleased (evt); // for Drop
}
*/
public void mouseClicked(MouseEvent evt) {
treeMouseClicked(evt); // for tree clicked, menu,...
}
});
}
//======================================================
/**
* Manage event on clicked mouse on JTree object.
*
* @param event the mouse event
*/
//======================================================
private void treeMouseClicked(MouseEvent event) {
// Set selection at mouse position
TreePath selectedPath = getPathForLocation(event.getX(), event.getY());
if (selectedPath == null)
return;
DefaultMutableTreeNode node =
(DefaultMutableTreeNode) selectedPath.getPathComponent(selectedPath.getPathCount() - 1);
Object userObject = node.getUserObject();
// Check button clicked
if (notFoundClassList.isEmpty()) {
if ((event.getModifiers() & MouseEvent.BUTTON3_MASK) != 0) {
if (node == root)
menu.showMenu(event, (TangoServer) userObject);
else if (userObject instanceof DeviceClass)
menu.showMenu(event, (DeviceClass) userObject);
}
}
}
//===============================================================
//===============================================================
private DeviceClass loadDeviceClass(OneClassSimpleDef simpleClass) throws PogoException {
String xmiFileName = simpleClass.getSourcePath() + "/" + simpleClass.getClassname() + ".xmi";
DeviceClass deviceClass = null;
File xmiFile = new File(xmiFileName);
try {
if (!xmiFile.exists()) {
// Check with relative path converted as absolute one
// Get multi classes file as reference
TangoServer server = (TangoServer) root.getUserObject();
String serverPath = server.sourcePath;
String absolute = Utils.getCanonicalPath(xmiFileName, serverPath);
xmiFile = new File(absolute);
if (!xmiFile.exists())
throw new PogoException("No such file: " + xmiFileName);
}
deviceClass = loadedClasses.getDeviceClass(xmiFile.getAbsolutePath());
if (!deviceClass.getPogoDeviceClass().getName().equals(simpleClass.getClassname()))
throw new PogoException(simpleClass.getClassname() + " file expected !");
} catch (PogoException e) {
e.popup(this);
// Display chooser to select a new path
chooser.setDialogTitle("Class: " + simpleClass.getClassname() + " ?");
if (chooser.showOpenDialog(this) == JFileChooser.APPROVE_OPTION) {
xmiFile = chooser.getSelectedFile();
if (xmiFile.exists())
deviceClass = loadedClasses.getDeviceClass(xmiFile.getAbsolutePath());
}
}
return deviceClass;
}
//===============================================================
//===============================================================
private void createClassNodes(DefaultMutableTreeNode parentNode, EList classes)
throws PogoException {
String parentName = (parentNode == root) ? "root" : parentNode.toString();
for (OneClassSimpleDef _class : classes) {
EList parentClasses = _class.getParentClasses();
if (parentClasses.size() == 0)
parentClasses.add("root");
for (String parentClass : parentClasses) {
if (parentClass.equals(parentName)) {
DeviceClass deviceClass = loadDeviceClass(_class);
DefaultMutableTreeNode node;
if (deviceClass!=null) {
node = new DefaultMutableTreeNode(deviceClass);
}
else {
System.out.println(_class.getClassname() + " not found");
NotFoundClass notFoundClass = new NotFoundClass(_class);
node = new DefaultMutableTreeNode(notFoundClass);
notFoundClassList.add(notFoundClass);
}
parentNode.add(node);
createClassNodes(node, classes);
}
}
}
}
//======================================================
//======================================================
private DefaultMutableTreeNode getSelectedNode() {
return (DefaultMutableTreeNode) getLastSelectedPathComponent();
}
//======================================================
//======================================================
Object getSelectedObject() {
DefaultMutableTreeNode node = getSelectedNode();
if (node == null)
return null;
return node.getUserObject();
}
//===============================================================
//===============================================================
private void expandChildren(DefaultMutableTreeNode node) {
boolean level_done = false;
for (int i = 0; i < node.getChildCount(); i++) {
DefaultMutableTreeNode child =
(DefaultMutableTreeNode) node.getChildAt(i);
if (child.isLeaf()) {
if (!level_done) {
expandNode(child);
level_done = true;
}
} else
expandChildren(child);
}
}
//===============================================================
//===============================================================
private void expandNode(DefaultMutableTreeNode node) {
List v = new ArrayList<>();
v.add(node);
while (node != root) {
node = (DefaultMutableTreeNode) node.getParent();
v.add(0, node);
}
TreeNode[] tn = new DefaultMutableTreeNode[v.size()];
for (int i = 0; i < v.size(); i++)
tn[i] = v.get(i);
TreePath tp = new TreePath(tn);
setSelectionPath(tp);
scrollPathToVisible(tp);
}
//===============================================================
//===============================================================
private void editSelectedClass() {
Object obj = getSelectedObject();
if (obj instanceof DeviceClass) {
try {
editedClasses.addClass((DeviceClass) obj);
} catch (PogoException e) {
e.popup(this);
}
}
}
//===============================================================
//===============================================================
boolean allEditorsAreClosed() {
return editedClasses.everythingClosed();
}
//===============================================================
//===============================================================
private void editServer() {
TangoServer server = (TangoServer) root.getUserObject();
ServerDialog serverDialog = new ServerDialog(parent, server);
if (serverDialog.showDialog() == JOptionPane.OK_OPTION)
setModified(true);
}
//===============================================================
//===============================================================
public boolean getModified() {
return modified;
}
//===============================================================
//===============================================================
public void setModified(boolean b) {
modified = b;
}
//===============================================================
//===============================================================
public boolean isANodeSelected() {
return (getSelectedNode() != null);
}
//===============================================================
//===============================================================
public boolean isAClassSelected() {
Object obj = getSelectedObject();
return (obj instanceof DeviceClass);
}
//===============================================================
//===============================================================
public void addClass() {
try {
// Display chooser to select a new path
if (chooser.showOpenDialog(this) == JFileChooser.APPROVE_OPTION) {
File file = chooser.getSelectedFile();
DeviceClass deviceClass = loadedClasses.getDeviceClass(file.getAbsolutePath());
// Check if C++ class.
String language =
deviceClass.getPogoDeviceClass().getDescription().getLanguage();
if (language.toLowerCase().equals("cpp")) {
DefaultMutableTreeNode parentNode = getSelectedNode();
DefaultMutableTreeNode node = new DefaultMutableTreeNode(deviceClass);
treeModel.insertNodeInto(node, parentNode, parentNode.getChildCount());
setModified(true);
expandChildren(parentNode);
} else
throw new PogoException(language +
" classes are not supported by multi classes manager !");
}
} catch (PogoException e) {
e.popup(this);
}
}
//===============================================================
//===============================================================
public void removeClass() {
DefaultMutableTreeNode node = getSelectedNode();
if (JOptionPane.showConfirmDialog(this,
"Remove " + node.getUserObject() + " class ?",
"Confirmation Window",
JOptionPane.YES_NO_OPTION) == JOptionPane.OK_OPTION) {
treeModel.removeNodeFromParent(node);
setModified(true);
}
}
//===============================================================
//===============================================================
public void moveNode(boolean up) {
DefaultMutableTreeNode node = getSelectedNode();
DefaultMutableTreeNode parentNode = (DefaultMutableTreeNode) node.getParent();
int pos = 0;
for (int i = 0; i < parentNode.getChildCount(); i++)
if (parentNode.getChildAt(i).equals(node))
pos = i;
// get position min and max (special case for commands state and status)
int pos_min = 0;
int pos_max = parentNode.getChildCount() - 1;
if (up) {
// MOve Up
if (pos > pos_min) {
treeModel.removeNodeFromParent(node);
treeModel.insertNodeInto(node, parentNode, pos - 1);
setModified(true);
}
} else {
// Move Down
if (pos < pos_max) {
treeModel.removeNodeFromParent(node);
treeModel.insertNodeInto(node, parentNode, pos + 1);
setModified(true);
}
}
}
//===============================================================
//===============================================================
public boolean pasteAvailable() {
return (isANodeSelected() && copiedClass != null);
}
//===============================================================
//===============================================================
public void copySelectedClass() {
Object obj = getSelectedObject();
if (obj instanceof DeviceClass)
copiedClass = (DeviceClass) obj;
}
//===============================================================
//===============================================================
public void pasteClass() {
DefaultMutableTreeNode node = new DefaultMutableTreeNode(copiedClass);
DefaultMutableTreeNode parentNode = getSelectedNode();
treeModel.insertNodeInto(node, parentNode, parentNode.getChildCount());
setModified(true);
expandChildren(parentNode);
}
//===============================================================
//===============================================================
private List getClasses(DefaultMutableTreeNode node) {
List classes = new ArrayList<>();
for (int i = 0; i < node.getChildCount(); i++) {
DefaultMutableTreeNode childNode =
(DefaultMutableTreeNode) node.getChildAt(i);
DeviceClass _class = (DeviceClass) childNode.getUserObject();
classes.add(_class);
if (node != root) {
_class.addParentClass(node.getUserObject().toString());
}
List children = getClasses(childNode);
classes.addAll(children);
}
return classes;
}
//===============================================================
//===============================================================
public String getServerFileName() {
TangoServer server = (TangoServer) root.getUserObject();
if (server.sourcePath != null)
return server.sourcePath + "/" + server.name + ".multi.xmi";
else
return null;
}
//===============================================================
//===============================================================
public String getAuthor() {
if (loadedClasses.isEmpty())
return "? ? ?";
else {
// Return the any class author name
return PackUtils.buildMailAddress(loadedClasses.getAny().getPogoDeviceClass().getDescription());
}
}
//===============================================================
//===============================================================
public PogoMultiClasses getServer() {
// Check if all classes have been loaded
if (!notFoundClassList.isEmpty()) {
StringBuilder sb = new StringBuilder("Class" + (notFoundClassList.size()>1 ? "es " : " "));
for (NotFoundClass _class : notFoundClassList)
sb.append(_class.name).append(',');
sb.append(" not correctly loaded\n\nReload fully before change and save");
new PogoException(sb.toString()).popup(this);
return null;
}
// OK. All classes loaded. Can build server object
loadedClasses.resetParentClasses();
TangoServer server = (TangoServer) root.getUserObject();
// Get all classes from JTree objects
List classes = getClasses(root);
List pogoClasses = new ArrayList<>();
// Check to have class only once.
// Start by the end to be sure the leaves are at the end.
for (int i=classes.size()-1 ; i >= 0 ; i--) {
DeviceClass _class = classes.get(i);
// Check if already in final vector
boolean exists = false;
String name = _class.getPogoDeviceClass().getName();
for (DeviceClass pogoClass : pogoClasses) {
if (pogoClass.getPogoDeviceClass().getName().equals(name)) {
exists = true;
}
}
if (!exists) {
pogoClasses.add(0, _class);
}
}
for (DeviceClass pc : pogoClasses) {
System.out.println(pc.getPogoDeviceClass().getName());
}
PogoMultiClasses multiClasses = buildPogoMultiClassesObject(server.name, pogoClasses);
multiClasses.setName(server.name);
multiClasses.setDescription(server.description);
multiClasses.setSourcePath(server.sourcePath);
return multiClasses;
}
//========================================================================
//========================================================================
private PogoMultiClasses buildPogoMultiClassesObject(String name, List classes) {
// Build Multi classes object
PogoMultiClasses multiClasses = OAWutils.factory.createPogoMultiClasses();
multiClasses.setName(name);
// copy preferences for Makefile environment
Preferences pref = OAWutils.factory.createPreferences();
pref.setMakefileHome(PogoProperty.makefileHome);
multiClasses.setPreferences(pref);
EList definitions = multiClasses.getClasses();
for (DeviceClass devClass : classes) {
PogoDeviceClass pogoClass = devClass.getPogoDeviceClass();
// Convert to simple class def
OneClassSimpleDef simple = OAWutils.factory.createOneClassSimpleDef();
simple.setClassname(pogoClass.getName());
simple.setSourcePath(pogoClass.getDescription().getSourcePath());
for (String parentClass : devClass.getParentClasses()) {
simple.getParentClasses().add(parentClass);
}
// Check if dynamic attributes
// ToDo
if (Utils.getInstance().getPogoGuiRevision() >= 8.1) {
if (pogoClass.getDynamicAttributes().size()>0 ||
pogoClass.getDynamicCommands().size()>0) {
simple.setHasDynamic("true");
}
}
definitions.add(simple);
// Copy inheritances
EList multiInheritances = simple.getInheritances();
EList monoInheritances = pogoClass.getDescription().getInheritances();
for (Inheritance monoInheritance : monoInheritances) {
Inheritance multiInheritance = OAWutils.factory.createInheritance();
multiInheritance.setClassname(monoInheritance.getClassname());
multiInheritance.setSourcePath(monoInheritance.getSourcePath());
multiInheritances.add(OAWutils.cloneInheritance(monoInheritance));
}
// Copy additional files
EList multiAdditional = simple.getAdditionalFiles();
EList monoAdditional = pogoClass.getAdditionalFiles();
for (AdditionalFile monoFile : monoAdditional) {
multiAdditional.add(OAWutils.cloneAdditionalFile(monoFile));
}
}
return multiClasses;
}
//===============================================================
//===============================================================
public String getName() {
return root.getUserObject().toString();
}
//===============================================================
//===============================================================
//===============================================================
/**
* A cache of DeviceClasses.
*/
//===============================================================
private static class LoadedClasses {
private final Map deviceClasses = new HashMap<>();
DeviceClass getAny() {
return deviceClasses.values().iterator().next();
}
boolean isEmpty() {
return deviceClasses.size() == 0;
}
//===========================================================
DeviceClass getDeviceClass(String xmiFileName) throws PogoException {
DeviceClass result = deviceClasses.get(xmiFileName);
if (result == null) deviceClasses.put(xmiFileName, result = new DeviceClass(xmiFileName));
return result;
}
//===========================================================
void resetParentClasses() {
for (DeviceClass dc : deviceClasses.values()) {
dc.resetParentClasses();
}
}
//===========================================================
}
//===============================================================
//===============================================================
//===============================================================
/**
* A class to manage PogoGUI instances.
*/
//===============================================================
private class EditClasses extends ArrayList {
//===========================================================
private void addClass(DeviceClass _class) throws PogoException {
for (PogoGUI pogo : this) {
if (pogo.getMainClassName().equals(_class.toString())) {
pogo.setVisible(true);
return;
}
}
add(new PogoGUI(_class, false));
// Check if first to set position
if (size() == 1) {
Point p = parent.getLocation();
p.x += parent.getWidth();
p.y -= 50;
get(0).setLocation(p);
}
}
//===========================================================
private boolean everythingClosed() {
for (PogoGUI pogo : this) {
if (pogo.isVisible())
return false;
}
return true;
}
//===========================================================
}
//===============================================================
//===============================================================
//===============================================================
//===============================================================
private static class NotFoundClass {
private String name;
private String path;
private NotFoundClass(OneClassSimpleDef _class) {
name = _class.getClassname();
path = _class.getSourcePath();
}
public String toString() {
return name;
}
}
//===============================================================
//===============================================================
private static final Font rootFont = new Font("Dialog", Font.BOLD, 18);
private static final Font classFont = new Font("Dialog", Font.BOLD, 14);
private static final ImageIcon classIcon = Utils.getInstance().getIcon("TangoClass.gif", 0.17);
private static final ImageIcon warnClassIcon = Utils.getInstance().getIcon("TangoClassWarning.gif", 0.17);
//===============================================================
/**
* Renderer Class
*/
//===============================================================
private static class TangoRenderer extends DefaultTreeCellRenderer {
//===============================================================
//===============================================================
public Component getTreeCellRendererComponent(
JTree tree,
Object obj,
boolean sel,
boolean expanded,
boolean leaf,
int row,
boolean hasFocus) {
super.getTreeCellRendererComponent(
tree, obj, sel,
expanded, leaf, row,
hasFocus);
setBackgroundNonSelectionColor(background);
setForeground(Color.black);
setBackgroundSelectionColor(Color.lightGray);
DefaultMutableTreeNode node = (DefaultMutableTreeNode) obj;
if (row == 0) {
// ROOT
setFont(rootFont);
setIcon(Utils.getInstance().rootIcon);
TangoServer tangoServer = (TangoServer) node.getUserObject();
setToolTipText(Utils.buildToolTip(tangoServer.name, tangoServer.description));
} else {
setFont(classFont);
if (node.getUserObject() instanceof DeviceClass) {
DeviceClass deviceClass = (DeviceClass) node.getUserObject();
setIcon(classIcon);
setToolTipText(Utils.buildToolTip(deviceClass.getPogoDeviceClass().getName(),
"loaded from:\n " + deviceClass.getPogoDeviceClass().getDescription().getSourcePath()));
}
else
if (node.getUserObject() instanceof NotFoundClass) {
NotFoundClass notFoundClass = (NotFoundClass) node.getUserObject();
setIcon(warnClassIcon);
setToolTipText(Utils.buildToolTip(notFoundClass.name,
"Cannot load class from:\n " + notFoundClass.path));
}
else
setIcon(classIcon);
}
return this;
}
}// End of Renderer Class
//===============================================================
//===============================================================
private DeviceClass copiedClass = null;
//==============================================================================
//==============================================================================
static private final int EDIT_SERVER = 0;
static private final int EDIT_CLASS = 1;
static private final int ADD_CLASS = 2;
static private final int COPY_CLASS = 3;
static private final int PASTE_CLASS = 4;
static private final int REMOVE_CLASS = 5;
static private final int MOVE_UP = 6;
static private final int MOVE_DOWN = 7;
static private final int LOAD_CLASS = 8;
static private final int OFFSET = 2; // Label And separator
static private String[] menuLabels = {
"Edit Server",
"Edit class",
"Add class",
"Copy class",
"Paste class",
"Remove class",
"Move up",
"Move down",
"Load class",
};
private class MultiClassesTreePopupMenu extends JPopupMenu {
private JTree tree;
private JLabel title;
private MultiClassesTreePopupMenu(JTree tree) {
this.tree = tree;
buildBtnPopupMenu();
}
//=======================================================
/**
* Create a Popup menu for host control
*/
//=======================================================
private void buildBtnPopupMenu() {
title = new JLabel();
title.setFont(new java.awt.Font("Dialog", Font.BOLD, 16));
add(title);
add(new JPopupMenu.Separator());
for (String menuLabel : menuLabels) {
JMenuItem btn = new JMenuItem(menuLabel);
btn.addActionListener(this::hostActionPerformed);
add(btn);
}
}
//======================================================
private boolean checkSelection(MouseEvent event) {
// Set selection at mouse position
TreePath selectedPath = tree.getPathForLocation(event.getX(), event.getY());
if (selectedPath != null)
tree.setSelectionPath(selectedPath);
return selectedPath != null;
}
//======================================================
/*
* Show menu on root
*/
//======================================================
private void showMenu(MouseEvent event, TangoServer pmc) {
if (checkSelection(event)) {
title.setText(pmc.toString());
// Reset all items
for (int i = 0 ; i © 2015 - 2025 Weber Informatics LLC | Privacy Policy