com.jagacy.ui
Class AbstractSwing

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjava.awt.Window
              extended byjava.awt.Frame
                  extended byjavax.swing.JFrame
                      extended bycom.jagacy.ui.AbstractSwing
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.event.ActionListener, java.awt.datatransfer.ClipboardOwner, java.util.EventListener, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, Symbols, UserInterface, javax.swing.WindowConstants
Direct Known Subclasses:
Swing3270

public abstract class AbstractSwing
extends javax.swing.JFrame
implements Symbols, java.awt.event.ActionListener, java.awt.datatransfer.ClipboardOwner, UserInterface

Implements a Jagacy Swing GUI.

Since:
Jagacy 3270 1.4, Jagacy VT 1.1
Author:
Robert M. Preston
See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JFrame
javax.swing.JFrame.AccessibleJFrame
 
Nested classes inherited from class java.awt.Frame
java.awt.Frame.AccessibleAWTFrame
 
Nested classes inherited from class java.awt.Window
java.awt.Window.AccessibleAWTWindow
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
protected static java.awt.Font CONTROL_FONT
           
protected static int FAST_SPEED
           
protected static int MEDIUM_SPEED
           
protected static int SLOW_SPEED
           
protected static java.awt.Font TEXT_FONT
           
 
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 com.jagacy.Symbols
ACUTE_ACCENT_SYMBOL, BROKEN_BAR_SYMBOL, CAPITAL_A_ACUTE_SYMBOL, CAPITAL_A_CIRCUMFLEX_SYMBOL, CAPITAL_A_DIAERESIS_SYMBOL, CAPITAL_A_GRAVE_SYMBOL, CAPITAL_A_RING_ABOVE_SYMBOL, CAPITAL_A_TILDE_SYMBOL, CAPITAL_AE_SYMBOL, CAPITAL_C_CEDILLA_SYMBOL, CAPITAL_E_ACUTE_SYMBOL, CAPITAL_E_CIRCUMFLEX_SYMBOL, CAPITAL_E_DIAERESIS_SYMBOL, CAPITAL_E_GRAVE_SYMBOL, CAPITAL_ETH_SYMBOL, CAPITAL_I_ACUTE_SYMBOL, CAPITAL_I_CIRCUMFLEX_SYMBOL, CAPITAL_I_DIAERESIS_SYMBOL, CAPITAL_I_GRAVE_SYMBOL, CAPITAL_N_TILDE_SYMBOL, CAPITAL_O_ACUTE_SYMBOL, CAPITAL_O_CIRCUMFLEX_SYMBOL, CAPITAL_O_DIAERESIS_SYMBOL, CAPITAL_O_GRAVE_SYMBOL, CAPITAL_O_STROKE_SYMBOL, CAPITAL_O_TILDE_SYMBOL, CAPITAL_THORN_SYMBOL, CAPITAL_U_ACUTE_SYMBOL, CAPITAL_U_CIRCUMFLEX_SYMBOL, CAPITAL_U_DIAERESIS_SYMBOL, CAPITAL_U_GRAVE_SYMBOL, CAPITAL_Y_ACUTE_SYMBOL, CEDILLA_SYMBOL, CENT_SIGN_SYMBOL, CIRCUMFLEX_ACCENT_SYMBOL, COPYRIGHT_SIGN_SYMBOL, CURRENCY_SIGN_SYMBOL, DEGREE_SIGN_SYMBOL, DIAERESIS_SYMBOL, DIVISION_SIGN_SYMBOL, FEMININE_SYMBOL, FIELD_MARK_SYMBOL, FRACTION_ONE_HALF_SYMBOL, FRACTION_ONE_QUARTER_SYMBOL, FRACTION_THREE_QUARTERS_SYMBOL, INVERTED_EXCLAMATION_MARK_SYMBOL, INVERTED_QUESTION_MARK_SYMBOL, LEFT_QUOTE_SYMBOL, MACRON_SYMBOL, MASCULINE_SYMBOL, MICRO_SIGN_SYMBOL, MIDDLE_DOT_SYMBOL, MULTIPLICATION_SIGN_SYMBOL, NO_BREAK_SPACE_SYMBOL, NOT_SIGN_SYMBOL, PILCROW_SIGN_SYMBOL, PLUS_MINUS_SIGN_SYMBOL, POUND_SIGN_SYMBOL, REGISTERED_SIGN_SYMBOL, RIGHT_QUOTE_SYMBOL, SECTION_SIGN_SYMBOL, SMALL_A_ACUTE_SYMBOL, SMALL_A_CIRCUMFLEX_SYMBOL, SMALL_A_DIAERESIS_SYMBOL, SMALL_A_GRAVE_SYMBOL, SMALL_A_RING_ABOVE_SYMBOL, SMALL_A_TILDE_SYMBOL, SMALL_AE_SYMBOL, SMALL_C_CEDILLA_SYMBOL, SMALL_E_ACUTE_SYMBOL, SMALL_E_CIRCUMFLEX_SYMBOL, SMALL_E_DIAERESIS_SYMBOL, SMALL_E_GRAVE_SYMBOL, SMALL_ETH_SYMBOL, SMALL_I_ACUTE_SYMBOL, SMALL_I_CIRCUMFLEX_SYMBOL, SMALL_I_DIAERESIS_SYMBOL, SMALL_I_GRAVE_SYMBOL, SMALL_N_TILDE_SYMBOL, SMALL_O_ACUTE_SYMBOL, SMALL_O_CIRCUMFLEX_SYMBOL, SMALL_O_DIAERESIS_SYMBOL, SMALL_O_GRAVE_SYMBOL, SMALL_O_STROKE_SYMBOL, SMALL_O_TILDE_SYMBOL, SMALL_S_SHARP_SYMBOL, SMALL_THORN_SYMBOL, SMALL_U_ACUTE_SYMBOL, SMALL_U_CIRCUMFLEX_SYMBOL, SMALL_U_DIAERESIS_SYMBOL, SMALL_U_GRAVE_SYMBOL, SMALL_Y_ACUTE_SYMBOL, SMALL_Y_DIAERESIS_SYMBOL, SOFT_HYPHEN_SYMBOL, SUPERSCRIPT1_SYMBOL, SUPERSCRIPT2_SYMBOL, SUPERSCRIPT3_SYMBOL, YEN_SIGN_SYMBOL
 
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
protected AbstractSwing(AbstractSession session)
          Creates an AbstractSwing object.
