org.simbrain.network.gui.dialogs.synapse

Class AbstractSpikeResponsePanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.simbrain.network.gui.dialogs.synapse.AbstractSpikeResponsePanel

All Implemented Interfaces:

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

Direct Known Subclasses:

ConvolvedJumpAndDecayPanel, JumpAndDecayPanel, ProbabilisticSpikeResponderPanel, RiseAndDecayPanel, StepSpikerPanel

public abstract class AbstractSpikeResponsePanel
extends javax.swing.JPanel

AbstractSpikeResponsePanel.

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.HashMap<java.lang.String,AbstractSpikeResponsePanel>	RESPONDER_MAP A mapping of available spike responders to their respective panels.

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

Method Summary

Modifier and Type	Method and Description
void	addBottomText(java.lang.String text) Add notes or other text to bottom of panel.
void	addItem(java.lang.String text, javax.swing.JComponent comp) Adds an item.
void	addItemLabel(javax.swing.JLabel text, javax.swing.JComponent comp) Adds an item label.
abstract void	commitChanges(java.util.Collection<Synapse> synapses) Called externally when the dialog is closed, to commit any changes made.
abstract void	commitChanges(Synapse synapse) Called externally when the dialog is closed, to commit any changes made.
abstract AbstractSpikeResponsePanel	deepCopy()
abstract void	fillDefaultValues() Populate fields with default data.
abstract void	fillFieldValues(java.util.List<SpikeResponder> spikeResponderList) Populate fields with current data.
LabelledItemPanel	getMainPanel()
abstract SpikeResponder	getPrototypeResponder()
static java.lang.String[]	getResponderList()
protected boolean	isReplace() Are we replacing rules or editing them? Replacing happens when commitChanges(Collection) is called on a synapse panel whose rule is different from the rules of the synapses being edited.
void	setMainPanel(LabelledItemPanel mainPanel)
protected void	setReplace(boolean replace) Tells this panel whether it is going to be editing spike responders, or creating new ones and replacing the spike responders of each of the synapses being edited.
protected abstract void	writeValuesToRules(java.util.Collection<Synapse> synapses) Used internally to actually write all changes to the spike responders of a given list of synapses.

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

RESPONDER_MAP

public static final java.util.HashMap<java.lang.String,AbstractSpikeResponsePanel> RESPONDER_MAP

A mapping of available spike responders to their respective panels. Used as a reference (especially for combo-boxes) by GUI classes.

Constructor Detail

AbstractSpikeResponsePanel

public AbstractSpikeResponsePanel()

This method is the default constructor.

Method Detail

deepCopy

public abstract AbstractSpikeResponsePanel deepCopy()

addItem

public void addItem(java.lang.String text,
                    javax.swing.JComponent comp)

Adds an item.

Parameters:

text - label of item to add

comp - component to add

addItemLabel

public void addItemLabel(javax.swing.JLabel text,
                         javax.swing.JComponent comp)

Adds an item label.

Parameters:

text - label to add

comp - component to label

fillFieldValues

public abstract void fillFieldValues(java.util.List<SpikeResponder> spikeResponderList)

Populate fields with current data.

Parameters:

spikeResponderList - the list of spike responders being used to ascertain which values should fill their respective fields.

fillDefaultValues

public abstract void fillDefaultValues()

Populate fields with default data.

commitChanges

public abstract void commitChanges(Synapse synapse)

Called externally when the dialog is closed, to commit any changes made. Specifically, this version is typically used to commit changes to a synapse which will be used as a template and copied, since it only takes in one synapse. This typically occurs during the creation of multiple synapses.

Parameters:

synapse - the synapse to which spike responder changes will be committed

commitChanges

public abstract void commitChanges(java.util.Collection<Synapse> synapses)

Called externally when the dialog is closed, to commit any changes made. Specifically, this version is used in the editing process (rather than creation), as it takes in a whole list of synapses and commits changes to the spike responders of all of them in accordance with the values entered into the panel's fields. This method is meant to ensure that each synapse has the correct kind of spike responder, then pass the list to writeValuesToRules(Collection) to make the actual changes.

Parameters:

synapses - the synapses to which spike responder changes will be committed

writeValuesToRules

protected abstract void writeValuesToRules(java.util.Collection<Synapse> synapses)

Used internally to actually write all changes to the spike responders of a given list of synapses. Prior to using this method it must be the case that all synapses in the lists' spike responders are of the appropriate type, otherwise a ClassCastException will be thrown.

Parameters:

synapses - the synapses whose spike responders will be written to based on the values in their respective fields.

setReplace

protected void setReplace(boolean replace)

Tells this panel whether it is going to be editing spike responders, or creating new ones and replacing the spike responders of each of the synapses being edited.

Parameters:

replace - tell the panel if it's replacing responders or editing them

isReplace

protected boolean isReplace()

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

Returns:

replacing or editing

getResponderList

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

Returns:

the list of the names of the spike responders for combo-boxes

getPrototypeResponder

public abstract SpikeResponder getPrototypeResponder()

Returns:

the prototypical model rule represented by this panel.

addBottomText

public void addBottomText(java.lang.String text)

Add notes or other text to bottom of panel. Can be html formatted..

Parameters:

text - Text to be used for bottom of panel

getMainPanel

public LabelledItemPanel getMainPanel()

Returns:

the mainPanel

setMainPanel

public void setMainPanel(LabelledItemPanel mainPanel)

Parameters:

mainPanel - the mainPanel to set