SOA
© 2004 SoS Group
All Rights Reserved

sos.koa
Class HelpAdapter

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjava.awt.Window
              extended byjava.awt.Frame
                  extended byjavax.swing.JFrame
                      extended bysos.koa.HelpAdapter
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.event.ActionListener, java.util.EventListener, java.awt.image.ImageObserver, KOAConstants, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants

public class HelpAdapter
extends javax.swing.JFrame
implements java.awt.event.ActionListener, KOAConstants

The help window.

Version:
$Id: HelpAdapter.java,v 1.23 2004/05/05 21:28:04 martijno Exp $
Author:
Engelbert Hubbers (hubbers@cs.kun.nl) Dehubbified by MO, meta-dehubbified and HTMLed by CB + MO.

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
[spec_public] (package private)  javax.swing.JEditorPane area
          The HTML text area of the help pane.
(package private) static java.lang.String CANDIDATES_IMPORTED_STATE_STRING
           
(package private) static java.lang.String CLEARED_STATE_STRING
           
(package private) static java.lang.String FUNCTION_CLEAR
           
(package private) static java.lang.String FUNCTION_COUNT
           
(package private) static java.lang.String FUNCTION_DECRYPT
           
(package private) static java.lang.String FUNCTION_EXIT
           
(package private) static java.lang.String FUNCTION_EXIT_REPORT
           
(package private) static java.lang.String FUNCTION_IMPORT_CANDIDATES
           
(package private) static java.lang.String FUNCTION_IMPORT_PRIVATE_KEY
           
(package private) static java.lang.String FUNCTION_IMPORT_PUBLIC_KEY
           
(package private) static java.lang.String FUNCTION_IMPORT_VOTES
           
(package private) static java.lang.String FUNCTION_REPORT
           
(package private) static java.lang.String FUNCTION_RESTART
           
(package private) static java.lang.String FUNCTIONS_STRING
           
(package private) static java.lang.String INIT_STATE_STRING
           
[spec_public] (package private) static java.awt.Dimension PREFERRED_SIZE
           
(package private) static java.lang.String PRIVATE_KEY_IMPORTED_STATE_STRING
           
(package private) static java.lang.String PUBLIC_KEY_IMPORTED_STATE_STRING
           
(package private) static java.lang.String REPORT_GENERATED_STATE_STRING
           
(package private) static java.lang.String VOTES_COUNTED_STATE_STRING
           
(package private) static java.lang.String VOTES_DECRYPTED_STATE_STRING
           
(package private) static java.lang.String VOTES_IMPORTED_STATE_STRING
           
 
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.Window
 
Fields inherited from class java.awt.Container
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface sos.koa.KOAConstants
ADDITIONAL_INFO_EXTRA, ADDITIONAL_INFO_MAX_HEIGHT, ADDITIONAL_INFO_MAX_WIDTH, AUDITLOG, AUDITLOG_PDF, AUDITLOG_XML, AUDITLOG_XSL, BASEDIR, CANDIDATES_IMPORTED_STATE, CLEAR_BUT_TXT, CLEAR_FAILURE_MSG, CLEAR_SUCCESS_MSG, CLEAR_TASK_MSG, CLEAR_WARNING_MSG, CLEAR_WARNING_MSG_1, CLEAR_WARNING_MSG_2, CLEARED_STATE, COUNT_BUT_TXT, COUNT_FAILURE_MSG, COUNT_SUCCESS_MSG, COUNT_TASK_MSG, COUNT_WARNING_MSG, DECRYPT_BUT_TXT, DECRYPT_ERROR_MSG, DECRYPT_ERROR_TAG, DECRYPT_FAILURE_MSG, DECRYPT_SUCCESS_MSG, DECRYPT_TASK_MSG, DECRYPT_WARNING_MSG, DECRYPTEDFILE, DEFAULT_VOTING_INTERVAL, EXIT_BUT_TXT, EXIT_FAILURE_MSG, EXIT_SUCCESS_MSG, EXIT_TASK_MSG, EXIT_WARNING_MSG, FORWARD_BACK_OPTIONS, FORWARD_MOREINFO_BACK_OPTIONS, HELP_BUT_TXT, HELP_TASK_MSG, IMPORT_CANDIDATES_BUT_TXT, IMPORT_CANDIDATES_FAILURE_MSG, IMPORT_CANDIDATES_SUCCESS_MSG, IMPORT_CANDIDATES_TASK_MSG, IMPORT_CANDIDATES_WARNING_MSG, IMPORT_KEY_FAILURE_MSG, IMPORT_KEY_SUCCESS_MSG, IMPORT_KEY_WARNING_MSG, IMPORT_PRIVATE_KEY_BUT_TXT, IMPORT_PRIVATE_KEY_TASK_MSG, IMPORT_PUBLIC_KEY_BUT_TXT, IMPORT_PUBLIC_KEY_TASK_MSG, IMPORT_VOTES_BUT_TXT, IMPORT_VOTES_FAILURE_MSG, IMPORT_VOTES_SUCCESS_MSG, IMPORT_VOTES_TASK_MSG, IMPORT_VOTES_WARNING_MSG, INIT_STATE, LESSINFO_OPTION, MAX_ENCRYPTED_VOTE_LENGTH, MAX_KEY_LENGTH, MOREINFO_OPTION, NO_ERRORS_MSG, NUMBER_OF_REDUNDANT_FIELDS, OK_CANCEL_OPTIONS, OK_LESSINFO_CANCEL_OPTIONS, OK_LESSINFO_OPTIONS, OK_MOREINFO_CANCEL_OPTIONS, OK_MOREINFO_OPTIONS, OK_OPTIONS, OUTDIR, PRIVATE_KEY_IMPORTED_STATE, PRIVATE_KEYTYPE, PUBLIC_KEY_IMPORTED_STATE, PUBLIC_KEYTYPE, RECOUNT, RECOUNT_PDF, RECOUNT_XML, RECOUNT_XSL, RELEASE, REPORT_BUT_TXT, REPORT_FAILURE_MSG, REPORT_GENERATED_STATE, REPORT_OPTIONS, REPORT_SUCCESS_MSG, REPORT_TASK_MSG, REPORT_WARNING_MSG, RESTART_BUT_TXT, RESTART_FAILURE_MSG, RESTART_SUCCESS_MSG, RESTART_TASK_MSG, RESTART_WARNING_MSG, TASK_CANCELED_MSG, TITLE, VOTES_COUNTED_STATE, VOTES_DECRYPTED_STATE, VOTES_IGNORED_SEE_MORE_INFO_MSG, VOTES_IMPORTED_STATE, YES_CANCEL_OPTIONS, YES_NO_OPTIONS
 
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
HelpAdapter()
          Constructs the help window.
 
