org.simbrain.world.odorworld
Class OdorWorldFrame

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JInternalFrame
                  org.simbrain.world.odorworld.OdorWorldFrame

All Implemented Interfaces:

ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, InternalFrameListener, RootPaneContainer, WindowConstants

public class OdorWorldFrame
extends JInternalFrame
implements ActionListener, InternalFrameListener

WorldPanel is the container for the world component. Handles toolbar buttons, and serializing of world data. The main environment codes is in OdorWorld.

See Also:

Serialized Form

Nested Class Summary

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

JInternalFrame.AccessibleJInternalFrame, JInternalFrame.JDesktopIcon

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JInternalFrame

closable, CONTENT_PANE_PROPERTY, desktopIcon, FRAME_ICON_PROPERTY, frameIcon, GLASS_PANE_PROPERTY, iconable, IS_CLOSED_PROPERTY, IS_ICON_PROPERTY, IS_MAXIMUM_PROPERTY, IS_SELECTED_PROPERTY, isClosed, isIcon, isMaximum, isSelected, LAYERED_PANE_PROPERTY, maximizable, MENU_BAR_PROPERTY, resizable, ROOT_PANE_PROPERTY, rootPane, rootPaneCheckingEnabled, title, TITLE_PROPERTY

Fields inherited from class javax.swing.JComponent

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

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

OdorWorldFrame()
Default constructor.

OdorWorldFrame(Workspace ws)
Construct a new world panel.

Method Summary

void	actionPerformed(ActionEvent e) Responds to actions performed.
ArrayList	getAgentList() Return the arraylist of agents.
File	getCurrentFile() Return the current file.
String	getGenericPath()
OdorWorldFrameMenu	getMenu()
String	getPath()
int	getTheHeight()
int	getTheWidth()
Workspace	getWorkspace()
OdorWorld	getWorld() Return the odor world.
int	getXpos()
int	getYpos()
void	init() Initializes frame.
void	initBounds() For Castor.
void	internalFrameActivated(InternalFrameEvent e) Tasks to perform when frame is activated.
void	internalFrameClosed(InternalFrameEvent e) Tasks to perform when frame is closed.
void	internalFrameClosing(InternalFrameEvent e) Tasks to perform when frame is closing.
void	internalFrameDeactivated(InternalFrameEvent e) Tasks to perform when frame is deactivated.
void	internalFrameDeiconified(InternalFrameEvent e) Tasks to peform when frame is deiconified.
void	internalFrameIconified(InternalFrameEvent e) Tasks to perform when frame is iconified.
void	internalFrameOpened(InternalFrameEvent e) Tasks to peform when frame is opened.
boolean	isChangedSinceLastSave()
boolean	openWorld() Show the dialog for choosing a world to open.
void	readWorld(File theFile) Read a world from a world-wld file.
void	saveWorld() Opens a file-save dialog and saves world information to the specified file Called by "Save As".
void	saveWorld(File worldFile) Save a specified file Called by "save".
void	setChangedSinceLastSave(boolean hasChangedSinceLastSave)
void	setMenu(OdorWorldFrameMenu menu) Sets odor world frame menu.
void	setPath(String path)
void	setTheHeight(int theHeight)
void	setTheWidth(int theWidth)
void	setWorkspace(Workspace workspace)
void	setWorldName(String name) Sets the name of the world.
void	setXpos(int xpos)
void	setYpos(int ypos)

Methods inherited from class javax.swing.JInternalFrame

addImpl, addInternalFrameListener, createRootPane, dispose, doDefaultCloseAction, fireInternalFrameEvent, getAccessibleContext, getContentPane, getDefaultCloseOperation, getDesktopIcon, getDesktopPane, getFocusCycleRootAncestor, getFocusOwner, getFrameIcon, getGlassPane, getInternalFrameListeners, getJMenuBar, getLayer, getLayeredPane, getMenuBar, getMostRecentFocusOwner, getNormalBounds, getRootPane, getTitle, getUI, getUIClassID, getWarningString, hide, isClosable, isClosed, isFocusCycleRoot, isIcon, isIconifiable, isMaximizable, isMaximum, isResizable, isRootPaneCheckingEnabled, isSelected, moveToBack, moveToFront, pack, paintComponent, paramString, remove, removeInternalFrameListener, reshape, restoreSubcomponentFocus, setClosable, setClosed, setContentPane, setDefaultCloseOperation, setDesktopIcon, setFocusCycleRoot, setFrameIcon, setGlassPane, setIcon, setIconifiable, setJMenuBar, setLayer, setLayer, setLayeredPane, setLayout, setMaximizable, setMaximum, setMenuBar, setNormalBounds, setResizable, setRootPane, setRootPaneCheckingEnabled, setSelected, setTitle, setUI, show, toBack, toFront, 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, 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, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, 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, 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, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusBackward, 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, 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, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

