DENOPTIM/_vertex_as_graph_view_panel_8java_source.html

/*

 *   DENOPTIM

 *   Copyright (C) 2020 Marco Foscato <marco.foscato@uib.no>

 *

 *   This program is free software: you can redistribute it and/or modify

 *   it under the terms of the GNU Affero General Public License as published

 *   by the Free Software Foundation, either version 3 of the License, or

 *   (at your option) any later version.

 *

 *   This program 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 Affero General Public License for more details.

 *

 *   You should have received a copy of the GNU Affero General Public License

 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.

 */


package denoptim.gui;


import java.awt.Color;

import java.awt.Dimension;

import java.util.ArrayList;

import java.util.HashMap;

import java.util.List;

import java.util.Map;


import javax.swing.JScrollPane;

import javax.swing.JSplitPane;

import javax.swing.JTable;

import javax.swing.event.TableModelEvent;

import javax.swing.event.TableModelListener;

import javax.swing.table.DefaultTableModel;

import javax.swing.table.JTableHeader;


import denoptim.exception.DENOPTIMException;

import denoptim.graph.AttachmentPoint;

import denoptim.graph.DGraph;

import denoptim.graph.EmptyVertex;

import denoptim.graph.Fragment;

import denoptim.graph.Template;

import denoptim.graph.Vertex;


public class VertexAsGraphViewPanel extends JSplitPane implements IVertexAPSelection

{

    private static final long serialVersionUID = 1L;


    private Vertex vertex;


    protected Map<Integer,AttachmentPoint> mapAPs = null;


    public boolean alteredAPData = false;


    private GraphViewerPanel graphViewer;

    private JScrollPane tabPanel;

    protected DefaultTableModel apTabModel;

    protected JTable apTable;


    // This is a global property of this instance

    private boolean editableAPTable = false;

    // this is vertex-specific, it does not overwrite editableAPTable, which is

    // more general. The overall editablility is given by general && local.

    private boolean vertexSpecificAPTabEditable = true;


//-----------------------------------------------------------------------------


    public VertexAsGraphViewPanel(boolean editableTable)

    {

        this(editableTable,340);

    }


//-----------------------------------------------------------------------------


    public VertexAsGraphViewPanel(boolean editableTable,

            int dividerPosition)

    {

        editableAPTable = editableTable;

        initialize(dividerPosition);

    }


//-----------------------------------------------------------------------------


    @SuppressWarnings("serial")

    private void initialize(int dividerPosition)

    {

        this.setOrientation(JSplitPane.VERTICAL_SPLIT);

        this.setOneTouchExpandable(true);

        this.setDividerLocation(dividerPosition);

        this.setResizeWeight(0.5);


        // Graph Viewer

        graphViewer = new GraphViewerPanel();

        this.setTopComponent(graphViewer);


        // List of attachment points

        apTabModel = new DefaultTableModel() {

            @Override

            public boolean isCellEditable(int row, int column) {

                if (column == 0)

                {

                    return false;

                }

                else

                {

                    return editableAPTable && vertexSpecificAPTabEditable;

                }

            }

        };

        apTabModel.setColumnCount(2);

        String column_names[]= {"<html><b>AP#</b></html>",

                "<html><b>APClass</b></html>"};

        apTabModel.setColumnIdentifiers(column_names);

        apTable = new JTable(apTabModel);

        apTable.putClientProperty("terminateEditOnFocusLost", true);

        apTable.getColumnModel().getColumn(0).setMaxWidth(75);

        apTable.setGridColor(Color.LIGHT_GRAY);

        apTable.setPreferredScrollableViewportSize(apTable.getPreferredSize());

        JTableHeader apTabHeader = apTable.getTableHeader();

        apTabHeader.setPreferredSize(new Dimension(100, 20));

        apTabModel.addTableModelListener(new PausableTableModelListener());

        tabPanel = new JScrollPane(apTable);

        this.setBottomComponent(tabPanel);

    }


//-----------------------------------------------------------------------------


    public void setVertexSpecificEditableAPTable(boolean editable)

    {

        vertexSpecificAPTabEditable = editable;

    }


//-----------------------------------------------------------------------------


    public void loadVertexToViewer(Vertex v)

    {

        setVertexSpecificEditableAPTable(true);

        clearAPTable();

        vertex = v;

        loadVertexStructure();

        updateAPsMapAndTable();

        preSelectAPs();

    }


//-----------------------------------------------------------------------------


    /*

     * Structure here means the single-node-graph-like visual depiction of the

     */

    private void loadVertexStructure()

