K-Team - Software Design Document: Class StatusPane

Overview

Package

Class

Use

Deprecated

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

au.com.solidsoftware.multimahjong.mmc.usergui
Class StatusPane

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--au.com.solidsoftware.multimahjong.mmc.usergui.StatusPane

public class StatusPane
extends javax.swing.JPanel

A pane containing a single text area, showing the status of the game. This text area displays only one line of text, and is scrollable. The most recent status message is displayed first, and the user may then scroll downwards to display older messages. Status messages are numbered in increasing order.

There is a help button to the left of the text area. When pressed, this button will display the online user manual (in HTML format) in a separate frame.

Author:: Victor H. Leung
See Also:: Serialized Form

Inner classes inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Inner classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent,  
javax.swing.JComponent.IntVector,  
javax.swing.JComponent.KeyboardBinding,  
javax.swing.JComponent.KeyboardState

Inner classes inherited from class java.awt.Component

java.awt.Component.AWTTreeLock

Field Summary
`private javax.swing.JToggleButton`	`helpButton` This button shows/hides the online user manual.
`private int`	`messageID` A unique ID number which increments with every new message.
`private javax.swing.JTextArea`	`textArea` The area that displays all the text messages that provides the user with information about the game's status.

Fields inherited from class javax.swing.JPanel

defaultLayout,  
uiClassID

Fields inherited from class javax.swing.JComponent

_bounds,  
accessibleContext,  
alignmentX,  
alignmentY,  
ANCESTOR_USING_BUFFER,  
ancestorNotifier,  
autoscroller,  
border,  
changeSupport,  
clientProperties,  
flags,  
HAS_FOCUS,  
IS_DOUBLE_BUFFERED,  
IS_OPAQUE,  
IS_PAINTING_TILE,  
KEYBOARD_BINDINGS_KEY,  
listenerList,  
maximumSize,  
minimumSize,  
NEXT_FOCUS,  
paintImmediatelyClip,  
preferredSize,  
readObjectCallbacks,  
REQUEST_FOCUS_DISABLED,  
tmpRect,  
TOOL_TIP_TEXT_KEY,  
ui,  
uiClassID,  
UNDEFINED_CONDITION,  
vetoableChangeSupport,  
WHEN_ANCESTOR_OF_FOCUSED_COMPONENT,  
WHEN_FOCUSED,  
WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Container

component,  
containerListener,  
containerSerializedDataVersion,  
dispatcher,  
layoutMgr,  
maxSize,  
ncomponents,  
serialVersionUID

Fields inherited from class java.awt.Component

actionListenerK,  
adjustmentListenerK,  
appContext,  
assert,  
background,  
BOTTOM_ALIGNMENT,  
CENTER_ALIGNMENT,  
changeSupport,  
componentListener,  
componentListenerK,  
componentOrientation,  
componentSerializedDataVersion,  
containerListenerK,  
cursor,  
dropTarget,  
enabled,  
eventMask,  
focusListener,  
focusListenerK,  
font,  
foreground,  
hasFocus,  
height,  
incRate,  
inputMethodListener,  
inputMethodListenerK,  
isInc,  
isPacked,  
itemListenerK,  
keyListener,  
keyListenerK,  
LEFT_ALIGNMENT,  
locale,  
LOCK,  
minSize,  
mouseListener,  
mouseListenerK,  
mouseMotionListener,  
mouseMotionListenerK,  
name,  
nameExplicitlySet,  
newEventsOnly,  
ownedWindowK,  
parent,  
peer,  
peerFont,  
popups,  
prefSize,  
RIGHT_ALIGNMENT,  
serialVersionUID,  
textListenerK,  
TOP_ALIGNMENT,  
valid,  
visible,  
width,  
windowListenerK,  
x,  
y

Constructor Summary
`StatusPane()` Creates an instance of `StatusPane` with the text "Initialising the playing screen..." displayed as the first message in the text area.