Method Summary
 void actionPerformed(java.awt.event.ActionEvent ae)
          Gets executed when user presses the help button.
 java.awt.Dimension getPreferredSize()
          The preferred size of the help window.
 void setText(int state)
          Generates a text based on the current state and puts it in the help window.
 void setText(java.lang.String txt)
          Sets the text in the help window to txt.
private  java.lang.String stateString(int state)
          Gets a string that describes the current state.
 void windowClosing(java.awt.event.WindowEvent e)
          Gets executed when user closes the help window.
 
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, finalize, 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, 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

PREFERRED_SIZE

static final java.awt.Dimension PREFERRED_SIZE
Specifications: spec_public

FUNCTIONS_STRING

static final java.lang.String FUNCTIONS_STRING

INIT_STATE_STRING

static final java.lang.String INIT_STATE_STRING

CLEARED_STATE_STRING

static final java.lang.String CLEARED_STATE_STRING

CANDIDATES_IMPORTED_STATE_STRING

static final java.lang.String CANDIDATES_IMPORTED_STATE_STRING

VOTES_IMPORTED_STATE_STRING

static final java.lang.String VOTES_IMPORTED_STATE_STRING

PRIVATE_KEY_IMPORTED_STATE_STRING

static final java.lang.String PRIVATE_KEY_IMPORTED_STATE_STRING

PUBLIC_KEY_IMPORTED_STATE_STRING

static final java.lang.String PUBLIC_KEY_IMPORTED_STATE_STRING

VOTES_DECRYPTED_STATE_STRING

static final java.lang.String VOTES_DECRYPTED_STATE_STRING

VOTES_COUNTED_STATE_STRING

static final java.lang.String VOTES_COUNTED_STATE_STRING

REPORT_GENERATED_STATE_STRING

static final java.lang.String REPORT_GENERATED_STATE_STRING

FUNCTION_CLEAR

static final java.lang.String FUNCTION_CLEAR

FUNCTION_RESTART

static final java.lang.String FUNCTION_RESTART

FUNCTION_IMPORT_CANDIDATES

static final java.lang.String FUNCTION_IMPORT_CANDIDATES

FUNCTION_IMPORT_VOTES

static final java.lang.String FUNCTION_IMPORT_VOTES

FUNCTION_IMPORT_PRIVATE_KEY

static final java.lang.String FUNCTION_IMPORT_PRIVATE_KEY

FUNCTION_IMPORT_PUBLIC_KEY

static final java.lang.String FUNCTION_IMPORT_PUBLIC_KEY

FUNCTION_DECRYPT

static final java.lang.String FUNCTION_DECRYPT

FUNCTION_COUNT

static final java.lang.String FUNCTION_COUNT

FUNCTION_REPORT

static final java.lang.String FUNCTION_REPORT

FUNCTION_EXIT

static final java.lang.String FUNCTION_EXIT

FUNCTION_EXIT_REPORT

static final java.lang.String FUNCTION_EXIT_REPORT

area

javax.swing.JEditorPane area
The HTML text area of the help pane.

Specifications: spec_public
Constructor Detail

HelpAdapter

public HelpAdapter()
Constructs the help window.

Specifications:
assignable this.area;
ensures true;
Method Detail

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent ae)
Gets executed when user presses the help button.

Specified by:
actionPerformed in interface java.awt.event.ActionListener
Parameters:
ae - an event indicating the user pressed the help button.

windowClosing

public void windowClosing(java.awt.event.WindowEvent e)
Gets executed when user closes the help window.

Parameters:
e - event indicating the user closed the help window.

setText

public void setText(int state)
Generates a text based on the current state and puts it in the help window.

Parameters:
state - the current state.
Specifications:
requires INIT_STATE <= state&state <= REPORT_GENERATED_STATE;
assignable \everything;
ensures true;

setText

public void setText(java.lang.String txt)
Sets the text in the help window to txt. The text can be a HTML document.

Parameters:
txt - the new text.

stateString

private java.lang.String stateString(int state)
Gets a string that describes the current state.

Parameters:
state - the current state.
Specifications: pure
requires INIT_STATE <= state&state <= REPORT_GENERATED_STATE;
ensures \result != null;

getPreferredSize

public java.awt.Dimension getPreferredSize()
The preferred size of the help window.

Overrides:
getPreferredSize in class java.awt.Container
Returns:
PREFERRED_SIZE.
Specifications: pure
     also
requires true;
ensures \result == PREFERRED_SIZE;

SOA
© 2004 SoS Group
All Rights Reserved