/* Copyright (c) 2006, 2007, The Cytoscape Consortium (www.cytoscape.org) The Cytoscape Consortium is: - Institute for Systems Biology - University of California San Diego - Memorial Sloan-Kettering Cancer Center - Institut Pasteur - Agilent Technologies This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or any later version. This library 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. The software and documentation provided hereunder is on an "as is" basis, and the Institute for Systems Biology and the Whitehead Institute have no obligations to provide maintenance, support, updates, enhancements or modifications. In no event shall the Institute for Systems Biology and the Whitehead Institute be liable to any party for direct, indirect, special, incidental or consequential damages, including lost profits, arising out of the use of this software and its documentation, even if the Institute for Systems Biology and the Whitehead Institute have been advised of the possibility of such damage. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. */ package cytoscape.util.swing; import java.awt.Color; import java.awt.event.ActionEvent; import java.util.Arrays; import javax.swing.DefaultListModel; import javax.swing.Icon; import javax.swing.JPanel; import cytoscape.Cytoscape; import cytoscape.data.CyAttributes; import cytoscape.data.attr.MultiHashMapDefinitionListener; /** * General GUI component for importing attributes.
* Maybe used by Web Service Clients to import attributes. * * This UI accepts title and icon. Usually, those are from source database. * * @author kono * @since Cytoscape 2.6 * @version 0.5 * */ public abstract class AttributeImportPanel extends JPanel implements MultiHashMapDefinitionListener { private static final long serialVersionUID = 876173290119736978L; /** * Will be caught by parent object (usually a dialog.) */ public static final String CLOSE_EVENT = "CLOSE"; // Default title of this panel. private static final String DEF_TITLE = "Attribute Import Utility"; // Labels for the sub-panels. private static final String DATASOURCE = "Data Source"; private static final String KEY_ATTR = "Key Attribute in Cytoscape"; private static final String ATTR_PANEL_TITLE = "Available Annotations"; // Title of the panel. protected String panelTitle; // Icon for this panel title. protected Icon logo; // Attribute panel border title protected String attributePanelTitle; protected AttributeImportPanel() { this(null, DEF_TITLE, ATTR_PANEL_TITLE); } protected AttributeImportPanel(Icon logo, String title, String attrPanelTitle) { this.logo = logo; this.panelTitle = title; this.attributePanelTitle = attrPanelTitle; initComponents(); setAttributes(null); // Listening to the changes in Node Attributes. Cytoscape.getNodeAttributes().getMultiHashMapDefinition().addDataDefinitionListener(this); } protected void initComponents() { attrList = new CheckBoxJList(); model = new DefaultListModel(); attrList.setModel(model); titleLabel = new javax.swing.JLabel(); databasePanel = new javax.swing.JPanel(); databaseComboBox = new javax.swing.JComboBox(); attributePanel = new javax.swing.JPanel(); attributeLabel = new javax.swing.JLabel(); attributeComboBox = new javax.swing.JComboBox(); attributeTypeLabel = new javax.swing.JLabel(); attributeTypeComboBox = new javax.swing.JComboBox(); availableAttrPanel = new javax.swing.JPanel(); availableAttrScrollPane = new javax.swing.JScrollPane(); attrListPanel = new javax.swing.JPanel(); importButton = new javax.swing.JButton(); cancelButton = new javax.swing.JButton(); resetButton = new javax.swing.JButton(); setBackground(new java.awt.Color(255, 255, 255)); titleLabel.setBackground(new java.awt.Color(255, 255, 255)); titleLabel.setIcon(logo); titleLabel.setText(panelTitle); databasePanel.setBackground(new java.awt.Color(255, 255, 255)); databasePanel.setBorder(javax.swing.BorderFactory.createTitledBorder(DATASOURCE)); attributeComboBox.setBackground(Color.white); databaseComboBox.addActionListener(new java.awt.event.ActionListener() { public void actionPerformed(java.awt.event.ActionEvent evt) { databaseComboBoxActionPerformed(evt); } }); databaseComboBox.setBackground(Color.white); org.jdesktop.layout.GroupLayout databasePanelLayout = new org.jdesktop.layout.GroupLayout(databasePanel); databasePanel.setLayout(databasePanelLayout); databasePanelLayout.setHorizontalGroup(databasePanelLayout.createParallelGroup(org.jdesktop.layout.GroupLayout.LEADING) .add(databasePanelLayout.createSequentialGroup() .addContainerGap() .add(databaseComboBox, 0, 350, Short.MAX_VALUE) .addContainerGap())); databasePanelLayout.setVerticalGroup(databasePanelLayout.createParallelGroup(org.jdesktop.layout.GroupLayout.LEADING) .add(databasePanelLayout.createSequentialGroup() .add(databaseComboBox, org.jdesktop.layout.GroupLayout.PREFERRED_SIZE, org.jdesktop.layout.GroupLayout.DEFAULT_SIZE, org.jdesktop.layout.GroupLayout.PREFERRED_SIZE) .addContainerGap(14, Short.MAX_VALUE))); attributePanel.setBackground(new java.awt.Color(255, 255, 255)); attributePanel.setBorder(javax.swing.BorderFactory.createTitledBorder(KEY_ATTR)); attributeLabel.setText("Attribute:"); attributeTypeLabel.setText("Data Type:"); attributeTypeComboBox.addActionListener(new java.awt.event.ActionListener() { public void actionPerformed(java.awt.event.ActionEvent evt) { attributeTypeComboBoxActionPerformed(evt); } }); attributeTypeComboBox.setBackground(Color.white); org.jdesktop.layout.GroupLayout attributePanelLayout = new org.jdesktop.layout.GroupLayout(attributePanel); attributePanel.setLayout(attributePanelLayout); attributePanelLayout.setHorizontalGroup(attributePanelLayout.createParallelGroup(org.jdesktop.layout.GroupLayout.LEADING) .add(attributePanelLayout.createSequentialGroup() .addContainerGap() .add(attributePanelLayout.createParallelGroup(org.jdesktop.layout.GroupLayout.LEADING) .add(attributeLabel) .add(attributeTypeLabel)) .addPreferredGap(org.jdesktop.layout.LayoutStyle.RELATED) .add(attributePanelLayout.createParallelGroup(org.jdesktop.layout.GroupLayout.LEADING) .add(attributeTypeComboBox, 0, 350, Short.MAX_VALUE) .add(attributeComboBox, 0, 350, Short.MAX_VALUE)) .addContainerGap())); attributePanelLayout.setVerticalGroup(attributePanelLayout.createParallelGroup(org.jdesktop.layout.GroupLayout.LEADING) .add(attributePanelLayout.createSequentialGroup() .add(attributePanelLayout.createParallelGroup(org.jdesktop.layout.GroupLayout.BASELINE) .add(attributeLabel) .add(attributeComboBox, org.jdesktop.layout.GroupLayout.PREFERRED_SIZE, org.jdesktop.layout.GroupLayout.DEFAULT_SIZE, org.jdesktop.layout.GroupLayout.PREFERRED_SIZE)) .addPreferredGap(org.jdesktop.layout.LayoutStyle.RELATED) .add(attributePanelLayout.createParallelGroup(org.jdesktop.layout.GroupLayout.BASELINE) .add(attributeTypeLabel) .add(attributeTypeComboBox, org.jdesktop.layout.GroupLayout.PREFERRED_SIZE, org.jdesktop.layout.GroupLayout.DEFAULT_SIZE, org.jdesktop.layout.GroupLayout.PREFERRED_SIZE)) .addContainerGap(13, Short.MAX_VALUE))); availableAttrPanel.setBackground(new java.awt.Color(255, 255, 255)); availableAttrPanel.setBorder(javax.swing.BorderFactory.createTitledBorder(attributePanelTitle)); availableAttrScrollPane.setHorizontalScrollBarPolicy(javax.swing.ScrollPaneConstants.HORIZONTAL_SCROLLBAR_NEVER); availableAttrScrollPane.setViewportView(attrList); org.jdesktop.layout.GroupLayout availableAttrPanelLayout = new org.jdesktop.layout.GroupLayout(availableAttrPanel); availableAttrPanel.setLayout(availableAttrPanelLayout); availableAttrPanelLayout.setHorizontalGroup(availableAttrPanelLayout.createParallelGroup(org.jdesktop.layout.GroupLayout.LEADING) .add(availableAttrPanelLayout.createSequentialGroup() .addContainerGap() .add(availableAttrScrollPane, org.jdesktop.layout.GroupLayout.DEFAULT_SIZE, 350, Short.MAX_VALUE) .addContainerGap())); availableAttrPanelLayout.setVerticalGroup(availableAttrPanelLayout.createParallelGroup(org.jdesktop.layout.GroupLayout.LEADING) .add(org.jdesktop.layout.GroupLayout.TRAILING, availableAttrPanelLayout.createSequentialGroup() .add(availableAttrScrollPane, org.jdesktop.layout.GroupLayout.DEFAULT_SIZE, 362, Short.MAX_VALUE) .addContainerGap())); importButton.setText("Import"); importButton.addActionListener(new java.awt.event.ActionListener() { public void actionPerformed(java.awt.event.ActionEvent evt) { importButtonActionPerformed(evt); } }); importButton.setBackground(Color.white); cancelButton.setText("Cancel"); cancelButton.addActionListener(new java.awt.event.ActionListener() { public void actionPerformed(java.awt.event.ActionEvent evt) { cancelButtonActionPerformed(evt); } }); cancelButton.setBackground(Color.white); resetButton.setText("Reset"); resetButton.addActionListener(new java.awt.event.ActionListener() { public void actionPerformed(java.awt.event.ActionEvent evt) { resetButtonActionPerformed(evt); } }); resetButton.setBackground(Color.white); org.jdesktop.layout.GroupLayout layout = new org.jdesktop.layout.GroupLayout(this); this.setLayout(layout); layout.setHorizontalGroup(layout.createParallelGroup(org.jdesktop.layout.GroupLayout.LEADING) .add(org.jdesktop.layout.GroupLayout.TRAILING, layout.createSequentialGroup().addContainerGap() .add(layout.createParallelGroup(org.jdesktop.layout.GroupLayout.TRAILING) .add(org.jdesktop.layout.GroupLayout.LEADING, availableAttrPanel, org.jdesktop.layout.GroupLayout.DEFAULT_SIZE, org.jdesktop.layout.GroupLayout.DEFAULT_SIZE, Short.MAX_VALUE) .add(org.jdesktop.layout.GroupLayout.LEADING, attributePanel, org.jdesktop.layout.GroupLayout.DEFAULT_SIZE, org.jdesktop.layout.GroupLayout.DEFAULT_SIZE, Short.MAX_VALUE) .add(org.jdesktop.layout.GroupLayout.LEADING, databasePanel, org.jdesktop.layout.GroupLayout.DEFAULT_SIZE, org.jdesktop.layout.GroupLayout.DEFAULT_SIZE, Short.MAX_VALUE) .add(org.jdesktop.layout.GroupLayout.LEADING, titleLabel) .add(layout.createSequentialGroup() .add(resetButton) .addPreferredGap(org.jdesktop.layout.LayoutStyle.RELATED, 343, Short.MAX_VALUE) .add(cancelButton) .addPreferredGap(org.jdesktop.layout.LayoutStyle.RELATED) .add(importButton))) .addContainerGap())); layout.setVerticalGroup(layout.createParallelGroup(org.jdesktop.layout.GroupLayout.LEADING) .add(layout.createSequentialGroup().addContainerGap() .add(titleLabel) .addPreferredGap(org.jdesktop.layout.LayoutStyle.RELATED) .add(databasePanel, org.jdesktop.layout.GroupLayout.PREFERRED_SIZE, org.jdesktop.layout.GroupLayout.DEFAULT_SIZE, org.jdesktop.layout.GroupLayout.PREFERRED_SIZE) .addPreferredGap(org.jdesktop.layout.LayoutStyle.RELATED) .add(attributePanel, org.jdesktop.layout.GroupLayout.PREFERRED_SIZE, org.jdesktop.layout.GroupLayout.DEFAULT_SIZE, org.jdesktop.layout.GroupLayout.PREFERRED_SIZE) .addPreferredGap(org.jdesktop.layout.LayoutStyle.RELATED) .add(availableAttrPanel, org.jdesktop.layout.GroupLayout.DEFAULT_SIZE, org.jdesktop.layout.GroupLayout.DEFAULT_SIZE, Short.MAX_VALUE) .addPreferredGap(org.jdesktop.layout.LayoutStyle.RELATED) .add(layout.createParallelGroup(org.jdesktop.layout.GroupLayout.BASELINE) .add(importButton).add(cancelButton) .add(resetButton)).addContainerGap())); } // protected void resetButtonActionPerformed(ActionEvent evt) { // TODO Auto-generated method stub } protected void importButtonActionPerformed(ActionEvent evt) { importAttributes(); } protected void cancelButtonActionPerformed(java.awt.event.ActionEvent evt) { firePropertyChange(CLOSE_EVENT, null, null); } private void attributeTypeComboBoxActionPerformed(java.awt.event.ActionEvent evt) { // TODO add your handling code here: } abstract protected void databaseComboBoxActionPerformed(java.awt.event.ActionEvent evt); protected abstract void importAttributes(); /** * Set list of attributes currently available for Cytoscape. */ protected void setAttributes(final String attributeName) { if (attributeName != null) { attributeComboBox.removeItem(attributeName); return; } final CyAttributes nodeAttr = Cytoscape.getNodeAttributes(); final String[] names = nodeAttr.getAttributeNames(); Arrays.sort(names); attributeComboBox.removeAllItems(); attributeComboBox.addItem("ID"); for (String name : names) { if (nodeAttr.getUserVisible(name)) { attributeComboBox.addItem(name); } } } public void attributeDefined(String attributeName) { setAttributes(null); } public void attributeUndefined(String attributeName) { setAttributes(attributeName); } // Swing components. Maybe accessed from child classes. protected javax.swing.JComboBox attributeComboBox; protected javax.swing.JLabel attributeLabel; protected javax.swing.JPanel attributePanel; protected javax.swing.JComboBox attributeTypeComboBox; protected javax.swing.JLabel attributeTypeLabel; protected javax.swing.JButton cancelButton; protected javax.swing.JComboBox databaseComboBox; protected javax.swing.JPanel databasePanel; protected javax.swing.JPanel attrListPanel; protected javax.swing.JPanel availableAttrPanel; protected javax.swing.JScrollPane availableAttrScrollPane; protected javax.swing.JButton importButton; protected javax.swing.JLabel titleLabel; protected javax.swing.JButton resetButton; protected CheckBoxJList attrList; protected DefaultListModel model; }