    {

        if ((vertex instanceof EmptyVertex)

                || (vertex instanceof Fragment))

        {

            //We plot the empty vertex as a single-node graph

            DGraph dnGraph = new DGraph();

            try

            {

                dnGraph.addVertex(vertex.clone()); //Clone avoids setting owner

            } catch (DENOPTIMException e)

            {

                //This will never happen because this is a one-vertex graph

            }

            graphViewer.cleanup();

            graphViewer.loadGraphToViewer(dnGraph);

        } else {

            Template tmpl = ((Template) vertex);

            graphViewer.cleanup();

            graphViewer.loadGraphToViewer(tmpl);

        }

    }


//-----------------------------------------------------------------------------


    public boolean hasUnsavedAPEdits()

    {

        return alteredAPData;

    }


//-----------------------------------------------------------------------------


    public void deprotectEdits()

    {

        alteredAPData = false;

    }


//-----------------------------------------------------------------------------


    private void updateAPsMapAndTable()

    {

        clearAPTable();

        mapAPs = new HashMap<Integer,AttachmentPoint>();


        List<AttachmentPoint> lstAPs = vertex.getAttachmentPoints();

        if (lstAPs.size() == 0)

        {

            return;

        }


        activateTabEditsListener(false);

        int arrId = 0;

        for (AttachmentPoint ap : lstAPs)

        {

            arrId++;

            apTabModel.addRow(new Object[]{arrId, ap.getAPClass()});

            mapAPs.put(arrId,ap);

        }

        activateTabEditsListener(true);

    }


//-----------------------------------------------------------------------------


    private void preSelectAPs()

    {

        String PRESELPROP = GUIVertexSelector.PRESELECTEDAPSFIELD;

        String PRESELPROPSEP = GUIVertexSelector.PRESELECTEDAPSFIELDSEP;


        if (vertex.getProperty(PRESELPROP) == null)

        {

            return;

        }


        String prop = vertex.getProperty(PRESELPROP).toString();

        String[] parts =prop.split(PRESELPROPSEP);


        activateTabEditsListener(false);

        for (int i=0; i<parts.length; i++)

        {

            int apId = Integer.parseInt(parts[i]); //0-based

            apTable.getSelectionModel().addSelectionInterval(apId, apId);

        }

        activateTabEditsListener(true);

    }


//-----------------------------------------------------------------------------


    public void clearAll()

    {

        clearAPTable();

    }


//-----------------------------------------------------------------------------


    public void clearAPTable()

    {

        activateTabEditsListener(false);

        int initRowCount = apTabModel.getRowCount();

        for (int i=0; i<initRowCount; i++)

        {

            //Always remove the first to avoid dealing with changing row ids

            apTabModel.removeRow(0);

        }

        activateTabEditsListener(true);

    }


//-----------------------------------------------------------------------------


    public ArrayList<AttachmentPoint> getSelectedAPs()

    {

        ArrayList<AttachmentPoint> selected =

                new ArrayList<AttachmentPoint>();


        for (int rowId : apTable.getSelectedRows())

        {

            selected.add(mapAPs.get(apTable.getValueAt(rowId, 0)));

        }

        return selected;

    }


//-----------------------------------------------------------------------------


    public ArrayList<Integer> getSelectedAPIDs()

    {

        ArrayList<Integer> selected = new ArrayList<Integer>();

        for (int rowId : apTable.getSelectedRows())

        {

            selected.add(rowId);

        }

        return selected;

    }


//-----------------------------------------------------------------------------


    private class PausableTableModelListener implements TableModelListener

    {

        private boolean isActive = false;


        public PausableTableModelListener()

        {};


        @Override

        public void tableChanged(TableModelEvent e)

        {

            if (isActive && !alteredAPData

                    && e.getType() == TableModelEvent.UPDATE)

            {

                alteredAPData = true;

                firePropertyChange(IVertexAPSelection.APDATACHANGEEVENT, false,

                        true);

            }

        }


        public void setActive(boolean var)

        {

            isActive = var;

        }

    }


//-----------------------------------------------------------------------------


    public void activateTabEditsListener(boolean var)

    {

        try

        {

            PausableTableModelListener l = (PausableTableModelListener)

                    apTabModel.getTableModelListeners()[0];

            l.setActive(var);

        } catch (Throwable t) {

            //t.printStackTrace();

            System.out.println("Bad attempt to contro listener: "

                    + t.getMessage());

            System.out.println(t.getCause());

        }

    }


//-----------------------------------------------------------------------------


    public void dispose()

    {

        graphViewer.dispose();

    }


//-----------------------------------------------------------------------------


    @Override

    public Map<Integer, AttachmentPoint> getMapOfAPsInTable()

    {

        return mapAPs;

    }


//-----------------------------------------------------------------------------


    @Override

    public DefaultTableModel getAPTableModel()

    {

        return apTabModel;

    }


//-----------------------------------------------------------------------------


}

