de.hawhamburg.reachability.ui

Class UI

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

de.hawhamburg.reachability.ui.UI

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

Direct Known Subclasses:

ColoredUI, ColorKeyUI, ControllingToolUI, ReachabilityConfigUI, ReachabilitySimulationDetailsUI, ReachabilitySimulationStoryUI, ReachabilityStartSimulationUI, ReachabilityUI

public abstract class UI
extends javax.swing.JFrame
implements java.awt.event.ActionListener, java.awt.event.MouseListener, java.awt.event.KeyListener, StopableObject, java.awt.event.WindowListener

Abstract class for user interface implementation which provides basic methods for simple development

This class provides useful methods and functions in common with the develpment of user interfaces for this project. The class provides full ActionListener, MouseListener, KeyListener and WindowListener support. The required method may need to be implemented within the subclasses.

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 javax.swing.JPanel	body The main JPanel.
private boolean	internalStandalone Is this interface started from another interface or for itself?
private javax.swing.JFrame	parent The parent window, from which this interfaces was created.
private java.util.Random	rand A random number generator.
private int	refreshInterval Refresh interval in milliseconds.
private static long	serialVersionUID Some unique serial version id.
private java.util.Map<java.lang.String,java.lang.String>	settingsCommon The common settings, loaded from the general user interface configuration file.
private java.util.Map<java.lang.String,java.lang.String>	settingsFrame The frame settings, loaded from the frame dependent configuration file.
private javax.swing.Timer	timer The repaint Timer.
private java.lang.String	type The windows type.
private int	windowHeight The height of the user interface.
private int	windowWidth The width of the user interface.

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

Modifier	Constructor and Description
protected	UI(java.lang.String title) Protected constructor of this UI to prevent the creation of direct instances of this class.
protected	UI(java.lang.String title, javax.swing.JFrame parentWindow) Protected constructor of this UI to prevent the creation of direct instances of this class.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e)
protected void	addBody(java.awt.Component x) Adds an element as Component to the body of this user interface.
protected abstract void	addMenu() This method adds a menu to the user interface.
protected void	autoPosition() The method centers the user interface to the middle of the screen.
protected void	build() This method builds the interface.
protected void	fixBounds(boolean refresh) Corrects the position and size of the window by autoPosition() if refresh is supplied as true, otherwise only the size will be updated.
protected javax.swing.JPanel	getBody() Returns the body of the the user interface as JPanel.
protected java.lang.String	getCommonConfigValue(java.lang.String key) Returns a common configuration value as String specified by the key if existing, otherwise null.
private java.lang.String	getCommonConfigValue(java.lang.String key, boolean internalCall) Returns a common configuration value as String specified by the key if existing, otherwise null.
protected java.lang.String	getConfigValue(java.lang.String key) Returns the value of a configuration variable specified by key as String if existing, otherwise null.
protected java.lang.Integer	getConfigValueAsInteger(java.lang.String key) Returns the value of a configuration variable specified by key as Integer if existing, otherwise null.
protected java.lang.String	getFrameConfigValue(java.lang.String key) Returns a frame (local) configuration value as String specified by the key if existing, otherwise null.
private java.lang.String	getFrameConfigValue(java.lang.String key, boolean internalCall) Returns a frame (local) configuration value as String specified by the key if existing, otherwise null.
protected java.lang.Integer	getFrameConfigValueAsInteger(java.lang.String key) Returns the value of a frame (local) configuration variable specified by key as Integer if existing, otherwise null.
protected java.awt.GridLayout	getGrid(int rowsIn, int colsIn) Returns a user interface grid.
java.lang.String	getId() Generates a random ID for this UI.
protected javax.swing.JFrame	getParentWindow() Returns the parent window if existing as JFrame, otherwise null.
protected javax.swing.Timer	getTimer() Returns the timer thread as Timer if existing, otherwise null.
protected int	getWindowHeight() Returns the height of this window as integer.
protected int	getWindowWidth() Returns the width of this window as integer.
protected void	infoDialog(java.lang.String msg) Creates an information dialog containing a specified message.
boolean	isStandalone() Determines if the interface is standing alone (has no parent window).
void	keyPressed(java.awt.event.KeyEvent arg0)
void	keyReleased(java.awt.event.KeyEvent arg0)
void	keyTyped(java.awt.event.KeyEvent arg0)
void	killWindow() Destroys this interface.
protected void	loadConfig() Load the configuration from the default configuration file.
protected void	loadLocalConfig(java.lang.String configFile) Loads the local configuration of the user interface from file.
void	mouseClicked(java.awt.event.MouseEvent e)
void	mouseEntered(java.awt.event.MouseEvent e)
void	mouseExited(java.awt.event.MouseEvent e)
void	mousePressed(java.awt.event.MouseEvent e)
void	mouseReleased(java.awt.event.MouseEvent e)
void	refresh() Builds the UI by using refresh(boolean) with false.
abstract void	refresh(boolean refresh) (Re-)builds the rendering of the UI.
protected void	setWindowHeight(int height) Sets/changes the height of this window to a new value.
protected void	setWindowWidth(int width) Sets/changes the width of this window to a new value.
abstract void	shutDown() Shuts the object down.
protected void	stopTimer() Stop a running refresh timer if existing.
void	windowActivated(java.awt.event.WindowEvent arg0)
void	windowClosed(java.awt.event.WindowEvent arg0)
void	windowClosing(java.awt.event.WindowEvent arg0)
void	windowDeactivated(java.awt.event.WindowEvent arg0)
void	windowDeiconified(java.awt.event.WindowEvent arg0)
void	windowIconified(java.awt.event.WindowEvent arg0)
void	windowOpened(java.awt.event.WindowEvent arg0)

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

