gis2.scenario

Class ScenarioEditor

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

gis2.scenario.ScenarioEditor

All Implemented Interfaces:

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

public class ScenarioEditor
extends javax.swing.JPanel

A component for editing scenarios.

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
ScenarioEditor(javax.swing.JMenuBar menuBar) Construct a new ScenarioEditor.
ScenarioEditor(javax.swing.JMenuBar menuBar, GMLMap map, GisScenario scenario) Construct a new ScenarioEditor.

Method Summary

Modifier and Type	Method and Description
void	addEdit(javax.swing.undo.UndoableEdit edit) Register an undoable edit.
void	close() Close the editor.
GMLObjectInspector	getInspector() Get the object inspector.
GMLMap	getMap() Get the map.
GisScenario	getScenario() Get the scenario.
GMLMapViewer	getViewer() Get the map viewer.
void	load() Load a map and scenario by showing a file chooser dialog.
void	load(java.io.File dir) Load a map and scenario from a directory.
void	load(java.lang.String filename) Load a map and scenario from a directory.
static void	main(java.lang.String[] args) Entry point.
void	save() Save the scenario.
void	saveAs() Save the scenario.
void	setChanged() Register a change to the map.
void	setScenario(GMLMap newMap, GisScenario newScenario) Set the map and scenario.
void	updateOverlays() Update the overlay views.

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

Constructor Detail

ScenarioEditor

public ScenarioEditor(javax.swing.JMenuBar menuBar)

Construct a new ScenarioEditor.

Parameters:

menuBar - The menu bar to add menus to.

ScenarioEditor

public ScenarioEditor(javax.swing.JMenuBar menuBar,
                      GMLMap map,
                      GisScenario scenario)

Construct a new ScenarioEditor.

Parameters:

menuBar - The menu bar to add menus to.

map - The GMLMap to view.

scenario - The scenario to edit.

Method Detail

main

public static void main(java.lang.String[] args)

Entry point.

Parameters:

args - Command line arguments.

load

public void load()
          throws CancelledByUserException,
                 MapException,
                 ScenarioException,
                 ScenarioException

Load a map and scenario by showing a file chooser dialog.

Throws:

CancelledByUserException - If the user cancels the change due to unsaved changes.

MapException - If there is a problem reading the map.

ScenarioException - If there is a problem reading the scenario.

ScenarioException

load

public void load(java.lang.String filename)
          throws CancelledByUserException,
                 MapException,
                 ScenarioException,
                 ScenarioException

Load a map and scenario from a directory.

Parameters:

filename - The name of the file to read.

Throws:

CancelledByUserException - If the user cancels the change due to unsaved changes.

MapException - If there is a problem reading the map.

ScenarioException - If there is a problem reading the scenario.

ScenarioException

load

public void load(java.io.File dir)
          throws CancelledByUserException,
                 MapException,
                 ScenarioException,
                 ScenarioException

Load a map and scenario from a directory.

Parameters:

dir - The directory to read.

Throws:

CancelledByUserException - If the user cancels the change due to unsaved changes.

MapException - If there is a problem reading the map.

ScenarioException - If there is a problem reading the scenario.

ScenarioException

setScenario

public void setScenario(GMLMap newMap,
                        GisScenario newScenario)
                 throws CancelledByUserException

Set the map and scenario.

Parameters:

newMap - The new map.

newScenario - The new scenario.

Throws:

CancelledByUserException - If the user cancels the change due to unsaved changes.

getMap

public GMLMap getMap()

Get the map.

Returns:

The map.

getScenario

public GisScenario getScenario()

Get the scenario.

Returns:

The scenario.

save

public void save()
          throws ScenarioException

Save the scenario.

Throws:

ScenarioException - If there is a problem saving the scenario.

saveAs

public void saveAs()
            throws ScenarioException

Save the scenario.

Throws:

ScenarioException - If there is a problem saving the scenario.

close

public void close()
           throws CancelledByUserException

Close the editor.

Throws:

CancelledByUserException - If the user cancels the close due to unsaved changes."

getViewer

public GMLMapViewer getViewer()

Get the map viewer.

Returns:

The map viewer.

getInspector

public GMLObjectInspector getInspector()

Get the object inspector.

Returns:

The object inspector.

setChanged

public void setChanged()

Register a change to the map.

addEdit

public void addEdit(javax.swing.undo.UndoableEdit edit)

Register an undoable edit.

Parameters:

edit - The edit to add.

updateOverlays

public void updateOverlays()

Update the overlay views.