protected AbstractSwing(java.lang.String name)
          Creates an AbstractSwing object.
 
Method Summary
 void actionPerformed(java.awt.event.ActionEvent event)
           
protected abstract  javax.swing.JButton addButton(javax.swing.JButton button)
          Adds a button to the toolbar (created using createButton).
protected abstract  javax.swing.JMenu addMenu(javax.swing.JMenu menu)
          Adds a menu (created using createMenu).
protected abstract  javax.swing.JMenuItem addMenuItem(javax.swing.JMenuItem menuItem)
          Adds a menu item (created using createMenuItem).
protected abstract  javax.swing.JComponent addUserComponent(int index)
          Adds a user component to the status bar.
 void checkLocked()
          Notifies the UI to check if the screen is locked.
 void close()
          Closes the UI.
protected abstract  boolean connect()
          Connects a Jagacy session.
protected  javax.swing.JButton createButton(java.lang.Class clazz, java.lang.String image, java.lang.String action, java.lang.String tip)
          Creates a toolbar button.
protected  javax.swing.JComponent createEmptyComponent()
          Creates an empty component (filler) for use on the status bar.
protected  javax.swing.JLabel createLabelComponent(java.lang.String msg)
          Creates a label component for use on the status bar.
protected  javax.swing.JMenu createMenu(java.lang.String action, int key)
          Creates a menu.
protected  javax.swing.JMenuItem createMenuItem(java.lang.String action, int key)
          Creates a menu item.
protected abstract  AbstractPanel createPanel()
          Creates a Jagacy JPanel.