internalStandalone

private boolean internalStandalone

Is this interface started from another interface or for itself?

type

private java.lang.String type

The windows type.

parent

private javax.swing.JFrame parent

The parent window, from which this interfaces was created.

rand

private java.util.Random rand

A random number generator.

body

private javax.swing.JPanel body

The main JPanel.

timer

private javax.swing.Timer timer

The repaint Timer.

windowWidth

private int windowWidth

The width of the user interface.

windowHeight

private int windowHeight

The height of the user interface.

refreshInterval

private int refreshInterval

Refresh interval in milliseconds.

settingsCommon

private java.util.Map<java.lang.String,java.lang.String> settingsCommon

The common settings, loaded from the general user interface configuration file.

settingsFrame

private java.util.Map<java.lang.String,java.lang.String> settingsFrame

The frame settings, loaded from the frame dependent configuration file.

Constructor Detail

UI

protected UI(java.lang.String title)

Protected constructor of this UI to prevent the creation of direct instances of this class.

Creates a new user interface by using UI(String, JFrame) with null.

Parameters:

title - The title of the user interface as String.

UI

protected UI(java.lang.String title,
  javax.swing.JFrame parentWindow)

Protected constructor of this UI to prevent the creation of direct instances of this class.

Creates a new user interface with the supplied title.

Parameters:

title - The title of the user interface as String.

parentWindow - The parent window which created this user interface, if existing.

Method Detail

build

protected final void build()

This method builds the interface. It loads the common and local configuration, adds window listeners, positions the window, adds menus, initially builds the interfaces and starts a refresh trigger if required.

loadConfig

protected final void loadConfig()

Load the configuration from the default configuration file.

loadLocalConfig

protected void loadLocalConfig(java.lang.String configFile)

Loads the local configuration of the user interface from file. This method needs to be implemented by the sub-class, if required.

Parameters:

configFile - The path to the configuration file as String.

autoPosition

protected final void autoPosition()

The method centers the user interface to the middle of the screen.

fixBounds

protected final void fixBounds(boolean refresh)

Corrects the position and size of the window by autoPosition() if refresh is supplied as true, otherwise only the size will be updated.

Parameters:

refresh - If set to true only the size will be updated, otherwise position as well.

addMenu

protected abstract void addMenu()

This method adds a menu to the user interface. This method needs to be implemented by the sub-class, if a menu is required.

getGrid

protected final java.awt.GridLayout getGrid(int rowsIn,
                          int colsIn)

Returns a user interface grid.

Parameters:

rowsIn - Amount of rows to be displayed

colsIn - Amount of columns to be displayed

Returns:

Returns a user interface grid.

