NetworkPanel (Simbrain API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - org.simbrain.network.gui.NetworkPanel

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

Direct Known Subclasses:

NetworkPanelDesktop
```
public class NetworkPanel
extends javax.swing.JPanel
```
Contains a piccolo PCanvas that maintains a visual representation of the network. Creation, deletion, and state update events are received here and piccolo nodes created, deleted, and updated accordingly. Various selection events and and other graphics processing are also handled here. Here are some more details on this class. These are not API notes but rather an overview of the class, which, given its size, is useful to have. Here are some of the main things handled here:
- Set up network listeners, for responding to events where neurons, synapses, groups, etc. are added, deleted, updated, or changed.
- Methods for updating the visible states of GUI elements. Mostly private and called by listeners. See methods beginning "update"...
- Methods for adding and removing model objects of various kinds to the canvas. This is where the most complex stuff in this class occurs, given the various types of compound objects that must be represented in the Piccolo canvas. See methods beginning "add..".
- Creation of relevant piccolo objects
- Methods for managing menus, dealing with selections, copy paste, aligning, spacing, etc., centering the camera, incrementing objects, nudging objects, etc.
- Convenience methods for returning different collections of objects (selected neurons, synapses, etc.).
Also note that NetworkPanel can be used separately from the Simbrain workspace, e.g. in an applet. Thus all dependencies on workspace classes (e.g. handling coupling menus) are in NetworkPanelDesktop, which explains some of the methods here that are stubs overridden in that class.
See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class javax.swing.JPanel
  javax.swing.JPanel.AccessibleJPanel
- Nested classes/interfaces inherited from class javax.swing.JComponent
  javax.swing.JComponent.AccessibleJComponent
- Nested classes/interfaces inherited from class java.awt.Container
  java.awt.Container.AccessibleAWTContainer
- Nested classes/interfaces inherited from class java.awt.Component
  java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields
Modifier and Type	Field and Description
`protected NetworkActionManager`	`actionManager` Action manager.
`static int`	`DEFAULT_SPACING` Default spacing for new points.
`protected javax.swing.JToggleButton`	`neuronClampButton` Toggle button for neuron clamping.
`protected javax.swing.JCheckBoxMenuItem`	`neuronClampMenuItem` Menu item for neuron clamping.
`protected javax.swing.JToggleButton`	`synapseClampButton` Toggle button for weight clamping.
`protected javax.swing.JCheckBoxMenuItem`	`synapseClampMenuItem` Menu item for weight clamping.
`protected UndoManager`	`undoManager` Undo manager.

Fields inherited from class javax.swing.JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors
Constructor and Description

NetworkPanel(Network Network)
Create a new Network panel.

Constructors
Constructor and Description
`NetworkPanel(Network Network)` Create a new Network panel.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addInternalMenuBar()` Adds an internal menu bar; used in applets.
`SynapseGroupNode`	`addMenuToSynapseGroupNode(SynapseGroupNode node)` Overriden by NetworkPanelDesktop to adorn node with coupling menus.
`void`	`addNeuron()` Use the GUI to add a new neuron to the underlying network model.
`void`	`addNeuronsToPanel(java.util.List<Neuron> neurons, Layout layout)` Using the GUI to add a set of neurons to the underlying network panel.
`void`	`addSelection(java.lang.Object element)` Add objects to the current selection.
`void`	`addSelectionListener(NetworkSelectionListener l)` Add the specified Network selection listener.
`void`	`alignHorizontal()` Aligns neurons horizontally.
`void`	`alignVertical()` Aligns neurons vertically.
`void`	`clearPanel()` Remove all nodes from panel.
`void`	`clearSelection()` Clear the selection.
`void`	`clearSourceElements()` Clear all source elements.
`void`	`closeNetwork()` Close model Network.
`void`	`componentUpdated()`
`void`	`contextualDecrementSelectedObjects()` Invoke contextual decrement (which respects neuron specific rules) on selected objects.
`void`	`contextualIncrementSelectedObjects()` Invoke contextual increment (which respects neuron specific rules) on selected objects.
`void`	`copy()` Copy to the clipboard.
`javax.swing.JMenu`	`createAlignMenu()` Return the align sub menu.
`protected CustomToolBar`	`createEditToolBar()` Create the edit tool bar.
`protected CustomToolBar`	`createMainToolBar()` Create the main tool bar.
`javax.swing.JPopupMenu`	`createNetworkContextMenu()` Create a new context menu for this Network panel.
`protected CustomToolBar`	`createRunToolBar()` Create the iteration tool bar.
`javax.swing.JMenu`	`createSpacingMenu()` Return the space sub menu.
`javax.swing.JToolTip`	`createToolTip()` Overridden so that multi-line tooltips can be used.
`void`	`cut()` Cut to the clipboard.
`java.lang.String`	`debugString()`
`void`	`decrementSelectedObjects()` Decreases neuron and synapse activation levels.
`void`	`deleteSelectedObjects()` Delete selected items.
`GenericFrame`	`displayPanel(javax.swing.JPanel panel, java.lang.String title)` Display a panel in a dialog.
`javax.swing.JDialog`	`displayPanelInWindow(javax.swing.JPanel panel, java.lang.String title)` A copy of displayPanel except returning a subclass of Window.
`NetworkActionManager`	`getActionManager()`
`boolean`	`getAutoZoomMode()`
`static java.awt.Color`	`getBackgroundColor()`
`java.awt.geom.Point2D`	`getBeginPosition()`
`org.piccolo2d.PCanvas`	`getCanvas()`
`(package private) javax.swing.JPopupMenu`	`getContextMenu()` Return the context menu for this Network panel.
`javax.swing.JPopupMenu`	`getContextMenuAlt()`
`EditMode`	`getEditMode()` Return the current edit mode for this Network panel.
`CustomToolBar`	`getEditToolBar()`
`java.awt.geom.Point2D`	`getEndPosition()`
`boolean`	`getInOutMode()`
`java.awt.geom.Point2D`	`getLastClickedPosition()`
`NeuronNode`	`getLastSelectedNeuron()`
`CustomToolBar`	`getMainToolBar()`
`Network`	`getNetwork()`
`NetworkDialog`	`getNetworkDialog(NetworkPanel networkPanel)` Returns a NetworkDialog.
`javax.swing.JPopupMenu`	`getNeuronContextMenu(Neuron neuron)` Creates the context menu for neurons.
`StandardDialog`	`getNeuronDialog(java.util.Collection<NeuronNode> nns)`
`javax.swing.JMenu`	`getNeuronGroupConsumerMenu(NeuronGroup neuronGroup)` Creates the consumer menu for neuron groups.
`StandardDialog`	`getNeuronGroupDialog(NeuronGroupNode node)` Overridden by NetworkPanelDesktop to ensure modeless-ness relative to SimbrainDesktop.
`javax.swing.JMenu`	`getNeuronGroupProducerMenu(NeuronGroup neuronGroup)` Creates the producer menu for neuron groups.
`java.util.Collection<NeuronNode>`	`getNeuronNodes()` Return a collection of all neuron nodes.
`static double`	`getNudgeAmount()`
`double`	`getNumberOfPastes()`
`java.util.Map<java.lang.Object,org.piccolo2d.PNode>`	`getObjectNodeMap()`
`java.util.Collection`	`getParentNodes()` Return a collection of all parent nodes.
`double`	`getPasteX()`
`double`	`getPasteY()`
`boolean`	`getPrioritiesVisible()`
`QuickConnectionManager`	`getQuickConnector()`
`CustomToolBar`	`getRunToolBar()`
`java.util.Collection<ScreenElement>`	`getSelectableNodes()` Return a collection of all persistent nodes, that is all neuron nodes and all synapse nodes.
`java.util.Collection`	`getSelectedModelElements()` Returns model Network elements corresponding to selected screen elements.
`java.util.ArrayList<NeuronGroup>`	`getSelectedModelNeuronGroups()` Returns selected neuron groups.
`java.util.ArrayList<Neuron>`	`getSelectedModelNeurons()` Returns selected Neurons.
`java.util.ArrayList<SynapseGroup>`	`getSelectedModelSynapseGroups()` Returns selected synapse groups.
`java.util.ArrayList<Synapse>`	`getSelectedModelSynapses()` Returns selected synapses.
`java.util.Collection<org.piccolo2d.PNode>`	`getSelectedNeuronGroups()`
`java.util.Collection<NeuronNode>`	`getSelectedNeurons()` Returns selected Neurons.
`java.util.Collection<ScreenElement>`	`getSelectedScreenElements()` Return a collection of all persistent nodes, that is all neuron nodes and all synapse nodes.
`java.util.Collection<SynapseNode>`	`getSelectedSynapses()` Returns selected Synapses.
`java.util.ArrayList<TextNode>`	`getSelectedText()` Returns the selected Text objects.
`java.util.Collection<org.piccolo2d.PNode>`	`getSelection()` Return the selection as a collection of selected elements.
`boolean`	`getShowSubnetOutline()`
`boolean`	`getShowTime()`
`java.util.ArrayList<NeuronGroup>`	`getSourceModelGroups()` Returns neuron groups which are "source elements" that can be connected to other neuron groups.
`java.util.ArrayList<Neuron>`	`getSourceModelNeurons()`
`javax.swing.JPopupMenu`	`getSynapseContextMenu(Synapse synapse)`
`StandardDialog`	`getSynapseDialog(java.util.Collection<SynapseNode> sns)`
`javax.swing.JMenu`	`getSynapseGroupConsumerMenu(SynapseGroup synapseGroup)` Creates the consumer menu for synapse groups.
`StandardDialog`	`getSynapseGroupDialog(SynapseGroupInteractionBox sgib)` Creates a synapse group dialog from a synapse group interaction box, overrriden in NetworkPanelDesktop to make it modeless relative to the SimbrainDesktop.
`javax.swing.JMenu`	`getSynapseGroupProducerMenu(SynapseGroup synapseGroup)` Creates the producer menu for synapse groups.
`java.util.Collection<SynapseNode>`	`getSynapseNodes()` Return a collection of all synapse nodes.
`TextEventHandler`	`getTextHandle()`
`java.util.Collection<TextNode>`	`getTextNodes()` Return a collection of all text nodes.
`UndoManager`	`getUndoManager()`
`boolean`	`getUpdateComplete()`
`ViewGroupNode`	`getViewGroupNode()`
`boolean`	`getWeightsVisible()`
`java.awt.geom.Point2D.Double`	`getWhereToAdd()`
`void`	`groupSelectedObjects()` Create a group of GUI objects.
`void`	`incrementSelectedObjects()` Increases neuron and synapse activation levels.
`void`	`initGui()` Initialize the Gui.
`boolean`	`isGuiOn()`
`boolean`	`isRunning()`
`boolean`	`isSelected(java.lang.Object element)` Return true if the specified element is selected.
`boolean`	`isSelectionEmpty()` Return true if the selection is empty.
`void`	`modelCleared(NetworkEvent e)`
`protected void`	`nudge(int offsetX, int offsetY)` Nudge selected objects.
`void`	`paste()` Paste from the clipboard.
`void`	`removeSelectionListener(NetworkSelectionListener l)` Remove the specified Network selection listener.
`void`	`repaint()`
`void`	`resetColors()` Called by Network preferences as preferences are changed.
`void`	`resetSynapseDiameters()` Called by Network preferences as preferences are changed.
`void`	`selectAll()` Select all elements.
`void`	`setAutoZoomMode(boolean autoZoomMode)`
`static void`	`setBackgroundColor(java.awt.Color backgroundColor)`
`void`	`setBeginPosition(java.awt.geom.Point2D beginPosition)` Beginning position used in calculating offsets for multiple pastes.
`void`	`setEditMode(EditMode newEditMode)` Set the current edit mode for this Network panel to `editMode` .
`void`	`setEndPosition(java.awt.geom.Point2D endPosition)`
`void`	`setGuiOn(boolean guiOn)`
`void`	`setHierarchyPanelVisible(boolean showIt)` Set the visibility of the hiearchy panel.
`void`	`setLastClickedPosition(java.awt.geom.Point2D lastLeftClicked)` Set the last position clicked on screen.
`void`	`setLastSelectedNeuron(NeuronNode lastSelectedNeuron)`
`void`	`setNetwork(Network network)` Set Root network.
`static void`	`setNudgeAmount(double nudgeAmount)`
`void`	`setNumberOfPastes(double numberOfPastes)`
`void`	`setPasteDelta()` Set the offset used in multiple pastes.
`void`	`setPasteX(double pasteX)`
`void`	`setPasteY(double pasteY)`
`void`	`setPrioritiesVisible(boolean prioritiesOn)` Turns the displaying of neuron priorities on or off.
`void`	`setRunning(boolean isRunning)`
`void`	`setSelection(java.util.Collection elements)` Set the selection to the specified collection of elements.
`void`	`setShowSubnetOutline(boolean showSubnetOutline)`
`void`	`setShowTime(boolean showTime)`
`void`	`setSourceElements()` Set selected elements to be source elements (with red rectangles around them).
`void`	`setTitle(java.lang.String name)`
`void`	`setUpdateComplete(boolean updateComplete)`
`void`	`setWeightsVisible(boolean weightsVisible)` Turns the displaying of loose synapses on and off (for performance increase or visual clarity).
`void`	`showSelectedNeuronProperties()` Creates and displays the neuron properties dialog.
`void`	`showSelectedSynapseProperties()` Creates and displays the synapse properties dialog.
`void`	`showTextPropertyDialog()` Creates and displays the text properties dialog.
`void`	`spaceHorizontal()` TODO: Push this and related methods to model? Spaces neurons horizontally.
`void`	`spaceVertical()` Spaces neurons vertically.
`void`	`syncToModel()` Synchronize model and view.
`void`	`toggleSelection(java.lang.Object element)` Toggle the selected state of the specified element; if it is selected, remove it from the selection, if it is not selected, add it to the selection.
`java.lang.String`	`toString()`
`void`	`unGroup(ViewGroupNode vgn, boolean selectConstituents)` Ungroup specified object.
`void`	`updateCursor()` Update the cursor.
`void`	`updateTime()`
`void`	`zoomToFitPage(boolean forceZoom)` Rescales the camera so that all objects in the canvas can be seen.

Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_SPACING
```
public static final int DEFAULT_SPACING
```
    Default spacing for new points.
    
    See Also:
    
    Constant Field Values
  - actionManager
```
protected NetworkActionManager actionManager
```
    Action manager.
  - undoManager
```
protected final UndoManager undoManager
```
    Undo manager.
  - neuronClampButton
```
protected javax.swing.JToggleButton neuronClampButton
```
    Toggle button for neuron clamping.
  - synapseClampButton
```
protected javax.swing.JToggleButton synapseClampButton
```
    Toggle button for weight clamping.
  - neuronClampMenuItem
```
protected javax.swing.JCheckBoxMenuItem neuronClampMenuItem
```
    Menu item for neuron clamping.
  - synapseClampMenuItem
```
protected javax.swing.JCheckBoxMenuItem synapseClampMenuItem
```
    Menu item for weight clamping.
- Constructor Detail
  - NetworkPanel
```
public NetworkPanel(Network Network)
```
    Create a new Network panel.
    
    Parameters:
    
    Network - the network panel being created.
- Method Detail
  - updateTime
```
public void updateTime()
```
  - addNeuron
```
public void addNeuron()
```
    Use the GUI to add a new neuron to the underlying network model.
  - addNeuronsToPanel
```
public void addNeuronsToPanel(java.util.List<Neuron> neurons,
                              Layout layout)
```
    Using the GUI to add a set of neurons to the underlying network panel.
    
    Parameters:
    
    neurons - the set of neurons
    
    layout - the layout to use in adding them
  - createNetworkContextMenu
```
public javax.swing.JPopupMenu createNetworkContextMenu()
```
    Create a new context menu for this Network panel.
    
    Returns:
    
    the newly constructed context menu
  - getContextMenu
```
javax.swing.JPopupMenu getContextMenu()
```
    Return the context menu for this Network panel.
    This context menu should return actions that are appropriate for the Network panel as a whole, e.g. actions that change modes, actions that operate on the selection, actions that add new components, etc. Actions specific to a node of interest should be built into a node-specific context menu.
    
    Returns:
    
    the context menu for this Network panel
  - createRunToolBar
```
protected CustomToolBar createRunToolBar()
```
    Create the iteration tool bar.
    
    Returns:
    
    the toolbar.
  - createMainToolBar
```
protected CustomToolBar createMainToolBar()
```
    Create the main tool bar.
    
    Returns:
    
    the toolbar.
  - createEditToolBar
```
protected CustomToolBar createEditToolBar()
```
    Create the edit tool bar.
    
    Returns:
    
    the toolbar.
  - createAlignMenu
```
public javax.swing.JMenu createAlignMenu()
```
    Return the align sub menu.
    
    Returns:
    
    the align sub menu
  - createSpacingMenu
```
public javax.swing.JMenu createSpacingMenu()
```
    Return the space sub menu.
    
    Returns:
    
    the space sub menu
  - getEditMode
```
public EditMode getEditMode()
```
    Return the current edit mode for this Network panel.
    
    Returns:
    
    the current edit mode for this Network panel
  - setEditMode
```
public void setEditMode(EditMode newEditMode)
```
    Set the current edit mode for this Network panel to editMode .
    This is a bound property.
    
    Parameters:
    
    newEditMode - edit mode for this Network panel, must not be null
  - updateCursor
```
public void updateCursor()
```
    Update the cursor.
  - deleteSelectedObjects
```
public void deleteSelectedObjects()
```
    Delete selected items.
  - copy
```
public void copy()
```
    Copy to the clipboard.
  - cut
```
public void cut()
```
    Cut to the clipboard.
  - paste
```
public void paste()
```
    Paste from the clipboard.
  - alignHorizontal
```
public void alignHorizontal()
```
    Aligns neurons horizontally.
  - alignVertical
```
public void alignVertical()
```
    Aligns neurons vertically.
  - spaceHorizontal
```
public void spaceHorizontal()
```
    TODO: Push this and related methods to model? Spaces neurons horizontally.
  - spaceVertical
```
public void spaceVertical()
```
    Spaces neurons vertically.
  - showSelectedNeuronProperties
```
public void showSelectedNeuronProperties()
```
    Creates and displays the neuron properties dialog.
  - showSelectedSynapseProperties
```
public void showSelectedSynapseProperties()
```
    Creates and displays the synapse properties dialog.
  - showTextPropertyDialog
```
public void showTextPropertyDialog()
```
    Creates and displays the text properties dialog.
  - clearSelection
```
public void clearSelection()
```
    Clear the selection.
  - selectAll
```
public void selectAll()
```
    Select all elements.
  - isSelectionEmpty
```
public boolean isSelectionEmpty()
```
    Return true if the selection is empty.
    
    Returns:
    
    true if the selection is empty
  - isSelected
```
public boolean isSelected(java.lang.Object element)
```
    Return true if the specified element is selected.
    
    Parameters:
    
    element - element
    
    Returns:
    
    true if the specified element is selected
  - getSelection
```
public java.util.Collection<org.piccolo2d.PNode> getSelection()
```
    Return the selection as a collection of selected elements.
    
    Returns:
    
    the selection as a collection of selected elements
  - setSelection
```
public void setSelection(java.util.Collection elements)
```
    Set the selection to the specified collection of elements.
    
    Parameters:
    
    elements - elements
  - toggleSelection
```
public void toggleSelection(java.lang.Object element)
```
    Toggle the selected state of the specified element; if it is selected, remove it from the selection, if it is not selected, add it to the selection.
    
    Parameters:
    
    element - element
  - addSelection
```
public void addSelection(java.lang.Object element)
```
    Add objects to the current selection.
    
    Parameters:
    
    element - the element to "select."
  - addSelectionListener
```
public void addSelectionListener(NetworkSelectionListener l)
```
    Add the specified Network selection listener.
    
    Parameters:
    
    l - Network selection listener to add
  - removeSelectionListener
```
public void removeSelectionListener(NetworkSelectionListener l)
```
    Remove the specified Network selection listener.
    
    Parameters:
    
    l - Network selection listener to remove
  - getSelectedNeurons
```
public java.util.Collection<NeuronNode> getSelectedNeurons()
```
    Returns selected Neurons.
    
    Returns:
    
    list of selectedNeurons
  - getSelectedSynapses
```
public java.util.Collection<SynapseNode> getSelectedSynapses()
```
    Returns selected Synapses.
    
    Returns:
    
    list of selected Synapses
  - getSelectedNeuronGroups
```
public java.util.Collection<org.piccolo2d.PNode> getSelectedNeuronGroups()
```
  - getSelectedText
```
public java.util.ArrayList<TextNode> getSelectedText()
```
    Returns the selected Text objects.
    
    Returns:
    
    list of selected Text objects
  - getSelectedModelNeurons
```
public java.util.ArrayList<Neuron> getSelectedModelNeurons()
```
    Returns selected Neurons.
    
    Returns:
    
    list of selectedNeurons
  - getSelectedModelSynapses
```
public java.util.ArrayList<Synapse> getSelectedModelSynapses()
```
    Returns selected synapses.
    
    Returns:
    
    list of selected synapses
  - getSelectedModelNeuronGroups
```
public java.util.ArrayList<NeuronGroup> getSelectedModelNeuronGroups()
```
    Returns selected neuron groups.
    
    Returns:
    
    list of neuron groups.
  - getSourceModelGroups
```
public java.util.ArrayList<NeuronGroup> getSourceModelGroups()
```
    Returns neuron groups which are "source elements" that can be connected to other neuron groups.
    
    Returns:
    
    the source model group
  - getSelectedModelSynapseGroups
```
public java.util.ArrayList<SynapseGroup> getSelectedModelSynapseGroups()
```
    Returns selected synapse groups.
    
    Returns:
    
    list of synapse groups
  - getSelectedModelElements
```
public java.util.Collection getSelectedModelElements()
```
    Returns model Network elements corresponding to selected screen elements.
    
    Returns:
    
    list of selected model elements
  - getNeuronNodes
```
public java.util.Collection<NeuronNode> getNeuronNodes()
```
    Return a collection of all neuron nodes.
    
    Returns:
    
    a collection of all neuron nodes
  - getSynapseNodes
```
public java.util.Collection<SynapseNode> getSynapseNodes()
```
    Return a collection of all synapse nodes.
    
    Returns:
    
    a collection of all synapse nodes
  - getTextNodes
```
public java.util.Collection<TextNode> getTextNodes()
```
    Return a collection of all text nodes.
    
    Returns:
    
    a collection of all text nodes
  - getParentNodes
```
public java.util.Collection getParentNodes()
```
    Return a collection of all parent nodes.
    
    Returns:
    
    a collection of all p nodes
  - getSelectableNodes
```
public java.util.Collection<ScreenElement> getSelectableNodes()
```
    Return a collection of all persistent nodes, that is all neuron nodes and all synapse nodes.
    
    Returns:
    
    a collection of all persistent nodes
  - getSelectedScreenElements
```
public java.util.Collection<ScreenElement> getSelectedScreenElements()
```
    Return a collection of all persistent nodes, that is all neuron nodes and all synapse nodes.
    
    Returns:
    
    a collection of all persistent nodes
  - resetColors
```
public void resetColors()
```
    Called by Network preferences as preferences are changed. Iterates through screen elements and resets relevant colors.
  - resetSynapseDiameters
```
public void resetSynapseDiameters()
```
    Called by Network preferences as preferences are changed. Iterates through screen elemenets and resets relevant colors.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.awt.Component
  - debugString
```
public java.lang.String debugString()
```
  - getNetwork
```
public Network getNetwork()
```
    Returns:
    
    Returns the Network.
  - setNetwork
```
public void setNetwork(Network network)
```
    Set Root network.
    
    Parameters:
    
    network - The Network to set.
  - getLastClickedPosition
```
public java.awt.geom.Point2D getLastClickedPosition()
```
    Returns:
    
    Returns the lastClickedPosition.
  - zoomToFitPage
```
public void zoomToFitPage(boolean forceZoom)
```
    Rescales the camera so that all objects in the canvas can be seen. Compare "zoom to fit page" in draw programs.
    
    Parameters:
    
    forceZoom - if true force the zoom to happen
  - setLastClickedPosition
```
public void setLastClickedPosition(java.awt.geom.Point2D lastLeftClicked)
```
    Set the last position clicked on screen.
    
    Parameters:
    
    lastLeftClicked - The lastClickedPosition to set.
  - modelCleared
```
public void modelCleared(NetworkEvent e)
```
    Parameters:
    
    e -
    
    See Also:
    
    NetworkListener
  - syncToModel
```
public void syncToModel()
```
    Synchronize model and view.
  - unGroup
```
public void unGroup(ViewGroupNode vgn,
                    boolean selectConstituents)
```
    Ungroup specified object.
    
    Parameters:
    
    vgn - the group to remove.
    
    selectConstituents - whether to select the grouped items or not.
  - groupSelectedObjects
```
public void groupSelectedObjects()
```
    Create a group of GUI objects.
  - setLastSelectedNeuron
```
public void setLastSelectedNeuron(NeuronNode lastSelectedNeuron)
```
    Parameters:
    
    lastSelectedNeuron - The lastSelectedNeuron to set.
  - getLastSelectedNeuron
```
public NeuronNode getLastSelectedNeuron()
```
    Returns:
    
    Returns the lastSelectedNeuron.
  - repaint
```
public void repaint()
```
    Overrides:
    
    repaint in class java.awt.Component
    
    See Also:
    
    PCanvas
  - getAutoZoomMode
```
public boolean getAutoZoomMode()
```
    Returns:
    
    Auto zoom mode.
  - setAutoZoomMode
```
public void setAutoZoomMode(boolean autoZoomMode)
```
    Parameters:
    
    autoZoomMode - Auto zoom mode.
  - getInOutMode
```
public boolean getInOutMode()
```
    Returns:
    
    Returns the in out mode.
  - getNumberOfPastes
```
public double getNumberOfPastes()
```
    Returns:
    
    Returns the numberOfPastes.
  - setNumberOfPastes
```
public void setNumberOfPastes(double numberOfPastes)
```
    Parameters:
    
    numberOfPastes - The numberOfPastes to set.
  - getShowSubnetOutline
```
public boolean getShowSubnetOutline()
```
    Returns:
    
    Returns show subnet outline.
  - setShowSubnetOutline
```
public void setShowSubnetOutline(boolean showSubnetOutline)
```
    Parameters:
    
    showSubnetOutline - Sets Show subnet outline.
  - getShowTime
```
public boolean getShowTime()
```
    Returns:
    
    Returns Show time.
  - setShowTime
```
public void setShowTime(boolean showTime)
```
    Parameters:
    
    showTime - Sets the show time.
  - incrementSelectedObjects
```
public void incrementSelectedObjects()
```
    Increases neuron and synapse activation levels.
  - decrementSelectedObjects
```
public void decrementSelectedObjects()
```
    Decreases neuron and synapse activation levels.
  - contextualIncrementSelectedObjects
```
public void contextualIncrementSelectedObjects()
```
    Invoke contextual increment (which respects neuron specific rules) on selected objects.
  - contextualDecrementSelectedObjects
```
public void contextualDecrementSelectedObjects()
```
    Invoke contextual decrement (which respects neuron specific rules) on selected objects.
  - nudge
```
protected void nudge(int offsetX,
                     int offsetY)
```
    Nudge selected objects.
    
    Parameters:
    
    offsetX - amount to nudge in the x direction (multiplied by nudgeAmount)
    
    offsetY - amount to nudge in the y direction (multiplied by nudgeAmount)
  - closeNetwork
```
public void closeNetwork()
```
    Close model Network.
  - getEditToolBar
```
public CustomToolBar getEditToolBar()
```
    Returns:
    
    Returns the edit tool bar.
  - getRunToolBar
```
public CustomToolBar getRunToolBar()
```
    Returns:
    
    Returns run tool bar.
  - getMainToolBar
```
public CustomToolBar getMainToolBar()
```
    Returns:
    
    Returns the main tool bar.
  - clearSourceElements
```
public void clearSourceElements()
```
    Clear all source elements.
  - setSourceElements
```
public void setSourceElements()
```
    Set selected elements to be source elements (with red rectangles around them).
  - setWeightsVisible
```
public void setWeightsVisible(boolean weightsVisible)
```
    Turns the displaying of loose synapses on and off (for performance increase or visual clarity).
    
    Parameters:
    
    weightsVisible - if true loose weights should be visible
  - getWeightsVisible
```
public boolean getWeightsVisible()
```
    Returns:
    
    turn synapse nodes on.
  - setPrioritiesVisible
```
public void setPrioritiesVisible(boolean prioritiesOn)
```
    Turns the displaying of neuron priorities on or off.
    
    Parameters:
    
    prioritiesOn - whether to show priorities or not
  - setHierarchyPanelVisible
```
public void setHierarchyPanelVisible(boolean showIt)
```
    Set the visibility of the hiearchy panel.
    
    Parameters:
    
    showIt - whether it should be visible or not
  - getPrioritiesVisible
```
public boolean getPrioritiesVisible()
```
    Returns:
    
    the prioritiesVisible
  - getSourceModelNeurons
```
public java.util.ArrayList<Neuron> getSourceModelNeurons()
```
    Returns:
    
    the model source neurons (used in connecting groups of neurons)
  - setPasteDelta
```
public void setPasteDelta()
```
    Set the offset used in multiple pastes.
  - getBeginPosition
```
public java.awt.geom.Point2D getBeginPosition()
```
    Returns:
    
    Returns the beginPosition.
  - setBeginPosition
```
public void setBeginPosition(java.awt.geom.Point2D beginPosition)
```
    Beginning position used in calculating offsets for multiple pastes.
    
    Parameters:
    
    beginPosition - The beginPosition to set.
  - getEndPosition
```
public java.awt.geom.Point2D getEndPosition()
```
    Returns:
    
    Returns the endPosition.
  - setEndPosition
```
public void setEndPosition(java.awt.geom.Point2D endPosition)
```
    Parameters:
    
    endPosition - The endPosition to set.
  - setPasteX
```
public void setPasteX(double pasteX)
```
    Parameters:
    
    pasteX - pasteX to set.
  - getPasteX
```
public double getPasteX()
```
    Returns:
    
    pasteX. pasteX.
  - setPasteY
```
public void setPasteY(double pasteY)
```
    Parameters:
    
    pasteY - paste_y to set.
  - getPasteY
```
public double getPasteY()
```
    Returns:
    
    pasteY pasteY;
  - isGuiOn
```
public boolean isGuiOn()
```
    Returns:
    
    Returns the guiOn.
  - setGuiOn
```
public void setGuiOn(boolean guiOn)
```
    Parameters:
    
    guiOn - The guiOn to set.
  - createToolTip
```
public javax.swing.JToolTip createToolTip()
```
    Overridden so that multi-line tooltips can be used.
    
    Overrides:
    
    createToolTip in class javax.swing.JComponent
    
    Returns:
  - getActionManager
```
public NetworkActionManager getActionManager()
```
    Returns:
    
    the actionManager
  - getContextMenuAlt
```
public javax.swing.JPopupMenu getContextMenuAlt()
```
    Returns:
    
    the contextMenuAlt.
  - getTextHandle
```
public TextEventHandler getTextHandle()
```
    Returns:
    
    the textHandle.
  - getViewGroupNode
```
public ViewGroupNode getViewGroupNode()
```
    Returns:
    
    View Group Node.
  - componentUpdated
```
public void componentUpdated()
```
  - setTitle
```
public void setTitle(java.lang.String name)
```
    Parameters:
    
    name -
  - getNetworkDialog
```
public NetworkDialog getNetworkDialog(NetworkPanel networkPanel)
```
    Returns a NetworkDialog. Overriden by NetworkPanelDesktop, which returns a NetworkDialog with additional features used in Desktop version of Simbrain.
    
    Parameters:
    
    networkPanel - network panel
    
    Returns:
    
    subclass version of network dialog.
  - addMenuToSynapseGroupNode
```
public SynapseGroupNode addMenuToSynapseGroupNode(SynapseGroupNode node)
```
    Overriden by NetworkPanelDesktop to adorn node with coupling menus.
    
    Parameters:
    
    node - the SynapseGroupNode.
    
    Returns:
    
    the node. Does nothing here obviously.
  - getNeuronGroupDialog
```
public StandardDialog getNeuronGroupDialog(NeuronGroupNode node)
```
    Overridden by NetworkPanelDesktop to ensure modeless-ness relative to SimbrainDesktop.
    
    Parameters:
    
    node - the neuron group node to display the dialog for
    
    Returns:
    
    the dialog representing the neuron group node.
  - getSynapseGroupDialog
```
public StandardDialog getSynapseGroupDialog(SynapseGroupInteractionBox sgib)
```
    Creates a synapse group dialog from a synapse group interaction box, overrriden in NetworkPanelDesktop to make it modeless relative to the SimbrainDesktop.
    
    Parameters:
    
    sgib - must be a synapse group interaction box because SynapseGroupBidirectional does not inhereit from SynapseGroupNode and the interaction box is the only visual and interactable object with a 1:1 correspondence to synapse groups.
    
    Returns:
  - getNeuronDialog
```
public StandardDialog getNeuronDialog(java.util.Collection<NeuronNode> nns)
```
  - getSynapseDialog
```
public StandardDialog getSynapseDialog(java.util.Collection<SynapseNode> sns)
```
  - clearPanel
```
public void clearPanel()
```
    Remove all nodes from panel.
  - addInternalMenuBar
```
public void addInternalMenuBar()
```
    Adds an internal menu bar; used in applets.
  - isRunning
```
public boolean isRunning()
```
    Returns:
    
    the isRunning
  - setRunning
```
public void setRunning(boolean isRunning)
```
    Parameters:
    
    isRunning - the isRunning to set
  - initGui
```
public void initGui()
```
    Initialize the Gui. Intended to be called after the panel is loaded (in an applet's start() method, and by the network components postAddInit() method).
  - getCanvas
```
public org.piccolo2d.PCanvas getCanvas()
```
    Returns:
    
    the canvas
  - displayPanel
```
public GenericFrame displayPanel(javax.swing.JPanel panel,
                                 java.lang.String title)
```
    Display a panel in a dialog. This is overridden by the desktop version to display the panel within the Simbrain desktop.
    
    Parameters:
    
    panel - panel to display
    
    title - title for the frame
    
    Returns:
    
    reference to frame the panel will be displayed in.
  - displayPanelInWindow
```
public javax.swing.JDialog displayPanelInWindow(javax.swing.JPanel panel,
                                                java.lang.String title)
```
    A copy of displayPanel except returning a subclass of Window. Here to temporarily resolve ongoing conflict between classes using generic frame and classes using window.
    
    Parameters:
    
    panel - the display panel
    
    title - the title of the panel
    
    Returns:
    
    the new frame
  - getObjectNodeMap
```
public java.util.Map<java.lang.Object,org.piccolo2d.PNode> getObjectNodeMap()
```
    Returns:
    
    the objectNodeMap
  - getUndoManager
```
public UndoManager getUndoManager()
```
    Returns:
    
    the undoManager
  - getBackgroundColor
```
public static java.awt.Color getBackgroundColor()
```
    Returns:
    
    the backgroundColor
  - setBackgroundColor
```
public static void setBackgroundColor(java.awt.Color backgroundColor)
```
    Parameters:
    
    backgroundColor - the backgroundColor to set
  - getNudgeAmount
```
public static double getNudgeAmount()
```
    Returns:
    
    the nudgeAmount
  - setNudgeAmount
```
public static void setNudgeAmount(double nudgeAmount)
```
    Parameters:
    
    nudgeAmount - the nudgeAmount to set
  - getNeuronContextMenu
```
public javax.swing.JPopupMenu getNeuronContextMenu(Neuron neuron)
```
    Creates the context menu for neurons. Overridden by NetworkPanelDesktop which adds a coupling menu.
    
    Parameters:
    
    neuron - neuron which needs a menu
    
    Returns:
    
    the context menu
  - getSynapseContextMenu
```
public javax.swing.JPopupMenu getSynapseContextMenu(Synapse synapse)
```
  - getNeuronGroupProducerMenu
```
public javax.swing.JMenu getNeuronGroupProducerMenu(NeuronGroup neuronGroup)
```
    Creates the producer menu for neuron groups. Null if the network panel is not in a desktop environment. Overridden by NetworkPanelDesktop which has access to workspace level coupling menus.
    
    Parameters:
    
    neuronGroup - the neuron group that can produce vectors for couplings.
    
    Returns:
    
    the producer menu
  - getNeuronGroupConsumerMenu
```
public javax.swing.JMenu getNeuronGroupConsumerMenu(NeuronGroup neuronGroup)
```
    Creates the consumer menu for neuron groups. Null if the network panel is not in a desktop environment. Overridden by NetworkPanelDesktop which has access to workspace level coupling menus.
    
    Parameters:
    
    neuronGroup - the neuron group that can consume vectors for couplings.
    
    Returns:
    
    the consumer menu
  - getSynapseGroupProducerMenu
```
public javax.swing.JMenu getSynapseGroupProducerMenu(SynapseGroup synapseGroup)
```
    Creates the producer menu for synapse groups. Null if the network panel is not in a desktop environment. Overridden by NetworkPanelDesktop which has access to workspace level coupling menus.
    
    Parameters:
    
    synapseGroup - the neuron group that can produce vectors for couplings.
    
    Returns:
    
    the producer menu
  - getSynapseGroupConsumerMenu
```
public javax.swing.JMenu getSynapseGroupConsumerMenu(SynapseGroup synapseGroup)
```
    Creates the consumer menu for synapse groups. Null if the network panel is not in a desktop environment. Overridden by NetworkPanelDesktop which has access to workspace level coupling menus.
    
    Parameters:
    
    synapseGroup - the neuron group that can consume vectors for couplings.
    
    Returns:
    
    the consumer menu
  - getWhereToAdd
```
public java.awt.geom.Point2D.Double getWhereToAdd()
```
    Returns:
    
    the whereToAdd
  - getQuickConnector
```
public QuickConnectionManager getQuickConnector()
```
    Returns:
    
    the quickConnector
  - getUpdateComplete
```
public boolean getUpdateComplete()
```
  - setUpdateComplete
```
public void setUpdateComplete(boolean updateComplete)
```

Class NetworkPanel

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

Nested classes/interfaces inherited from class java.awt.Container

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JPanel

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_SPACING

actionManager

undoManager

neuronClampButton

synapseClampButton

neuronClampMenuItem

synapseClampMenuItem

Constructor Detail

NetworkPanel

Method Detail

updateTime

addNeuron

addNeuronsToPanel

createNetworkContextMenu

getContextMenu

createRunToolBar

createMainToolBar

createEditToolBar

createAlignMenu

createSpacingMenu

getEditMode

setEditMode

updateCursor

deleteSelectedObjects

copy

cut

paste

alignHorizontal

alignVertical

spaceHorizontal

spaceVertical

showSelectedNeuronProperties

showSelectedSynapseProperties

showTextPropertyDialog

clearSelection

selectAll

isSelectionEmpty

isSelected

getSelection

setSelection

toggleSelection

addSelection

addSelectionListener

removeSelectionListener

getSelectedNeurons

getSelectedSynapses

getSelectedNeuronGroups

getSelectedText

getSelectedModelNeurons

getSelectedModelSynapses

getSelectedModelNeuronGroups

getSourceModelGroups

getSelectedModelSynapseGroups

getSelectedModelElements

getNeuronNodes

getSynapseNodes

getTextNodes

getParentNodes

getSelectableNodes

getSelectedScreenElements

resetColors

resetSynapseDiameters