UIAgent (Autonomous Unmanned Vehicle (AUV) Workbench Documentation)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - workbench.im.UIAgent

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Observer, Accessible
```
public class UIAgent
extends JPanel
implements Observer
```
Filename : UIAgent Description : Event Monitoring/Jabber Instant Messaging User Interface Created Date : 29 October 2003 Revised Date : 13 May 2004 Course : Thesis Work Program : AUV Workbench 1.0 Compiler : JDK 1.4.2 onwards Platform : Windows 2000/Windows XP

Version:

$Id: UIAgent.java 9109 2015-07-29 22:39:46Z brutzman $

Author:

Lee, Chin Siong Daryl

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class javax.swing.JPanel
  JPanel.AccessibleJPanel
- Nested classes/interfaces inherited from class javax.swing.JComponent
  JComponent.AccessibleJComponent
- Nested classes/interfaces inherited from class java.awt.Container
  Container.AccessibleAWTContainer
- Nested classes/interfaces inherited from class java.awt.Component
  Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary
- Fields inherited from class javax.swing.JComponent
  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
  accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
- Fields inherited from interface java.awt.image.ImageObserver
  ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors
Constructor and Description

UIAgent(String xmlConfig)
constructor

Constructors
Constructor and Description
`UIAgent(String xmlConfig)` constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMessage(String sBody, String sFrom)` add message to table display
`boolean`	`appOpenApp(String sApp)` loop through list of ConfigApp objects and try to fire-up the requested application
`boolean`	`appOpenFile(String sFile)` loop through list of ConfigApp objects and try to open the file with the associated application based on the file type
`void`	`enableButtons(boolean flag)` enableButtons - enable/disable Guess/Clear buttons
`AgentConfig`	`getAgentConfig()` used by Hotkey to trigger an event
`String`	`getIMDirIn()` get the directory to store incoming binary data (e.g. encoded data in Jabber XHTML message)
`String`	`getIMDirOut()` get the directory to store outgoing binary data (e.g. encoded data in Jabber XHTML message)
`String`	`getIMDomain()` get the Jabber logon domain
`String`	`getIMJID()` get the Jabber ID to listen to upon connection
`String`	`getIMNickName()` get the Jabber user nickname
`int`	`getIMPort()` get Jabber port no.
`String`	`getIMResource()` get the Jabber user resource
`String`	`getIMUserName()` get the Jabber user name
`String`	`getIMUserPassword()` get the Jabber user password
`void`	`highlightText(int start, int len, String sColor, boolean[] arr)` highlight text in memobox
`void`	`init()` init - initialise the user interface
`protected Component`	`makeTextPanel(String text)` dummy text label for tabbed pages
`void`	`processb64_2()`
`void`	`processb64()` test base-64 encode/decode
`void`	`processClear()` processClear - invoke clearTextFields to clean-up contents of JTextFields.
`void`	`processEncodeTest()` test encode/decode performance
`void`	`processHTTPGet()` HTTP get file
`void`	`processHTTPPost()` HTTP post file
`void`	`processIMJoin(String sRoom)` processReset - group chat A group chat connects to a chat room on a server and allows you to send and receive messages from a group of people.
`void`	`processIMSend()` package and send out Jabber message
`void`	`processObserverNotify()` testing of Observer notifications
`void`	`processP2P()` processParse - parser the paragraph
`void`	`processWebStartStop()` processWebStartStop - start/stop web server To serve to web page, type-in "http:///index.htm" in Internet Explorer browser
`void`	`processXHTML(String sXML)` process XHTML string and spawn respective application to display it.
`void`	`setConfigAppList(List lst)` set list of ConfigApp objects that have been read from configuration file
`void`	`setCriteriaBody(String sJID)` set list of Message Body keywords
`void`	`setCriteriaSubject(String sJID)` set list of Message Subject keywords
`void`	`setIMDirIn(String sDir)` set the directory to store incoming binary data (e.g. encoded data in Jabber XHTML message)
`void`	`setIMDirOut(String sDir)` set the directory to store outgoing binary data (e.g. encoded data in Jabber XHTML message)
`void`	`setIMDomain(String sDomain)` set the Jabber logon domain
`void`	`setIMJID(String sJID)` set the Jabber ID to listen to upon connection
`void`	`setIMNickName(String sNick)` set the Jabber user nickname
`void`	`setIMPort(int iPort)` set Jabber port no.
`void`	`setIMResource(String sResource)` set the Jabber user resource
`void`	`setIMUserName(String sName)` set the Jabber user name
`void`	`setIMUserPassword(String sPwd)` set the Jabber user password
`JPanel`	`uiButton()` panel of buttons
`JPanel`	`uiCriteria()` create scrollable text area
`JPanel`	`uiIMConnect()` user interface to set/get Jabber user, password, domain, nickname
`JPanel`	`uiIMRecv()` create a table to display list of incoming Jabber messages
`JPanel`	`uiIMSend()` create a table to display list of incoming Jabber messages
`JScrollPane`	`uiTextArea()` create scrollable text area
`JPanel`	`uiWeb()` user interface to start/stop webserver
`void`	`update(Observable ob, Object obj)` method is called whenever the observed object is changed.
`void`	`writeErr(String aStr)` write a error messgae to console
`void`	`writeLn()` write a line to console
`static void`	`writeLn(boolean bStr)` write boolean value to console
`static void`	`writeLn(int iStr)` write numeric value to console
`void`	`writeLn(String aStr)` write a line to console
`void`	`writeText(String aStr)` write string to memobox

Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UIAgent
```
public UIAgent(String xmlConfig)
```
    constructor
    
    Parameters:
    
    xmlConfig - configuration file param mView for plotting of coordinates on Mission Planner
- Method Detail
  - addMessage
```
public void addMessage(String sBody,
                       String sFrom)