getBody

protected final javax.swing.JPanel getBody()

Returns the body of the the user interface as JPanel.

Returns:

The interfaces body as JPanel.

getParentWindow

protected final javax.swing.JFrame getParentWindow()

Returns the parent window if existing as JFrame, otherwise null.

Returns:

The parent window as JFrame if existing, otherwise null.

getTimer

protected final javax.swing.Timer getTimer()

Returns the timer thread as Timer if existing, otherwise null.

Returns:

The timer thread as Timer if existing, otherwise null.

getWindowHeight

protected final int getWindowHeight()

Returns the height of this window as integer.

Returns:

The height of this window as integer.

setWindowHeight

protected final void setWindowHeight(int height)

Sets/changes the height of this window to a new value.

Parameters:

height - The new height of this window as integer.

getWindowWidth

protected final int getWindowWidth()

Returns the width of this window as integer.

Returns:

The width of this window as integer.

setWindowWidth

protected final void setWindowWidth(int width)

Sets/changes the width of this window to a new value.

Parameters:

width - The new width of this window as integer.

getConfigValue

protected final java.lang.String getConfigValue(java.lang.String key)

Returns the value of a configuration variable specified by key as String if existing, otherwise null.

Parameters:

key - The name of the configuration variable as String.

Returns:

The value of this configuration variable as String if existing, otherwise null.

getConfigValueAsInteger

protected final java.lang.Integer getConfigValueAsInteger(java.lang.String key)

Returns the value of a configuration variable specified by key as Integer if existing, otherwise null.

Parameters:

key - The name of the configuration variable as String.

Returns:

The value of this configuration variable as Integer if existing, otherwise null.

getCommonConfigValue

protected final java.lang.String getCommonConfigValue(java.lang.String key)

Returns a common configuration value as String specified by the key if existing, otherwise null.

Parameters:

key - The name of the common configuration variable as String.

Returns:

The value of this common configuration variable as String if existing, otherwise null.

getCommonConfigValue

private java.lang.String getCommonConfigValue(java.lang.String key,
                                    boolean internalCall)

Returns a common configuration value as String specified by the key if existing, otherwise null.

Parameters:

key - The name of the common configuration variable as String.

internalCall - If true and the variable couldn't be found, no error will be published.

Returns:

The value of this common configuration variable as String if existing, otherwise null.

getFrameConfigValue

protected final java.lang.String getFrameConfigValue(java.lang.String key)

Returns a frame (local) configuration value as String specified by the key if existing, otherwise null.

Parameters:

key - The name of the frame (local) configuration variable as String.

Returns:

The value of this the frame (local) configuration variable as String if existing, otherwise null.

getFrameConfigValue

private java.lang.String getFrameConfigValue(java.lang.String key,
                                   boolean internalCall)

Returns a frame (local) configuration value as String specified by the key if existing, otherwise null.

Parameters:

key - The name of the frame (local) configuration variable as String.

internalCall - If true and the variable couldn't be found, no error will be published.

Returns:

The value of this frame (local) configuration variable as String if existing, otherwise null.

getFrameConfigValueAsInteger

protected final java.lang.Integer getFrameConfigValueAsInteger(java.lang.String key)

Returns the value of a frame (local) configuration variable specified by key as Integer if existing, otherwise null.

Parameters:

key - The name of the frame (local) configuration variable as String.

Returns:

The value of this frame (local) configuration variable as Integer if existing, otherwise null.

addBody

protected final void addBody(java.awt.Component x)

Adds an element as Component to the body of this user interface.

Parameters:

x - The Component which shall be added to the body of this interface.

isStandalone

public final boolean isStandalone()

Determines if the interface is standing alone (has no parent window).

Returns:

true if its standing alone (has no parent window), otherwise false.

actionPerformed

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

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

e - An ActionEvent.

See Also:

This method needs to be specified by the sub-class, if required.

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent e)

Specified by:

mouseClicked in interface java.awt.event.MouseListener

Parameters:

e - A MouseEvent.

See Also:

This method needs to be specified by the sub-class, if required.

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent e)

Specified by:

mouseEntered in interface java.awt.event.MouseListener

Parameters:

e - A MouseEvent.

See Also:

