de.hawhamburg.reachability.ui.frame.simulation

Class ReachabilitySimulationStoryUI

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

de.hawhamburg.reachability.ui.UI

de.hawhamburg.reachability.ui.frame.simulation.ReachabilitySimulationStoryUI

All Implemented Interfaces:

StopableObject, java.awt.event.ActionListener, java.awt.event.KeyListener, java.awt.event.MouseListener, java.awt.event.WindowListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class ReachabilitySimulationStoryUI
extends UI

Displays all sent events of the current simulation defined by the supplied simulation feeder to the user.

This user interfaces displays all sent events of the supplied simulation feeder. It gives the user the ability to inspect the simulation more detailed.

Version:

"2013.42"

Author:

"Malte Kantak <malte.kantak@hotmail.de>"

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JFrame.AccessibleJFrame

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

java.awt.Frame.AccessibleAWTFrame

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

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

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
private SensorDataFeeder	feeder The active simulation feeder as SensorDataFeeder.
private int	lastUserScrollIndex The last scroll bar index the user has focused.
private long	lastUserScrollTime The last time the user has used the scroll bar function.
private static long	serialVersionUID Some unique serial version id.
private javax.swing.JTextArea	story The JTextArea which holds the displayed story.

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

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

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
ReachabilitySimulationStoryUI(javax.swing.JFrame sourceWindow, SensorDataFeeder runningFeeder) Creates and builds a new ReachabilitySimulationStoryUI which displays more detailed the sended events of the running simulation.
ReachabilitySimulationStoryUI(SensorDataFeeder runningFeeder) Creates and builds a new ReachabilitySimulationStoryUI by using ReachabilitySimulationStoryUI(JFrame, SensorDataFeeder) without calling panel.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e)
protected void	addMenu() This method adds a menu to the user interface.
private void	addStoryRow(java.util.SortedMap<SensorDataFeederItem,java.lang.String> storyMap) Refreshes the content of the story by the actual storyMap and handles correct scroll position of this panel afterwards.
private java.awt.GridLayout	getGrid(int rowsIn) Returns a user interface grid.
int	getLastUserScrollActionIndex() Returns the last scroll index the user positioned the display panel.
long	getLastUserScrollActionTime() Returns the last time index the user triggered a scroll event related to the display panel.
void	refresh(boolean refresh) Builds the user interface.
void	shutDown() Shuts the object down.
void	updateUserScrollAction(int index) Registers a new user triggered scroll action related to the display panel.

Methods inherited from class de.hawhamburg.reachability.ui.UI

addBody, autoPosition, build, fixBounds, getBody, getCommonConfigValue, getConfigValue, getConfigValueAsInteger, getFrameConfigValue, getFrameConfigValueAsInteger, getGrid, getId, getParentWindow, getTimer, getWindowHeight, getWindowWidth, infoDialog, isStandalone, keyPressed, keyReleased, keyTyped, killWindow, loadConfig, loadLocalConfig, mouseClicked, mouseEntered, mouseExited, mousePressed, mouseReleased, refresh, setWindowHeight, setWindowWidth, stopTimer, windowActivated, windowClosed, windowClosing, windowDeactivated, windowDeiconified, windowIconified, windowOpened

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hawhamburg.reachability.StopableObject

isActive

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

serialVersionUID

private static final long serialVersionUID

Some unique serial version id.

See Also:

Constant Field Values

feeder

private SensorDataFeeder feeder

The active simulation feeder as SensorDataFeeder.

lastUserScrollIndex

private int lastUserScrollIndex

The last scroll bar index the user has focused.

lastUserScrollTime

private long lastUserScrollTime

The last time the user has used the scroll bar function.

story

private javax.swing.JTextArea story

The JTextArea which holds the displayed story.

Constructor Detail

ReachabilitySimulationStoryUI

public ReachabilitySimulationStoryUI(javax.swing.JFrame sourceWindow,
                             SensorDataFeeder runningFeeder)

Creates and builds a new ReachabilitySimulationStoryUI which displays more detailed the sended events of the running simulation.

Parameters:

sourceWindow - The calling panel which will be notified, when the simulation was started as Object implementing JFrame.

runningFeeder - The active simulation feeder as SensorDataFeeder.

ReachabilitySimulationStoryUI

public ReachabilitySimulationStoryUI(SensorDataFeeder runningFeeder)

Creates and builds a new ReachabilitySimulationStoryUI by using ReachabilitySimulationStoryUI(JFrame, SensorDataFeeder) without calling panel.

Parameters:

runningFeeder - The active simulation feeder as SensorDataFeeder.

Method Detail

addMenu

protected final void addMenu()

This method adds a menu to the user interface.

Specified by:

addMenu in class UI

getGrid

private java.awt.GridLayout getGrid(int rowsIn)

Returns a user interface grid.

Parameters:

rowsIn - Amount of rows to be displayed

Returns:

Returns a user interface grid.

addStoryRow

private void addStoryRow(java.util.SortedMap<SensorDataFeederItem,java.lang.String> storyMap)

Refreshes the content of the story by the actual storyMap and handles correct scroll position of this panel afterwards.

Parameters:

storyMap - The actual sent events as SortedMap of SensorDataFeederItem to String.

updateUserScrollAction

public final void updateUserScrollAction(int index)

Registers a new user triggered scroll action related to the display panel.

Parameters:

index - The new index of the scroll event.

getLastUserScrollActionTime

public final long getLastUserScrollActionTime()

Returns the last time index the user triggered a scroll event related to the display panel.

Returns:

The time index of the last scroll event as UNIX timestamp.

getLastUserScrollActionIndex

public final int getLastUserScrollActionIndex()

Returns the last scroll index the user positioned the display panel.

Returns:

The last scroll index the user positioned the display panel as int.

actionPerformed

public final void actionPerformed(java.awt.event.ActionEvent e)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Overrides:

actionPerformed in class UI

Parameters:

e - An ActionEvent.

See Also:

ActionListener.actionPerformed(java.awt.event.ActionEvent)

shutDown

public final void shutDown()

Description copied from interface: StopableObject

Shuts the object down. The method shall ensure, that all opened or started resources (e.g. ActiveMQ connections, started threads) will be controlled shut down before the objects ends itself.

Specified by:

shutDown in interface StopableObject

Specified by:

shutDown in class UI

See Also:

StopableObject.shutDown()

refresh

public final void refresh(boolean refresh)

Builds the user interface. The refresh parameter is used for positioning reasons.

Specified by:

refresh in class UI

Parameters:

refresh - Indicates if this method was called with the intention to re-render the user interface.