OdorWorldFrame

public OdorWorldFrame()

Default constructor.

OdorWorldFrame

public OdorWorldFrame(Workspace ws)

Construct a new world panel. Set up the toolbars. Create an instance of a world object.

Parameters:

ws - the workspace associated with this frame

Method Detail

init

public void init()

Initializes frame.

getCurrentFile

public File getCurrentFile()

Return the current file.

Returns:

Current file

getWorld

public OdorWorld getWorld()

Return the odor world.

Returns:

Odor world

openWorld

public boolean openWorld()

Show the dialog for choosing a world to open.

Returns:

true if file exists

readWorld

public void readWorld(File theFile)

Read a world from a world-wld file.

Parameters:

theFile - the wld file containing world information

saveWorld

public void saveWorld()

Opens a file-save dialog and saves world information to the specified file Called by "Save As".

saveWorld

public void saveWorld(File worldFile)

Save a specified file Called by "save".

Parameters:

worldFile - the file to save to

actionPerformed

public void actionPerformed(ActionEvent e)

Responds to actions performed.

Specified by:

actionPerformed in interface ActionListener

Parameters:

e - Action event

internalFrameOpened

public void internalFrameOpened(InternalFrameEvent e)

Tasks to peform when frame is opened.

Specified by:

internalFrameOpened in interface InternalFrameListener

Parameters:

e - Internal frame event

internalFrameClosing

public void internalFrameClosing(InternalFrameEvent e)

Tasks to perform when frame is closing.

Specified by:

internalFrameClosing in interface InternalFrameListener

Parameters:

e - Internal frame event

internalFrameClosed

public void internalFrameClosed(InternalFrameEvent e)

Tasks to perform when frame is closed.

Specified by:

internalFrameClosed in interface InternalFrameListener

Parameters:

e - Internal frame event

internalFrameIconified

public void internalFrameIconified(InternalFrameEvent e)

Tasks to perform when frame is iconified.

Specified by:

internalFrameIconified in interface InternalFrameListener

Parameters:

e - Internal frame event

internalFrameDeiconified

public void internalFrameDeiconified(InternalFrameEvent e)

Tasks to peform when frame is deiconified.

Specified by:

internalFrameDeiconified in interface InternalFrameListener

Parameters:

e - Internal frame event

internalFrameActivated

public void internalFrameActivated(InternalFrameEvent e)

Tasks to perform when frame is activated.

Specified by:

internalFrameActivated in interface InternalFrameListener

Parameters:

e - Internal frame event

internalFrameDeactivated

public void internalFrameDeactivated(InternalFrameEvent e)

Tasks to perform when frame is deactivated.

Specified by:

internalFrameDeactivated in interface InternalFrameListener

Parameters:

e - Internal frame event

setPath

public void setPath(String path)

Parameters:

path - The path to set; used in persistence.

getPath

public String getPath()

Returns:

path information; used in persistence

getGenericPath

public String getGenericPath()

Returns:

platform-specific path

getWorkspace

public Workspace getWorkspace()

Returns:

Returns the workspace.

setWorkspace

public void setWorkspace(Workspace workspace)

Parameters:

workspace - The workspace to set.

initBounds

public void initBounds()

For Castor. Turn Component bounds into separate variables.

getXpos

public int getXpos()

Returns:

Returns the xpos.

setXpos

public void setXpos(int xpos)

Parameters:

xpos - The xpos to set.

getYpos

public int getYpos()

Returns:

Returns the ypos.

setYpos

public void setYpos(int ypos)

Parameters:

ypos - The ypos to set.

getTheHeight

public int getTheHeight()

Returns:

Returns the theHeight.

setTheHeight

public void setTheHeight(int theHeight)

Parameters:

theHeight - The theHeight to set.

getTheWidth

public int getTheWidth()

Returns:

Returns the theWidth.

setTheWidth

public void setTheWidth(int theWidth)

Parameters:

theWidth - The theWidth to set.

getAgentList

public ArrayList getAgentList()

Return the arraylist of agents.

Returns:

List of agents

setWorldName

public void setWorldName(String name)

Sets the name of the world.

Parameters:

name - String value to be set

isChangedSinceLastSave

public boolean isChangedSinceLastSave()

Returns:

Returns changedSinceLastSave.

setChangedSinceLastSave

public void setChangedSinceLastSave(boolean hasChangedSinceLastSave)

Parameters:

hasChangedSinceLastSave - The changedSinceLastSave to set.

getMenu

public OdorWorldFrameMenu getMenu()

Returns:

Odor world frame menu.

setMenu

public void setMenu(OdorWorldFrameMenu menu)

Sets odor world frame menu.

Parameters:

menu - Menu