This method needs to be specified by the sub-class, if required.

mouseExited

public void mouseExited(java.awt.event.MouseEvent e)

Specified by:

mouseExited in interface java.awt.event.MouseListener

Parameters:

e - A MouseEvent.

See Also:

This method needs to be specified by the sub-class, if required.

mousePressed

public void mousePressed(java.awt.event.MouseEvent e)

Specified by:

mousePressed in interface java.awt.event.MouseListener

Parameters:

e - A MouseEvent.

See Also:

This method needs to be specified by the sub-class, if required.

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent e)

Specified by:

mouseReleased in interface java.awt.event.MouseListener

Parameters:

e - A MouseEvent.

See Also:

This method needs to be specified by the sub-class, if required.

keyPressed

public void keyPressed(java.awt.event.KeyEvent arg0)

Specified by:

keyPressed in interface java.awt.event.KeyListener

Parameters:

arg0 - A KeyEvent.

See Also:

This method needs to be specified by the sub-class, if required.

keyReleased

public void keyReleased(java.awt.event.KeyEvent arg0)

Specified by:

keyReleased in interface java.awt.event.KeyListener

Parameters:

arg0 - A KeyEvent.

See Also:

This method needs to be specified by the sub-class, if required.

keyTyped

public void keyTyped(java.awt.event.KeyEvent arg0)

Specified by:

keyTyped in interface java.awt.event.KeyListener

Parameters:

arg0 - A KeyEvent.

See Also:

This method needs to be specified by the sub-class, if required.

windowActivated

public void windowActivated(java.awt.event.WindowEvent arg0)

Specified by:

windowActivated in interface java.awt.event.WindowListener

Parameters:

arg0 - A WindowEvent.

See Also:

This method needs to be specified by the sub-class, if required.

windowClosed

public void windowClosed(java.awt.event.WindowEvent arg0)

Specified by:

windowClosed in interface java.awt.event.WindowListener

Parameters:

arg0 - A WindowEvent.

See Also:

This method needs to be specified by the sub-class, if required.

windowClosing

public final void windowClosing(java.awt.event.WindowEvent arg0)

Specified by:

windowClosing in interface java.awt.event.WindowListener

Parameters:

arg0 - A WindowEvent.

See Also:

WindowListener.windowClosing(java.awt.event.WindowEvent)

windowDeactivated

public void windowDeactivated(java.awt.event.WindowEvent arg0)

Specified by:

windowDeactivated in interface java.awt.event.WindowListener

Parameters:

arg0 - A WindowEvent.

See Also:

This method needs to be specified by the sub-class, if required.

windowDeiconified

public void windowDeiconified(java.awt.event.WindowEvent arg0)

Specified by:

windowDeiconified in interface java.awt.event.WindowListener

Parameters:

arg0 - A WindowEvent.

See Also:

This method needs to be specified by the sub-class, if required.

windowIconified

public void windowIconified(java.awt.event.WindowEvent arg0)

Specified by:

windowIconified in interface java.awt.event.WindowListener

Parameters:

arg0 - A WindowEvent.

See Also:

This method needs to be specified by the sub-class, if required.

windowOpened

public void windowOpened(java.awt.event.WindowEvent arg0)

Specified by:

windowOpened in interface java.awt.event.WindowListener

Parameters:

arg0 - A WindowEvent.

See Also:

This method needs to be specified by the sub-class, if required.

killWindow

public final void killWindow()

Destroys this interface.

stopTimer

protected final void stopTimer()

Stop a running refresh timer if existing.

shutDown

public abstract 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

See Also:

This method needs to be specified by the sub-class, if required.

infoDialog

protected final void infoDialog(java.lang.String msg)

Creates an information dialog containing a specified message.

Parameters:

msg - A message as String.

refresh

public final void refresh()

Builds the UI by using refresh(boolean) with false.

refresh

public abstract void refresh(boolean refresh)

(Re-)builds the rendering of the UI. This method needs to be specified by the sub-class.

Parameters:

refresh - true indicates that this method is called with the intention to refresh the page with new data, false means that it was called as initial build.

getId

public final java.lang.String getId()

Generates a random ID for this UI.

Returns:

Returns a randomly generated identity number.