denoptim.exception.DENOPTIMException
Definition: DENOPTIMException.java:26

denoptim.graph.AttachmentPoint
An attachment point (AP) is a possibility to attach a Vertex onto the vertex holding the AP (i....
Definition: AttachmentPoint.java:53

denoptim.graph.DGraph
Container for the list of vertices and the edges that connect them.
Definition: DGraph.java:102

denoptim.graph.DGraph.addVertex
void addVertex(Vertex vertex)
Appends a vertex to this graph without creating any edge.
Definition: DGraph.java:1097

denoptim.graph.EmptyVertex
An empty vertex has the behaviors of a vertex, but has no molecular structure.
Definition: EmptyVertex.java:45

denoptim.graph.Fragment
Class representing a continuously connected portion of chemical object holding attachment points.
Definition: Fragment.java:61

denoptim.graph.Template
Definition: Template.java:80

denoptim.graph.Vertex
A vertex is a data structure that has an identity and holds a list of AttachmentPoints.
Definition: Vertex.java:61

denoptim.graph.Vertex.clone
abstract Vertex clone()
Returns a deep-copy of this vertex.

denoptim.graph.Vertex.getAttachmentPoints
abstract List< AttachmentPoint > getAttachmentPoints()

denoptim.graph.Vertex.getProperty
Object getProperty(Object property)
Definition: Vertex.java:1136

denoptim.gui.GUIVertexSelector
A modal dialog with a viewer that understands the different types of DENOPTIM vertex and allows to se...
Definition: GUIVertexSelector.java:49

denoptim.gui.GUIVertexSelector.PRESELECTEDAPSFIELD
static final String PRESELECTEDAPSFIELD
Property used to pre-select APs.
Definition: GUIVertexSelector.java:91

denoptim.gui.GUIVertexSelector.PRESELECTEDAPSFIELDSEP
static final String PRESELECTEDAPSFIELDSEP
Separator in property used to pre-select APs.
Definition: GUIVertexSelector.java:96

denoptim.gui.GraphViewerPanel
A Panel that holds the JUNG representation of a graph.
Definition: GraphViewerPanel.java:78

denoptim.gui.GraphViewerPanel.loadGraphToViewer
void loadGraphToViewer(DGraph dnGraph)
Load the given DGraph to this graph viewer.
Definition: GraphViewerPanel.java:362

denoptim.gui.GraphViewerPanel.cleanup
void cleanup()
Removes the currently loaded graph viewer.
Definition: GraphViewerPanel.java:342

denoptim.gui.GraphViewerPanel.dispose
void dispose()
Definition: GraphViewerPanel.java:1252

denoptim.gui.VertexAsGraphViewPanel.PausableTableModelListener
Definition: VertexAsGraphViewPanel.java:342

denoptim.gui.VertexAsGraphViewPanel.PausableTableModelListener.setActive
void setActive(boolean var)
Definition: VertexAsGraphViewPanel.java:360

denoptim.gui.VertexAsGraphViewPanel.PausableTableModelListener.tableChanged
void tableChanged(TableModelEvent e)
Definition: VertexAsGraphViewPanel.java:349

denoptim.gui.VertexAsGraphViewPanel.PausableTableModelListener.PausableTableModelListener
PausableTableModelListener()
Definition: VertexAsGraphViewPanel.java:345

denoptim.gui.VertexAsGraphViewPanel.PausableTableModelListener.isActive
boolean isActive
Definition: VertexAsGraphViewPanel.java:343

denoptim.gui.VertexAsGraphViewPanel
A panel to visualize a vertex as a graph component with attachment point table.
Definition: VertexAsGraphViewPanel.java:53

denoptim.gui.VertexAsGraphViewPanel.serialVersionUID
static final long serialVersionUID
Version UID.
Definition: VertexAsGraphViewPanel.java:57

denoptim.gui.VertexAsGraphViewPanel.VertexAsGraphViewPanel
VertexAsGraphViewPanel(boolean editableTable)
Constructor that allows to specify whether the AP table is editable or not.
Definition: VertexAsGraphViewPanel.java:92

denoptim.gui.VertexAsGraphViewPanel.alteredAPData
boolean alteredAPData
Flag signalling that data about APs has been changed in the GUI.
Definition: VertexAsGraphViewPanel.java:72

denoptim.gui.VertexAsGraphViewPanel.editableAPTable
boolean editableAPTable
Definition: VertexAsGraphViewPanel.java:80

denoptim.gui.VertexAsGraphViewPanel.getSelectedAPs
ArrayList< AttachmentPoint > getSelectedAPs()
Identifies which attachment points are selected in the visualized table.
Definition: VertexAsGraphViewPanel.java:311

denoptim.gui.VertexAsGraphViewPanel.setVertexSpecificEditableAPTable
void setVertexSpecificEditableAPTable(boolean editable)
Definition: VertexAsGraphViewPanel.java:159

denoptim.gui.VertexAsGraphViewPanel.apTabModel
DefaultTableModel apTabModel
Definition: VertexAsGraphViewPanel.java:76

denoptim.gui.VertexAsGraphViewPanel.loadVertexToViewer
void loadVertexToViewer(Vertex v)
Definition: VertexAsGraphViewPanel.java:166

denoptim.gui.VertexAsGraphViewPanel.getAPTableModel
DefaultTableModel getAPTableModel()
Definition: VertexAsGraphViewPanel.java:405

denoptim.gui.VertexAsGraphViewPanel.graphViewer
GraphViewerPanel graphViewer
Definition: VertexAsGraphViewPanel.java:74

denoptim.gui.VertexAsGraphViewPanel.deprotectEdits
void deprotectEdits()
Overrides the flag signaling unsaved edits to saying that there are no altered data.
Definition: VertexAsGraphViewPanel.java:221

denoptim.gui.VertexAsGraphViewPanel.getSelectedAPIDs
ArrayList< Integer > getSelectedAPIDs()
Identifies which attachment points are selected in the visualized table.
Definition: VertexAsGraphViewPanel.java:329

denoptim.gui.VertexAsGraphViewPanel.activateTabEditsListener
void activateTabEditsListener(boolean var)
Allows to activate and deactivate the listener.
Definition: VertexAsGraphViewPanel.java:372

denoptim.gui.VertexAsGraphViewPanel.getMapOfAPsInTable
Map< Integer, AttachmentPoint > getMapOfAPsInTable()
Definition: VertexAsGraphViewPanel.java:397

denoptim.gui.VertexAsGraphViewPanel.vertex
Vertex vertex
The currently loaded fragment.
Definition: VertexAsGraphViewPanel.java:62

denoptim.gui.VertexAsGraphViewPanel.vertexSpecificAPTabEditable
boolean vertexSpecificAPTabEditable
Definition: VertexAsGraphViewPanel.java:83

denoptim.gui.VertexAsGraphViewPanel.clearAll
void clearAll()
Removes the currently visualized molecule and AP table.
Definition: VertexAsGraphViewPanel.java:283

denoptim.gui.VertexAsGraphViewPanel.VertexAsGraphViewPanel
VertexAsGraphViewPanel(boolean editableTable, int dividerPosition)
Constructor that allows to specify whether the AP table is editable or not.
Definition: VertexAsGraphViewPanel.java:106

denoptim.gui.VertexAsGraphViewPanel.dispose
void dispose()
Definition: VertexAsGraphViewPanel.java:389

denoptim.gui.VertexAsGraphViewPanel.loadVertexStructure
void loadVertexStructure()
Definition: VertexAsGraphViewPanel.java:181

denoptim.gui.VertexAsGraphViewPanel.mapAPs
Map< Integer, AttachmentPoint > mapAPs
Temporary list of attachment points of the current fragment.
Definition: VertexAsGraphViewPanel.java:67

denoptim.gui.VertexAsGraphViewPanel.apTable
JTable apTable
Definition: VertexAsGraphViewPanel.java:77

denoptim.gui.VertexAsGraphViewPanel.tabPanel
JScrollPane tabPanel
Definition: VertexAsGraphViewPanel.java:75

denoptim.gui.VertexAsGraphViewPanel.updateAPsMapAndTable
void updateAPsMapAndTable()
Uses the AP of the Fragment to create a new map and table of APs.
Definition: VertexAsGraphViewPanel.java:232

denoptim.gui.VertexAsGraphViewPanel.hasUnsavedAPEdits
boolean hasUnsavedAPEdits()
Check for unsaved edits to the AP data.
Definition: VertexAsGraphViewPanel.java:210

denoptim.gui.VertexAsGraphViewPanel.clearAPTable
void clearAPTable()
Clears the table of attachment points.
Definition: VertexAsGraphViewPanel.java:293

denoptim.gui.VertexAsGraphViewPanel.preSelectAPs
void preSelectAPs()
Definition: VertexAsGraphViewPanel.java:256

denoptim.gui.VertexAsGraphViewPanel.initialize
void initialize(int dividerPosition)
Definition: VertexAsGraphViewPanel.java:116

denoptim.gui.IVertexAPSelection
Interface for all vertex viewers that intend to allow selection of attachment points.
Definition: IVertexAPSelection.java:33

denoptim.gui.IVertexAPSelection.APDATACHANGEEVENT
final String APDATACHANGEEVENT
Definition: IVertexAPSelection.java:34