org.simbrain.network.gui.dialogs.neuron

Class AbstractNeuronRulePanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.simbrain.network.gui.dialogs.neuron.AbstractNeuronRulePanel

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractSigmoidalRulePanel, AdditiveRulePanel, AdExIFRulePanel, BinaryRulePanel, DecayRulePanel, HodgkinHuxleyRulePanel, IACRulePanel, IntegrateAndFireRulePanel, IzhikevichRulePanel, LinearRulePanel, LogisticGeneratorPanel, NakaRushtonRulePanel, PointNeuronRulePanel, RandomGeneratorPanel, RunningAverageRulePanel, SinusoidalGeneratorPanel, SpikingThresholdRulePanel, StochasticGeneratorPanel, ThreeValueRulePanel

public abstract class AbstractNeuronRulePanel
extends javax.swing.JPanel

AbstractNeuronPanel is the parent class for all panels used to set parameters of specific neuron rule types. Optimization has been emphasized for methods intended for neuron creation rather than editing on the assumption that the former will be far more common for large numbers of neurons.

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
static java.util.LinkedHashMap<java.lang.String,AbstractNeuronRulePanel>	GENERATOR_MAP Associations between names of activity generators and panels for editing them.
static java.util.LinkedHashMap<java.lang.String,AbstractNeuronRulePanel>	RULE_MAP Associations between names of rules and panels for editing them.

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
AbstractNeuronRulePanel() This method is the default constructor.

Method Summary

Modifier and Type	Method and Description
void	addBottomText(java.lang.String text) Override to add custom notes or other text to bottom of panel.
abstract void	commitChanges(java.util.List<Neuron> neurons) Called externally when the dialog is closed, to commit any changes made to many neurons simultaneously.
abstract void	commitChanges(Neuron neuron) Called to commit changes to a single neuron.
abstract void	fillDefaultValues() Populate fields with default data.
abstract void	fillFieldValues(java.util.List<NeuronUpdateRule> ruleList) Populate fields with current data.
static java.lang.String[]	getGeneratorlist()
protected abstract NeuronUpdateRule	getPrototypeRule() Each neuron panel contains a static final subclass of NeuronUpdateRule variable called a prototype rule.
static java.lang.String[]	getRulelist()
protected boolean	isReplace() Are we replacing rules or editing them? Replacing happens when commitChanges(List) is called on a neuron panel whose rule is different from the rules of the neurons being edited.
protected void	setReplace(boolean replace) Tells this panel whether it is going to be editing neuron update rules, or creating new ones and replacing the update rule of each of the neurons being edited.
protected abstract void	writeValuesToRules(java.util.List<Neuron> neurons) Edits neuron update rules that already exist.

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

Field Detail

RULE_MAP

public static final java.util.LinkedHashMap<java.lang.String,AbstractNeuronRulePanel> RULE_MAP

Associations between names of rules and panels for editing them.

GENERATOR_MAP

public static final java.util.LinkedHashMap<java.lang.String,AbstractNeuronRulePanel> GENERATOR_MAP

Associations between names of activity generators and panels for editing them.

Constructor Detail

AbstractNeuronRulePanel

public AbstractNeuronRulePanel()

This method is the default constructor.

Method Detail

fillFieldValues

public abstract void fillFieldValues(java.util.List<NeuronUpdateRule> ruleList)

Populate fields with current data.

Parameters:

ruleList - the list of rules being used to determine which values should be used to fill the fields with data.

fillDefaultValues

public abstract void fillDefaultValues()

Populate fields with default data.

commitChanges

public abstract void commitChanges(Neuron neuron)

Called to commit changes to a single neuron. Usually this is a template neuron intended to be copied for the purpose of creating many new neurons. Using this method to commit changes to many neurons is not recommended. Instead pass a list of the neurons to be changed into commitChanges.

Parameters:

neuron - the neuron to which changes are being committed to.

commitChanges

public abstract void commitChanges(java.util.List<Neuron> neurons)

Called externally when the dialog is closed, to commit any changes made to many neurons simultaneously. This method by default overwrites the neurons' update rules. To change this behavior set replacing to false , indicating to the panel that it is editing rather than changing/replacing existing neuron update rules.

Parameters:

neurons - the list of neurons which are being edited and to which changes based on the values in the fields of this panel will be committed

writeValuesToRules

protected abstract void writeValuesToRules(java.util.List<Neuron> neurons)

Edits neuron update rules that already exist. This is the alternative to replacing the rules and occurs when the neuron update rules being edited are the same type as the panel. replacing is the flag for whether this method is used for committing or the rules are deleted and replaced entirely, in which case this method is not called.

Parameters:

neurons - the neurons whose rules are being edited, not replaced.

addBottomText

public void addBottomText(java.lang.String text)

Override to add custom notes or other text to bottom of panel. Can be html formatted.

Parameters:

text - Text to be added

getPrototypeRule

protected abstract NeuronUpdateRule getPrototypeRule()

Each neuron panel contains a static final subclass of NeuronUpdateRule variable called a prototype rule. The specific subclass of NeuronUpdateRule corresponds to the rule specified by the panel name. Used so that other classes can query specific properties of the rule the panel edits. Also used internally to make deep copies.

Returns:

an instance of the neuron rule which corresponds to the panel.

isReplace

protected boolean isReplace()

Are we replacing rules or editing them? Replacing happens when commitChanges(List) is called on a neuron panel whose rule is different from the rules of the neurons being edited.

Returns:

replacing or editing

setReplace

protected void setReplace(boolean replace)

Tells this panel whether it is going to be editing neuron update rules, or creating new ones and replacing the update rule of each of the neurons being edited.

Parameters:

replace - used to tell the panel if it's being used to replace neuron update rules.

getRulelist

public static java.lang.String[] getRulelist()

Returns:

the rule list

getGeneratorlist

public static java.lang.String[] getGeneratorlist()

Returns:

the generator list