```
    add message to table display
    
    Parameters:
    
    sBody - message body
    
    sFrom - from who
  - appOpenApp
```
public boolean appOpenApp(String sApp)
```
    loop through list of ConfigApp objects and try to fire-up the requested application
    
    Parameters:
    
    sApp - application to be opened
    
    Returns:
    
    if successfully fired-up, true, otherwise false
  - appOpenFile
```
public boolean appOpenFile(String sFile)
```
    loop through list of ConfigApp objects and try to open the file with the associated application based on the file type
    
    Parameters:
    
    sFile - file to be opened
    
    Returns:
    
    if successfully fired-up, true, otherwise false
  - setConfigAppList
```
public void setConfigAppList(List lst)
```
    set list of ConfigApp objects that have been read from configuration file
    
    Parameters:
    
    lst - list of ConfigApp objects
  - enableButtons
```
public void enableButtons(boolean flag)
```
    enableButtons - enable/disable Guess/Clear buttons
    
    Parameters:
    
    flag - is true for enabled, false for disabled
  - highlightText
```
public void highlightText(int start,
                          int len,
                          String sColor,
                          boolean[] arr)
```
    highlight text in memobox
    
    Parameters:
    
    start - start position of string to be highlighted
    
    len - length of string to be highlighted
    
    sColor - color name
    
    arr - boolean array
  - getAgentConfig
```
public AgentConfig getAgentConfig()
```
    used by Hotkey to trigger an event
    
    Returns:
    
    AgentConfig object
  - getIMDirIn
```
public String getIMDirIn()
```
    get the directory to store incoming binary data (e.g. encoded data in Jabber XHTML message)
    
    Returns:
    
    String value
  - setIMDirIn
```
public void setIMDirIn(String sDir)
```
    set the directory to store incoming binary data (e.g. encoded data in Jabber XHTML message)
    
    Parameters:
    
    sDir - String value
  - getIMDirOut
```
public String getIMDirOut()
```
    get the directory to store outgoing binary data (e.g. encoded data in Jabber XHTML message)
    
    Returns:
    
    String value
  - setIMDirOut
```
public void setIMDirOut(String sDir)
```
    set the directory to store outgoing binary data (e.g. encoded data in Jabber XHTML message)
    
    Parameters:
    
    sDir - String value
  - getIMDomain
```
public String getIMDomain()
```
    get the Jabber logon domain
    
    Returns:
    
    String value
  - setIMDomain
```
public void setIMDomain(String sDomain)
```
    set the Jabber logon domain
    
    Parameters:
    
    sDomain - String value
  - getIMJID
```
public String getIMJID()
```
    get the Jabber ID to listen to upon connection
    
    Returns:
    
    String value
  - setIMJID
```
public void setIMJID(String sJID)
```
    set the Jabber ID to listen to upon connection
    
    Parameters:
    
    sJID - String value
  - getIMUserName
```
public String getIMUserName()
```
    get the Jabber user name
    
    Returns:
    
    String value
  - setIMUserName
```
public void setIMUserName(String sName)
```
    set the Jabber user name
    
    Parameters:
    
    sName - String value
  - getIMNickName
```
public String getIMNickName()
```
    get the Jabber user nickname
    
    Returns:
    
    String value
  - setIMNickName
```
public void setIMNickName(String sNick)
```
    set the Jabber user nickname
    
    Parameters:
    
    sNick - String value
  - getIMUserPassword
```
public String getIMUserPassword()
```
    get the Jabber user password
    
    Returns:
    
    String value
  - setIMUserPassword
```
public void setIMUserPassword(String sPwd)
```
    set the Jabber user password
    
    Parameters:
    
    sPwd - String value
  - getIMPort
```
public int getIMPort()
```
    get Jabber port no.
    
    Returns:
    
    numeric value
  - setIMPort
```
public void setIMPort(int iPort)
```
    set Jabber port no.
    
    Parameters:
    
    iPort - numeric value
  - getIMResource
```
public String getIMResource()
```
    get the Jabber user resource
    
    Returns:
    
    String value
  - setIMResource
```
public void setIMResource(String sResource)
```
    set the Jabber user resource
    
    Parameters:
    
    sResource - String value
  - init
```
public void init()
          throws Exception
