org.simbrain.network.gui.dialogs.neuron

Class NeuronPropertiesPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.simbrain.network.gui.dialogs.neuron.NeuronPropertiesPanel

All Implemented Interfaces:

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

public class NeuronPropertiesPanel
extends javax.swing.JPanel
implements EditablePanel

The basic neuron info panel and neuron update settings panel are frequently used together and depend on each other. This panel combines the two and handles changes to one being applied to the other.

Author:

Zach Tosi

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 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

Method Summary

Modifier and Type	Method and Description
boolean	commitChanges() Uses the data in the fields of the panel which implements this to alter the data of an appropriate model object accordingly.
static NeuronPropertiesPanel	createCombinedNeuronInfoPanel(java.util.List<Neuron> neuronList, java.awt.Window parent) Creates a combined neuron info panel, which includes the basic neuron info panel and a neuron update settings panel.
static NeuronPropertiesPanel	createCombinedNeuronInfoPanel(java.util.List<Neuron> neuronList, java.awt.Window parent, boolean nuspExtendedDisplay) Creates a combined neuron info panel, which includes the basic neuron info panel and a neuron update settings panel.
static NeuronPropertiesPanel	createCombinedNeuronInfoPanel(java.util.List<Neuron> neuronList, java.awt.Window parent, boolean nuspExtendedDisplay, boolean displayIDInfo) Creates a combined neuron info panel, which includes the basic neuron info panel and a neuron update settings panel.
void	fillFieldValues() Initialize the panel with field values.
NeuronPropertiesSimple	getNeuroninfoPanel()
javax.swing.JPanel	getPanel() This interface is only meant to be implemented by panels which edit model values.
SpecificNeuronRulePanel	getUpdateInfoPanel()
void	setNeuroninfoPanel(NeuronPropertiesSimple neuroninfoPanel)
void	setUpdateInfoPanel(SpecificNeuronRulePanel updateInfoPanel)

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, createToolTip, 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, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

createCombinedNeuronInfoPanel

public static NeuronPropertiesPanel createCombinedNeuronInfoPanel(java.util.List<Neuron> neuronList,
                                                                  java.awt.Window parent)

Creates a combined neuron info panel, which includes the basic neuron info panel and a neuron update settings panel. The panel is automatically built and laid out, such that it is immediately ready for display.

Parameters:

neuronList - the list of neurons either being edited (editing) or being used to fill the panel with default values (creation).

parent - the parent window, made available for easy resizing.

Returns:

createCombinedNeuronInfoPanel

public static NeuronPropertiesPanel createCombinedNeuronInfoPanel(java.util.List<Neuron> neuronList,
                                                                  java.awt.Window parent,
                                                                  boolean nuspExtendedDisplay)

Creates a combined neuron info panel, which includes the basic neuron info panel and a neuron update settings panel. The panel is automatically built and laid out, such that it is immediately ready for display. The nusp (neuron update settings panel)'s display state is that extra data is by default hidden.

Parameters:

neuronList - the list of neurons either being edited (editing) or being used to fill the panel with default values (creation).

parent - the parent window, made available for easy resizing.

nuspExtendedDisplay - whether or not to display the neuron update rule's details initially

Returns:

createCombinedNeuronInfoPanel

public static NeuronPropertiesPanel createCombinedNeuronInfoPanel(java.util.List<Neuron> neuronList,
                                                                  java.awt.Window parent,
                                                                  boolean nuspExtendedDisplay,
                                                                  boolean displayIDInfo)

Creates a combined neuron info panel, which includes the basic neuron info panel and a neuron update settings panel. The panel is automatically built and laid out, such that it is immediately ready for display. The nusp (neuron update settings panel)'s display state is that extra data is by default hidden. It is incomprehensible to set displayIDInfo to true if multiple neurons are going to be displayed. This is here for cases where the number of neurons is itself a variable and normally ID information would be displayed because there is only one neuron in the list.

Parameters:

neuronList - the list of neurons either being edited (editing) or being used to fill the panel with default values (creation).

parent - the parent window, made available for easy resizing.

nuspExtendedDisplay - whether or not to display the neuron update

displayIDInfo - manually sets whether or not neuron id information is displayed. rule's details initially

Returns:

commitChanges

public boolean commitChanges()

Uses the data in the fields of the panel which implements this to alter the data of an appropriate model object accordingly. Specifically: Commits changes in the basic neuron info panel and the neuron update settings panel.

Specified by:

commitChanges in interface EditablePanel

Returns:

whether or not the commit was successful

getPanel

public javax.swing.JPanel getPanel()

This interface is only meant to be implemented by panels which edit model values. However, if some class wants to have an instance of this interface, there must be some way to retrieve the panel it corresponds to.

Specified by:

getPanel in interface EditablePanel

Returns:

the panel implementing this interface

getNeuroninfoPanel

public NeuronPropertiesSimple getNeuroninfoPanel()

setNeuroninfoPanel

public void setNeuroninfoPanel(NeuronPropertiesSimple neuroninfoPanel)

getUpdateInfoPanel

public SpecificNeuronRulePanel getUpdateInfoPanel()

setUpdateInfoPanel

public void setUpdateInfoPanel(SpecificNeuronRulePanel updateInfoPanel)

fillFieldValues

public void fillFieldValues()

Description copied from interface: EditablePanel

Initialize the panel with field values.

Specified by:

fillFieldValues in interface EditablePanel