protected abstract  AbstractSession createSession(java.lang.String name)
          Creates a Jagacy session.
protected  void disconnect()
          Disconnects a session.
protected  void finalize()
           
protected  javax.swing.JComponent getCursorComponent()
          Returns the cursor location indicator for use on the status bar.
protected  javax.swing.ImageIcon getIcon()
          Returns the GUI icon.
protected  AbstractPanel getPanel()
          Returns the JPanel.
protected  javax.swing.JComponent getPauseComponent()
          Returns the pause indicator for use on the status bar.
protected  java.lang.String getProductName()
          Returns the product name.
protected  AbstractSession getSession()
          Returns the Jagacy session.
protected  int getSpeed()
          Returns the update speed.
protected  javax.swing.JComponent getTimeComponent()
          Returns the time indicator for use on the status bar.
protected  void init()
          Initializes the GUI.
 void lostOwnership(java.awt.datatransfer.Clipboard clipboard, java.awt.datatransfer.Transferable contents)
           
protected abstract  boolean processAction(java.awt.event.ActionEvent event)
          Processes an ActionEvent.
 void setBeginTime(boolean isClearField)
          Notifies the UI that a screen has been requested.
 void setCursor(int row, int column)
          Sets the cursor indicator.
 void setEndTime()
          Notifies the UI that a screen has been received.
 void setLocked(boolean isLocked)
          Indicates whether or not the keyboard is locked.
 void update()
          Notifies the UI that the screen has been updated.
 
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, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update
 
Methods inherited from class java.awt.Frame
addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setIconImage, 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, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, 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, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setFocusTraversalKeys, setFocusTraversalPolicy, 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, 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, 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, isOpaque, 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, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, 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

CONTROL_FONT

protected static final java.awt.Font CONTROL_FONT

TEXT_FONT

protected static final java.awt.Font TEXT_FONT

SLOW_SPEED

protected static final int SLOW_SPEED
See Also:
Constant Field Values

MEDIUM_SPEED

protected static final int MEDIUM_SPEED
See Also:
Constant Field Values

FAST_SPEED

protected static final int FAST_SPEED
See Also:
Constant Field Values
Constructor Detail

AbstractSwing

protected AbstractSwing(java.lang.String name)
                 throws JagacyException
Creates an AbstractSwing object.

Parameters:
name - Session name.
Throws:
JagacyException - If an error occurs.

AbstractSwing

protected AbstractSwing(AbstractSession session)
                 throws JagacyException
Creates an AbstractSwing object.

Parameters:
session - A jagacy session.
Throws:
JagacyException - If an error occurs.
Method Detail

createSession

protected abstract AbstractSession createSession(java.lang.String name)
                                          throws JagacyException
Creates a Jagacy session.

Parameters:
name - Session name.
Returns:
The session.
Throws:
JagacyException - If an error occurs.

createPanel

protected abstract AbstractPanel createPanel()
                                      throws JagacyException
Creates a Jagacy JPanel.

Returns:
The panel.
Throws:
JagacyException - If an error occurs.

disconnect

protected void disconnect()
Disconnects a session.


getSpeed

protected int getSpeed()
Returns the update speed.

Returns:
The update speed.

getIcon

protected javax.swing.ImageIcon getIcon()
Returns the GUI icon.

Returns:
The icon.

getSession

protected AbstractSession getSession()
Returns the Jagacy session.

Returns:
The session.

getPanel

protected AbstractPanel getPanel()
Returns the JPanel.

Returns:
The panel.

getProductName

protected java.lang.String getProductName()
Returns the product name.

Returns:
The product name.

getPauseComponent

protected javax.swing.JComponent getPauseComponent()
Returns the pause indicator for use on the status bar.

Returns:
The indicator.

getTimeComponent

protected javax.swing.JComponent getTimeComponent()
Returns the time indicator for use on the status bar.

Returns:
The indicator.

getCursorComponent

protected javax.swing.JComponent getCursorComponent()
Returns the cursor location indicator for use on the status bar.

Returns:
The indicator.

setLocked