```
    init - initialise the user interface
    
    Throws:
    
    Exception
  - makeTextPanel
```
protected Component makeTextPanel(String text)
```
    dummy text label for tabbed pages
    
    Parameters:
    
    text - string in JLabel
    
    Returns:
    
    text panel
  - setCriteriaBody
```
public void setCriteriaBody(String sJID)
```
    set list of Message Body keywords
    
    Parameters:
    
    sJID - Jabber user ID
  - setCriteriaSubject
```
public void setCriteriaSubject(String sJID)
```
    set list of Message Subject keywords
    
    Parameters:
    
    sJID - Jabber user ID
  - uiButton
```
public JPanel uiButton()
```
    panel of buttons
    
    Returns:
    
    JPanel
  - uiCriteria
```
public JPanel uiCriteria()
```
    create scrollable text area
    
    Returns:
    
    text area
  - uiIMConnect
```
public JPanel uiIMConnect()
```
    user interface to set/get Jabber user, password, domain, nickname
    
    Returns:
    
    JPanel for Jabber user parameters
  - uiIMRecv
```
public JPanel uiIMRecv()
```
    create a table to display list of incoming Jabber messages
    
    Returns:
    
    UIAgent JPanel
  - uiIMSend
```
public JPanel uiIMSend()
```
    create a table to display list of incoming Jabber messages
    
    Returns:
    
    UIAgent JPanel
  - uiTextArea
```
public JScrollPane uiTextArea()
```
    create scrollable text area
    
    Returns:
    
    text area
  - uiWeb
```
public JPanel uiWeb()
```
    user interface to start/stop webserver
    
    Returns:
    
    JPanel for web server user parameters
  - update
```
public void update(Observable ob,
                   Object obj)
```
    method is called whenever the observed object is changed.
    
    Specified by:
    
    update in interface Observer
    
    Parameters:
    
    ob - the objects this class is observing
    
    obj - object that is passed back when obserable invokes notifyObservers(obj)
  - processEncodeTest
```
public void processEncodeTest()
```
    test encode/decode performance
  - processHTTPGet
```
public void processHTTPGet()
```
    HTTP get file
  - processHTTPPost
```
public void processHTTPPost()
```
    HTTP post file
  - processIMSend
```
public void processIMSend()
```
    package and send out Jabber message
  - processObserverNotify
```
public void processObserverNotify()
```
    testing of Observer notifications
  - processb64
```
public void processb64()
```
    test base-64 encode/decode
  - processb64_2
```
public void processb64_2()
```
  - processClear
```
public void processClear()
```
    processClear - invoke clearTextFields to clean-up contents of JTextFields.
  - processP2P
```
public void processP2P()
```
    processParse - parser the paragraph
  - processWebStartStop
```
public void processWebStartStop()
```
    processWebStartStop - start/stop web server To serve to web page, type-in "http:///index.htm" in Internet Explorer browser
  - processXHTML
```
public void processXHTML(String sXML)
```
    process XHTML string and spawn respective application to display it.
    
    Parameters:
    
    sXML - XHTML string
  - processIMJoin
```
public void processIMJoin(String sRoom)
```
    processReset - group chat A group chat connects to a chat room on a server and allows you to send and receive messages from a group of people. Before you can send or receive messages, you must join the room using a nickname. The following code connects to a chat room and sends a message.
    
    Parameters:
    
    sRoom - chatroom e.g. "savage@conference.xchat.movesinstitute.org"
  - writeText
```
public void writeText(String aStr)
```
    write string to memobox
    
    Parameters:
    
    aStr - status string to be written
  - writeErr
```
public void writeErr(String aStr)
```
    write a error messgae to console
    
    Parameters:
    
    aStr - line to be written to console
  - writeLn
```
public void writeLn(String aStr)
```
    write a line to console
    
    Parameters:
    
    aStr - line to be written to console
  - writeLn
```
public static void writeLn(boolean bStr)
```
    write boolean value to console
    
    Parameters:
    
    bStr - boolean value to be written to console
  - writeLn
```
public static void writeLn(int iStr)
```
    write numeric value to console
    
    Parameters:
    
    iStr - numeric value to be written to console
  - writeLn
```
public void writeLn()
```
    write a line to console

Class UIAgent

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

Nested classes/interfaces inherited from class java.awt.Container

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JPanel

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Constructor Detail

UIAgent

Method Detail

addMessage

appOpenApp

appOpenFile

setConfigAppList

enableButtons

highlightText

getAgentConfig

getIMDirIn

setIMDirIn

getIMDirOut

setIMDirOut

getIMDomain

setIMDomain

getIMJID

setIMJID

getIMUserName

setIMUserName

getIMNickName

setIMNickName

getIMUserPassword

setIMUserPassword

getIMPort

setIMPort

getIMResource

setIMResource

init

makeTextPanel

setCriteriaBody

setCriteriaSubject

uiButton

uiCriteria

uiIMConnect

uiIMRecv

uiIMSend

uiTextArea

uiWeb

update

processEncodeTest

processHTTPGet

processHTTPPost

processIMSend

processObserverNotify

processb64

processb64_2

processClear

processP2P

processWebStartStop

processXHTML

processIMJoin

writeText

writeErr

writeLn

writeLn

writeLn

writeLn