ch.tatool.core.display.swing

Class SwingExecutionFrame

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

ch.tatool.core.display.swing.SwingExecutionFrame

All Implemented Interfaces:

SwingExecutionDisplay, ExecutionDisplay, ExecutionPhaseListener, ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public class SwingExecutionFrame
extends JFrame
implements SwingExecutionDisplay, ExecutionPhaseListener

Display implementation usable for task execution.

Author:

Michael Ruflin

See Also:

Serialized Form

Nested Class Summary

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

JFrame.AccessibleJFrame

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

Frame.AccessibleAWTFrame

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

Window.AccessibleAWTWindow, Window.Type

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

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 ch.tatool.core.display.swing.SwingExecutionDisplay

EMPTY_CARD_ID

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
SwingExecutionFrame() Creates new form SwingExecutionFrame

Method Summary

Methods

Modifier and Type	Method and Description
void	addCard(String cardId, Component component) Add a card to this display
void	displayEmptyCard() Display an empty card.
void	disposeWindow() Hides the window and completely disposed uses resources.
Color	getBackgroundColor() Get the background color of this frame.
String	getDisplayedCardId() Get the currently displayed card.
void	hideWindow() Hides the window.
boolean	isFullScreenModeEnabled() Get whether the fullscreen mode is enabled.
void	processExecutionPhase(ExecutionContext context) Called by the Executor to signal an element execution context
void	removeAllCards() Remove all added cards.
void	removeCard(String cardId) Removes a card from the display.
void	setBackgroundColor(Color color) Set the background color of this frame.
void	setExecutor(Executor executor)
void	setFullScreenModeEnabled(boolean fullScreenModeEnabled) Set the full screen mode.
void	setOverlay(Component component) Set the overlay component to be displayed.
void	setupKeyEvents() Initialise key bindings for available KeyEventHandlers
void	showCard(String cardId) Display a previously added card.
void	showWindow() Shows the window.

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 java.awt.MenuContainer

getFont, postEvent

Constructor Detail

SwingExecutionFrame

public SwingExecutionFrame()

Creates new form SwingExecutionFrame

Method Detail

setFullScreenModeEnabled

public void setFullScreenModeEnabled(boolean fullScreenModeEnabled)

Set the full screen mode. Note that this is only possible before the frame is being displayed for the first time!

isFullScreenModeEnabled

public boolean isFullScreenModeEnabled()

Get whether the fullscreen mode is enabled.

showWindow

public void showWindow()

Shows the window.

hideWindow

public void hideWindow()

Hides the window.

disposeWindow

public void disposeWindow()

Hides the window and completely disposed uses resources.

addCard

public void addCard(String cardId,
           Component component)

Add a card to this display

Specified by:

addCard in interface SwingExecutionDisplay

showCard

public void showCard(String cardId)

Display a previously added card.

Specified by:

showCard in interface SwingExecutionDisplay

removeCard

public void removeCard(String cardId)

Removes a card from the display.

Specified by:

removeCard in interface SwingExecutionDisplay

removeAllCards

public void removeAllCards()

Remove all added cards.

Specified by:

removeAllCards in interface SwingExecutionDisplay

displayEmptyCard

public void displayEmptyCard()

Display an empty card.

Specified by:

displayEmptyCard in interface SwingExecutionDisplay

getDisplayedCardId

public String getDisplayedCardId()

Get the currently displayed card.

Specified by:

getDisplayedCardId in interface SwingExecutionDisplay

setOverlay

public void setOverlay(Component component)

Set the overlay component to be displayed.

Specified by:

setOverlay in interface SwingExecutionDisplay

Parameters:

component - the overlay component to display, null to remove any displayed component

getBackgroundColor

public Color getBackgroundColor()

Get the background color of this frame.

Specified by:

getBackgroundColor in interface SwingExecutionDisplay

Returns:

the background color, with white being default

setBackgroundColor

public void setBackgroundColor(Color color)

Set the background color of this frame.

Specified by:

setBackgroundColor in interface SwingExecutionDisplay

Parameters:

color - the background color to set.

setExecutor

public void setExecutor(Executor executor)

setupKeyEvents

public void setupKeyEvents()

Initialise key bindings for available KeyEventHandlers

processExecutionPhase

public void processExecutionPhase(ExecutionContext context)

Description copied from interface: ExecutionPhaseListener

Called by the Executor to signal an element execution context

Specified by:

processExecutionPhase in interface ExecutionPhaseListener