Method Summary
`static void`	`main(java.lang.String[] args)` Driver code used only for unit testing.
`void`	`updateStatus(java.lang.String status)` Insert the specified `String` on a new line to the text already displayed in `statusArea`.

Methods inherited from class javax.swing.JPanel

, 
getAccessibleContext, 
getUIClassID, 
paramString, 
updateUI, 
writeObject

Methods inherited from class javax.swing.JComponent

_paintImmediately, 
addAncestorListener, 
addNotify, 
addPropertyChangeListener, 
addVetoableChangeListener, 
adjustPaintFlags, 
alwaysOnTop, 
bindingForKeyStroke, 
computeVisibleRect, 
computeVisibleRect, 
contains, 
createToolTip, 
enableSerialization, 
firePropertyChange, 
firePropertyChange, 
firePropertyChange, 
firePropertyChange, 
firePropertyChange, 
firePropertyChange, 
firePropertyChange, 
firePropertyChange, 
firePropertyChange, 
fireVetoableChange, 
getActionForKeyStroke, 
getAlignmentX, 
getAlignmentY, 
getAutoscrolls, 
getBorder, 
getBounds, 
getClientProperties, 
getClientProperty, 
getComponentGraphics, 
getConditionForKeyStroke, 
getDebugGraphicsOptions, 
getFlag, 
getGraphics, 
getHeight, 
getInsets, 
getInsets, 
getLocation, 
getMaximumSize, 
getMinimumSize, 
getNextFocusableComponent, 
getPreferredSize, 
getRegisteredKeyStrokes, 
getRootPane, 
getSize, 
getToolTipLocation, 
getToolTipText, 
getToolTipText, 
getTopLevelAncestor, 
getVisibleRect, 
getWidth, 
getX, 
getY, 
grabFocus, 
hasFocus, 
isDoubleBuffered, 
isFocusCycleRoot, 
isFocusTraversable, 
isLightweightComponent, 
isManagingFocus, 
isOpaque, 
isOptimizedDrawingEnabled, 
isPaintingTile, 
isRequestFocusEnabled, 
isValidateRoot, 
keyboardBindings, 
paint, 
paintBorder, 
paintChildren, 
paintComponent, 
paintImmediately, 
paintImmediately, 
paintWithBuffer, 
processComponentKeyEvent, 
processFocusEvent, 
processKeyBinding, 
processKeyBindings, 
processKeyBindingsForAllComponents, 
processKeyEvent, 
processMouseMotionEvent, 
putClientProperty, 
readObject, 
rectangleIsObscured, 
registerKeyboardAction, 
registerKeyboardAction, 
registerWithKeyboardManager, 
removeAncestorListener, 
removeNotify, 
removePropertyChangeListener, 
removeVetoableChangeListener, 
repaint, 
repaint, 
requestDefaultFocus, 
requestFocus, 
resetKeyboardActions, 
reshape, 
revalidate, 
scrollRectToVisible, 
setAlignmentX, 
setAlignmentY, 
setAutoscrolls, 
setBackground, 
setBorder, 
setDebugGraphicsOptions, 
setDoubleBuffered, 
setEnabled, 
setFlag, 
setFont, 
setForeground, 
setMaximumSize, 
setMinimumSize, 
setNextFocusableComponent, 
setOpaque, 
setPreferredSize, 
setRequestFocusEnabled, 
setToolTipText, 
setUI, 
setVisible, 
shouldDebugGraphics, 
superProcessMouseMotionEvent, 
unregisterKeyboardAction, 
unregisterWithKeyboardManager, 
update

Methods inherited from class java.awt.Container

