org.smartfrog.services.display
Class Display

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Frame
                  javax.swing.JFrame
                      org.smartfrog.services.display.Display

All Implemented Interfaces:

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

public class Display
extends javax.swing.JFrame
implements java.awt.event.ActionListener, java.awt.event.KeyListener

Multiuse Simple display object. It is possible to start / stop the data producer.

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

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.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

java.awt.Color	EDITCOLOR Color for editable screen.
protected java.awt.GridBagLayout	gridBagLayout1 Layout object.
javax.swing.JMenuBar	jMenuBarDisplay Menu bar.
javax.swing.JToolBar	mainToolBar Main toolbar on window's top.
java.awt.Color	NONEDITCOLOR Color for non editable screen.
protected javax.swing.JScrollPane	output Scrollpane to hold the display's screen.
javax.swing.JTextArea	screen Display's screen object.
protected javax.swing.JToggleButton	stopResume Stop / resume button in the toolbar.
javax.swing.JTabbedPane	tabPane Main tab panel to hold the screen (and other panels).

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

Display(java.lang.String title)
Constructs Display object with title.

Display(java.lang.String title, Prim sfObj, StopResume stopResumeObj)
Constructs Display object with a reference to a SF object to be able to terminate it!

Display(java.lang.String title, StopResume stopResumeObj)
Constructs Display object for stop / resume jobs

Method Summary

void	actionPerformed(java.awt.event.ActionEvent e) Performs the action corresponding to an event.
void	append(java.lang.String msg) Appends the messages to the screen
void	cleanAddedPanels() Cleans added panels.
void	cleanScreen(boolean save, java.lang.String directory) Cleans the screen.
static java.awt.Image	createImage(java.lang.String imagesPath)
java.io.InputStream	getInputStream() Get the keys input stream from the screen
java.io.OutputStream	getOutputStream() Provides the output stream to use in order to display messages in this display's screen
java.io.PrintStream	getPrintStream() Provides the print stream to use in order to display messages in this display's screen
void	keyPressed(java.awt.event.KeyEvent e) Performs the action corresponding to key pressed event.
void	keyReleased(java.awt.event.KeyEvent e) Performs the action corresponding to key released event.
void	keyTyped(java.awt.event.KeyEvent e) Performs the action corresponding to key typed event.
static void	main(java.lang.String[] args) Main method used in unit testing.
void	pushStopResume() Toggles stop / resume button state internally
void	resetScreenFile(java.lang.String directory) Resets the screen file.
void	screen_newChar(java.awt.event.KeyEvent ke) Prints the char corresponding to key
void	scrollDownScreen() Scrolls down the screen.
void	setScreenEditable(boolean editable) Sets the screen editable property
void	setShouldSystemExit(boolean systemExit) Sets the shouldSystemExit attribute of the Display object
void	setTextScreen(java.lang.String text) Sets the text for the screen
void	showToolbar(boolean show) Allows to show / hide the toolbar

Methods inherited from class javax.swing.JFrame

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

Methods inherited from class java.awt.Frame

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

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, setLocationRelativeTo, 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, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, 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, isOpaque, 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, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

NONEDITCOLOR

public final java.awt.Color NONEDITCOLOR

Color for non editable screen.

EDITCOLOR

public final java.awt.Color EDITCOLOR

Color for editable screen.

mainToolBar

public javax.swing.JToolBar mainToolBar

Main toolbar on window's top.

tabPane

public javax.swing.JTabbedPane tabPane

Main tab panel to hold the screen (and other panels).

gridBagLayout1

protected java.awt.GridBagLayout gridBagLayout1

Layout object.

stopResume

protected javax.swing.JToggleButton stopResume

Stop / resume button in the toolbar.

output

protected javax.swing.JScrollPane output

Scrollpane to hold the display's screen.

screen

public javax.swing.JTextArea screen

Display's screen object.

jMenuBarDisplay

public javax.swing.JMenuBar jMenuBarDisplay

Menu bar.

Constructor Detail

Display

public Display(java.lang.String title)
        throws java.lang.Exception

Constructs Display object with title.

Parameters:

title - Title of the display window

Throws:

java.lang.Exception - if failed to construct the object

Display

public Display(java.lang.String title,
               Prim sfObj,
               StopResume stopResumeObj)
        throws java.lang.Exception

Constructs Display object with a reference to a SF object to be able to terminate it!

Parameters:

title - Title of the display window

sfObj - SmartFrog component

stopResumeObj - stop resume object

Throws:

java.lang.Exception - if failed to create the Display object

Display

public Display(java.lang.String title,
               StopResume stopResumeObj)
        throws java.lang.Exception

Constructs Display object for stop / resume jobs

Parameters:

title - Title of the display window

stopResumeObj - stop resume object

Throws:

java.lang.Exception - if failed to create the Display object

Method Detail

main

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

Main method used in unit testing.

Parameters:

args - Command line arguments

setScreenEditable

public void setScreenEditable(boolean editable)

Sets the screen editable property

Parameters:

editable - The new screenEditable value

setTextScreen

public void setTextScreen(java.lang.String text)

Sets the text for the screen

Parameters:

text - The new textScreen value

getOutputStream

public java.io.OutputStream getOutputStream()

Provides the output stream to use in order to display messages in this display's screen

Returns:

The outputStream value

getPrintStream

public java.io.PrintStream getPrintStream()

Provides the print stream to use in order to display messages in this display's screen

Returns:

The printStream value

getInputStream

public java.io.InputStream getInputStream()

Get the keys input stream from the screen

Returns:

The inputStream value

showToolbar

public void showToolbar(boolean show)

Allows to show / hide the toolbar

Parameters:

show - boolean indicator to show toolbar or not

cleanAddedPanels

public void cleanAddedPanels()

Cleans added panels.

pushStopResume

public void pushStopResume()

Toggles stop / resume button state internally

screen_newChar

public void screen_newChar(java.awt.event.KeyEvent ke)

Prints the char corresponding to key

Parameters:

ke - Key Event

append

public void append(java.lang.String msg)

Appends the messages to the screen

Parameters:

msg - message

actionPerformed

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

Performs the action corresponding to an event.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

e - ActionEvent object

keyPressed

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

Performs the action corresponding to key pressed event.

Specified by:

keyPressed in interface java.awt.event.KeyListener

Parameters:

e - KeyEvent object

keyReleased

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

Performs the action corresponding to key released event.

Specified by:

keyReleased in interface java.awt.event.KeyListener

Parameters:

e - KeyEvent object

keyTyped

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

Performs the action corresponding to key typed event.

Specified by:

keyTyped in interface java.awt.event.KeyListener

Parameters:

e - KeyEvent object

scrollDownScreen

public void scrollDownScreen()

Scrolls down the screen.

cleanScreen

public void cleanScreen(boolean save,
                        java.lang.String directory)

Cleans the screen.

Parameters:

save - indicator to save or not

directory - directory

resetScreenFile

public void resetScreenFile(java.lang.String directory)

Resets the screen file.

Parameters:

directory - directory

setShouldSystemExit

public void setShouldSystemExit(boolean systemExit)

Sets the shouldSystemExit attribute of the Display object

Parameters:

systemExit - The new shouldSystemExit value

createImage

public static java.awt.Image createImage(java.lang.String imagesPath)