org.simbrain.workspace.gui

Class GuiComponent<E extends WorkspaceComponent>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.simbrain.workspace.gui.GuiComponent<E>

Type Parameters:

E - the type of the workspace component.

All Implemented Interfaces:

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

Direct Known Subclasses:

BarChartGui, ConsoleDesktopComponent, DataWorldDesktopComponent, DisplayComponentDesktopGui, DocViewerDesktopComponent, GameDesktopComponent, HistogramGui, NetworkDesktopComponent, OdorWorldDesktopComponent, OscWorldDesktopComponent, PieChartGui, ProjectionGui, RasterPlotGui, ReaderComponentDesktopGui, ScatterPlotGui, TimeSeriesPlotGui, VisionWorldDesktopComponent

public abstract class GuiComponent<E extends WorkspaceComponent>
extends javax.swing.JPanel

A gui view on a WorkspaceComponent.

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

Constructor Summary

Constructors

Constructor and Description
GuiComponent(GenericFrame frame, E workspaceComponent) Construct a workspace component.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this view.
protected abstract void	closing() Perform cleanup after closing.
SimbrainDesktop	getDesktop()
java.lang.String	getName() Return name of underlying component.
GenericFrame	getParentFrame() Returns the parent from of this view.
java.lang.String	getSimpleName() Retrieves a simple version of a component name from its class, e.g.
E	getWorkspaceComponent() Returns the workspace component wrapped by this instance.
static GuiComponent<?>	open(WorkspaceComponent component, java.io.InputStream istream, java.lang.String name) Creates a new desktop component from the provided stream.
void	postAddInit() If any initialization is needed after adding this component to workspace.
void	save() Save vs.
void	save(java.io.OutputStream ostream) Writes the bounds of this desktop component to the provided stream.
void	setDesktop(SimbrainDesktop desktop) TODO: This should really be set at construction time, but that would require deep changes so this should suffice for now.
void	setParentFrame(GenericFrame parentFrame) Sets the parent frame of this view.
void	setTitle(java.lang.String name)
boolean	showHasChangedDialog() Checks to see if anything has changed and then offers to save if true.
void	showOpenFileDialog() Calls up a dialog for opening a workspace component.
void	showSaveFileDialog() Show the dialog for saving a workspace component.
protected void	update() Optional gui update method, which can be overridden for custom GUI update needs.

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

Constructor Detail

GuiComponent

public GuiComponent(GenericFrame frame,
                    E workspaceComponent)

Construct a workspace component.

Parameters:

frame - the parent frame.

workspaceComponent - the component to wrap.

Method Detail

postAddInit

public void postAddInit()

If any initialization is needed after adding this component to workspace.

close

public void close()

Closes this view.

closing

protected abstract void closing()

Perform cleanup after closing. TODO: Move to model?

update

protected void update()

Optional gui update method, which can be overridden for custom GUI update needs. NOTE: This update method is _not_ automatically called when the workspace component is updated. A call to fireUpdateEvent() must happen in the workspace component.

showOpenFileDialog

public void showOpenFileDialog()

Calls up a dialog for opening a workspace component.

showSaveFileDialog

public void showSaveFileDialog()

Show the dialog for saving a workspace component.

save

public void save()

Save vs. save-as. Saves the currentfile.

save

public void save(java.io.OutputStream ostream)
          throws java.io.IOException

Writes the bounds of this desktop component to the provided stream.

Parameters:

ostream - the stream to write to

Throws:

java.io.IOException - if an IO error occurs

open

public static GuiComponent<?> open(WorkspaceComponent component,
                                   java.io.InputStream istream,
                                   java.lang.String name)

Creates a new desktop component from the provided stream.

Parameters:

component - the component to create the desktop component for.

istream - the inputstream containing the serialized data.

name - the name of the desktop component.

Returns:

a new component.

showHasChangedDialog

public boolean showHasChangedDialog()

Checks to see if anything has changed and then offers to save if true.

Returns:

true if user cancels

getName

public java.lang.String getName()

Return name of underlying component.

Overrides:

getName in class java.awt.Component

Returns:

the name of underlying component.

setTitle

public void setTitle(java.lang.String name)

Parameters:

name - the name to set

getSimpleName

public java.lang.String getSimpleName()

Retrieves a simple version of a component name from its class, e.g. "Network" from "org.simbrain.network.NetworkComponent"/

Returns:

the simple name.

getWorkspaceComponent

public E getWorkspaceComponent()

Returns the workspace component wrapped by this instance.

Returns:

the workspace component wrapped by this instance.

setParentFrame

public void setParentFrame(GenericFrame parentFrame)

Sets the parent frame of this view.

Parameters:

parentFrame - the new parent.

getParentFrame

public GenericFrame getParentFrame()

Returns the parent from of this view.

Returns:

the parent from of this view.

getDesktop

public SimbrainDesktop getDesktop()

Returns:

the desktop

setDesktop

public void setDesktop(SimbrainDesktop desktop)

TODO: This should really be set at construction time, but that would require deep changes so this should suffice for now.

Parameters:

desktop - the desktop to set