add, 
add, 
add, 
add, 
add, 
addContainerListener, 
addImpl, 
applyOrientation, 
countComponents, 
deliverEvent, 
dispatchEventImpl, 
dispatchEventToSelf, 
doLayout, 
eventEnabled, 
findComponentAt, 
findComponentAt, 
getComponent, 
getComponentAt, 
getComponentAt, 
getComponentCount, 
getComponents_NoClientCode, 
getComponents, 
getLayout, 
getMouseEventTarget, 
getWindow, 
initIDs, 
insets, 
invalidate, 
invalidateTree, 
isAncestorOf, 
layout, 
lightweightPrint, 
list, 
list, 
locate, 
minimumSize, 
nextFocus, 
paintComponents, 
postProcessKeyEvent, 
postsOldMouseEvents, 
preferredSize, 
preProcessKeyEvent, 
print, 
printComponents, 
printOneComponent, 
processContainerEvent, 
processEvent, 
proxyEnableEvents, 
proxyRequestFocus, 
remove, 
remove, 
removeAll, 
removeContainerListener, 
setFocusOwner, 
setLayout, 
transferFocus, 
validate, 
validateTree

Methods inherited from class java.awt.Component

action, 
add, 
addComponentListener, 
addFocusListener, 
addInputMethodListener, 
addKeyListener, 
addMouseListener, 
addMouseMotionListener, 
addPropertyChangeListener, 
areInputMethodsEnabled, 
bounds, 
checkImage, 
checkImage, 
coalesceEvents, 
constructComponentName, 
contains, 
createImage, 
createImage, 
disable, 
disableEvents, 
dispatchEvent, 
enable, 
enable, 
enableEvents, 
enableInputMethods, 
getBackground, 
getBounds, 
getColorModel, 
getComponentOrientation, 
getCursor, 
getDropTarget, 
getFont_NoClientCode, 
getFont, 
getFontMetrics, 
getForeground, 
getInputContext, 
getInputMethodRequests, 
getLocale, 
getLocation, 
getLocationOnScreen, 
getName, 
getNativeContainer, 
getParent_NoClientCode, 
getParent, 
getPeer, 
getSize, 
getToolkit, 
getToolkitImpl, 
getTreeLock, 
getWindowForObject, 
gotFocus, 
handleEvent, 
hide, 
imageUpdate, 
inside, 
isDisplayable, 
isEnabled, 
isEnabledImpl, 
isLightweight, 
isShowing, 
isValid, 
isVisible, 
keyDown, 
keyUp, 
list, 
list, 
list, 
location, 
lostFocus, 
mouseDown, 
mouseDrag, 
mouseEnter, 
mouseExit, 
mouseMove, 
mouseUp, 
move, 
nextFocus, 
paintAll, 
postEvent, 
prepareImage, 
prepareImage, 
printAll, 
processComponentEvent, 
processInputMethodEvent, 
processMouseEvent, 
remove, 
removeComponentListener, 
removeFocusListener, 
removeInputMethodListener, 
removeKeyListener, 
removeMouseListener, 
removeMouseMotionListener, 
removePropertyChangeListener, 
repaint, 
repaint, 
repaint, 
resize, 
resize, 
setBounds, 
setBounds, 
setComponentOrientation, 
setCursor, 
setDropTarget, 
setLocale, 
setLocation, 
setLocation, 
setName, 
setSize, 
setSize, 
show, 
show, 
size, 
toString, 
transferFocus

Methods inherited from class java.lang.Object

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

Field Detail

messageID

private int messageID

A unique ID number which increments with every new message. The first message dispalyed has an ID number of 1, the next with 2, and so forth. This number is reset each time the text area is cleared with via a call to updateStatus(null).

textArea

private javax.swing.JTextArea textArea

The area that displays all the text messages that provides the user with information about the game's status. The text displayed is changed via the updateStatus method.

helpButton

private javax.swing.JToggleButton helpButton

This button shows/hides the online user manual.

Constructor Detail

StatusPane

public StatusPane()

Creates an instance of StatusPane with the text "Initialising the playing screen..." displayed as the first message in the text area.

Method Detail

updateStatus

public void updateStatus(java.lang.String status)

Insert the specified String on a new line to the text already displayed in statusArea. In the event that an null is obtained as a parameter, all the text displayed in statusArea is cleared. In order to conserve memory, only the 20 most recent messages are displayed upon scrolling backwards.

Parameters:: status - the text string to insert in the status area

main

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

Driver code used only for unit testing.