public void setLocked(boolean isLocked)
Description copied from interface: UserInterface
Indicates whether or not the keyboard is locked.

Specified by:
setLocked in interface UserInterface
Parameters:
isLocked - true if locked; false otherwise.

checkLocked

public void checkLocked()
Description copied from interface: UserInterface
Notifies the UI to check if the screen is locked.

Specified by:
checkLocked in interface UserInterface

setEndTime

public void setEndTime()
Description copied from interface: UserInterface
Notifies the UI that a screen has been received.

Specified by:
setEndTime in interface UserInterface

setBeginTime

public void setBeginTime(boolean isClearField)
Description copied from interface: UserInterface
Notifies the UI that a screen has been requested.

Specified by:
setBeginTime in interface UserInterface
Parameters:
isClearField - true if the time field should be cleared; false otherwise.

setCursor

public void setCursor(int row,
                      int column)
Sets the cursor indicator.

Parameters:
row - The cursor row.
column - The cursor column.

connect

protected abstract boolean connect()
Connects a Jagacy session.

Returns:
true if session is connected; false otherwise.

createMenu

protected javax.swing.JMenu createMenu(java.lang.String action,
                                       int key)
Creates a menu.

Parameters:
action - Menu action name.
key - Accelerator key.
Returns:
The menu.

createMenuItem

protected javax.swing.JMenuItem createMenuItem(java.lang.String action,
                                               int key)
Creates a menu item.

Parameters:
action - Menu item action name.
key - Accelerator key.
Returns:
The menu item.

createButton

protected javax.swing.JButton createButton(java.lang.Class clazz,
                                           java.lang.String image,
                                           java.lang.String action,
                                           java.lang.String tip)
Creates a toolbar button.

Parameters:
clazz - Class to from which to load the icon image.
image - Icon image name.
action - Action name.
tip - Tooltip.
Returns:
The button.

createLabelComponent

protected javax.swing.JLabel createLabelComponent(java.lang.String msg)
Creates a label component for use on the status bar.

Parameters:
msg - Message to display.
Returns:
The label.

createEmptyComponent

protected javax.swing.JComponent createEmptyComponent()
Creates an empty component (filler) for use on the status bar.

Returns:
The component.

addMenu

protected abstract javax.swing.JMenu addMenu(javax.swing.JMenu menu)
Adds a menu (created using createMenu).

Parameters:
menu - The menu.
Returns:
The menu.

addMenuItem

protected abstract javax.swing.JMenuItem addMenuItem(javax.swing.JMenuItem menuItem)
Adds a menu item (created using createMenuItem).

Parameters:
menuItem - The menu item.
Returns:
The menu item.

addButton

protected abstract javax.swing.JButton addButton(javax.swing.JButton button)
Adds a button to the toolbar (created using createButton).

Parameters:
button - The button.
Returns:
The button.

addUserComponent

protected abstract javax.swing.JComponent addUserComponent(int index)
Adds a user component to the status bar.

Parameters:
index - Index from right to left (starting from 0). Currently, three user components can be added.
Returns:
The component.

init

protected void init()
             throws JagacyException
Initializes the GUI.

Throws:
JagacyException - If an error occurs.

update

public void update()
            throws JagacyException
Description copied from interface: UserInterface
Notifies the UI that the screen has been updated.

Specified by:
update in interface UserInterface
Throws:
JagacyException - If an error occurs.

lostOwnership

public void lostOwnership(java.awt.datatransfer.Clipboard clipboard,
                          java.awt.datatransfer.Transferable contents)
Specified by:
lostOwnership in interface java.awt.datatransfer.ClipboardOwner

processAction

protected abstract boolean processAction(java.awt.event.ActionEvent event)
Processes an ActionEvent.

Parameters:
event - The event.
Returns:
true if the the event was processed; false otherwise.

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent event)
Specified by:
actionPerformed in interface java.awt.event.ActionListener

close

public void close()
Description copied from interface: UserInterface
Closes the UI.

Specified by:
close in interface UserInterface

finalize

protected void finalize()