uk.co.ist.mwt
Class CommandPanel

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--uk.co.ist.mwt.SelBoxPanel
                                |
                                +--uk.co.ist.mwt.CommandPanel

public class CommandPanel
extends SelBoxPanel
implements java.awt.event.ActionListener

A CommandPanel mimics the Motif XmCommand widget

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
 
Fields inherited from class uk.co.ist.mwt.SelBoxPanel
kWorkAreaAboveSelection, kWorkAreaAtTop, kWorkAreaBelowSelection, myLayout, workArea, workAreaPlacement
 
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Constructor Summary
CommandPanel()
          Constructor - create standard children, etc
 
Method Summary
 void actionPerformed(java.awt.event.ActionEvent e)
          Catch presses of the return key in the text field so that we can add the current command to the history list
 int getMaxHistoryItems()
          Gets the maximum number of items allowable in the history list
 java.lang.String getPromptString()
          Gets the prompt string
protected  void purgeUnwantedHistory()
          If there are more items in the history list than we are allowed to have, remove all of the excess ones.
protected  void removeWorkArea()
          Method to remove the work area, and all traces of it.
protected  void resetWorkAreaPosition()
          Method to put the work area in the correct postion in the child list so that it appears in the correct place.
 java.lang.String setCommand()
          Gets the text in the text field
 void setCommand(java.lang.String command)
          Sets the text in the text field
 void setMaxHistoryItems(int numItems)
          Sets the maximum number of items allowable in the history list
 void setPromptString(java.lang.String prompt)
          Sets the prompt string
 
Methods inherited from class uk.co.ist.mwt.SelBoxPanel
addImpl, addWorkArea, getWorkAreaPlacement, reallyAdd, reallyAdd, setWorkAreaPlacement
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUIClassID, paramString, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, 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, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, processComponentKeyEvent, processFocusEvent, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setCursor, setLayout, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hide, imageUpdate, inside, isDisplayable, isEnabled, 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, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, 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, wait, wait, wait
 

Constructor Detail

CommandPanel

public CommandPanel()
Constructor - create standard children, etc
Method Detail

setCommand

public void setCommand(java.lang.String command)
Sets the text in the text field
Parameters:
command - the string to use

setCommand

public java.lang.String setCommand()
Gets the text in the text field
Returns:
the command string

setMaxHistoryItems

public void setMaxHistoryItems(int numItems)
Sets the maximum number of items allowable in the history list
Parameters:
numItems - the new maximum

getMaxHistoryItems

public int getMaxHistoryItems()
Gets the maximum number of items allowable in the history list

setPromptString

public void setPromptString(java.lang.String prompt)
Sets the prompt string
Parameters:
prompt - the new string

getPromptString

public java.lang.String getPromptString()
Gets the prompt string
Returns:
the prompt string

purgeUnwantedHistory

protected void purgeUnwantedHistory()
If there are more items in the history list than we are allowed to have, remove all of the excess ones.

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)
Catch presses of the return key in the text field so that we can add the current command to the history list
Specified by:
actionPerformed in interface java.awt.event.ActionListener
Parameters:
e - an event posted by a subcomponent

resetWorkAreaPosition

protected void resetWorkAreaPosition()
Method to put the work area in the correct postion in the child list so that it appears in the correct place.
Overrides:
resetWorkAreaPosition in class SelBoxPanel

removeWorkArea

protected void removeWorkArea()
Method to remove the work area, and all traces of it.
Overrides:
removeWorkArea in class SelBoxPanel