TransientAgentInternalFrame

java.lang.Object
- casa.ui.ObservingAgentUI
- - casa.ui.AbstractInternalFrame
  - - casa.ui.TransientAgentInternalFrame

All Implemented Interfaces:

AgentUI, ActionListener, WindowListener, EventListener, Observer, InternalFrameListener

Direct Known Subclasses:

AgentInternalFrame, AgentRemoteProxyWindow, AuctionAgentInternalFrame, DutchAuctionAgentInternalFrame, EnglishAuctionAgentInternalFrame, TransactionAgentInternalFrame
```
public class TransientAgentInternalFrame
extends AbstractInternalFrame
implements ActionListener
```
This class acts as a default windows interface for agents. The window looks like this:
```
   +-------------------------------------------------------------+
   | Title Bar                                                   |
   +-------------------------------------------------------------+
   | Menu Bar                                makeJMenuBar()      |
   +-------------------------------------------------------------+
   | Agent URL Panel                    makeAgentURLPanel()      |
   +-------------------------------------------------------------+
   |  ______________   ________________   _____________________  |
   | /     CD       | /  Commitments   | /    Command          | |
   | |makeCDPanel() | |agent.          | |makeCommandTabPanel()| |
   | |              | |getStrategyGUI()| |                     | |
   | +---------------------------------------------------------+ |
   | |                                                         | |
   | |                                                         | |
   | |                                                         | |
   | +---------------------------------------------------------+ |
   +-------------------------------------------------------------+

 
```
Subclasses may override any of the make*() factory methods to yield appropriate behaviour. To add a tab, simply override the #addPanels(Container, int) method, and if necessary the unsplit method to remove any additional panels created.
Copyright: Copyright 2003-2014, Knowledge Science Group, University of Calgary. Permission to use, copy, modify, distribute and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. The Knowledge Science Group makes no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty.
Version:

0.9

Author:

Rob Kremer , Gabriel Becerra , Eunice Lim, Vladimir Sedach, Daniel Bidulock

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`buttonEXECUTE`
`protected static int`	`buttonPAUSE`
`protected static int`	`buttonRESUME`
`protected static int`	`buttonSTEP`
`protected boolean`	`closingPort`
`protected JPanel`	`contentPanel` /********** Tab panels in the interface ************* /****************************************************** / The pane that contains the various tab panels.
`protected JToolBar`	`debugBar`
`(package private) static int`	`DEFAULT_X`
`(package private) static int`	`DEFAULT_Y`
`protected static boolean`	`HORIZONTAL`
`protected static int`	`menuADD_NEW_TAB`
`protected JMenuItem`	`menuAgent_editOntology`
`protected JMenuItem`	`menuAgent_Exit`
`protected JMenuItem`	`menuAgent_options`
`protected JCheckBoxMenuItem`	`menuAgent_setDebug`
`protected JCheckBoxMenuItem`	`menuAgent_showMessageArea`
`protected JMenuItem`	`menuAgent_showTrace`
`protected JMenu`	`menuCD`
`protected JMenuItem`	`menuCD_Join`
`protected static int`	`menuCLEARDEBUG`
`protected static int`	`menuEDIT_ONTOLOGY`
`protected static int`	`menuEDIT_ONTOLOGY_GRAPHICAL`
`protected static int`	`menuEXIT`
`protected static int`	`menuFIRST_DYNAMIC_EVENT`
`protected static int`	`menuGETYELLOWPAGES`
`protected static int`	`menuHIDE_DEBUG_BAR`
`protected static int`	`menuHIDE_MESSAGE_AREA`
`protected static int`	`menuINFO`
`protected static int`	`menuINVITECD`
`protected static int`	`menuJOINCD`
`protected JMenu`	`menuLAC`
`protected JMenuItem`	`menuLAC_RegisterInstance`
`protected JMenuItem`	`menuLAC_UnregisterInstance`
`protected static int`	`menuLAST_DYNAMIC_EVENT`
`protected static int`	`menuOPTIONS`
`protected static int`	`menuREGISTER`
`protected static int`	`menuSET_ACK_PROTOCOL`
`protected static int`	`menuSHOW_DEBUG_BAR`
`protected static int`	`menuSHOW_MESSAGE_AREA`
`protected static int`	`menuSHOWTRACE`
`protected static int`	`menuUNREGISTER`
`protected static int`	`menuUserManual`
`protected JMenuItem`	`menuWindow_hideDebugBar`
`protected JMenuItem`	`menuWindow_showDebugBar`
`protected static int`	`menuWITHDRAWCD`
`protected JMenu`	`menuYP`
`protected static int`	`noAction`
`protected JButton`	`pauseButton`
`(package private) JLabel`	`pausedLabel`
`private JTextField`	`port`
`private JPanel`	`registrationPanel`
`protected JButton`	`resumeButton`
`protected LinkedList<JSplitPane>`	`splitPanes`
`protected JButton`	`stepButton`
`protected static int`	`transientAgentFrame_LAST_EVENT`
`protected static boolean`	`VERTICAL`

Fields inherited from class casa.ui.ObservingAgentUI
agent, showEvents, showInfo, showMessages, showTrace, showUnknown

Fields inherited from interface casa.ui.AgentUI
TYPE_ANY, TYPE_BOOLEAN, TYPE_FLOAT, TYPE_INT, TYPE_STRING

Constructor Summary

Constructors
Constructor and Description
`TransientAgentInternalFrame(TransientAgent agent, String title, Container aFrame)` Constructor: builds a TransientAgentInternalFrame by calling `makeJMenuBar`and `#addPanels`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`actionPerformed(ActionEvent e)` implementation of the ActionListener interface
`String`	`ask(String prompt, String help, int type, String _default)` The general contract is that the UI will return a string from the user after prompting the use, that conforms to the the type specified by the type parameter.
`protected void`	`closeInternalFrame()` Adaptor method: when isInternalFrameClosable() returns true, this method calls the agent's exit() method to shut down the agent.
`OutputStream`	`getOutStream()` Returns an output stream that can be used to write to the interface
`private JPanel`	`getRegistrationPanel()`
`TransientAgentInterface`	`getTransientAgent()`
`protected void`	`inviteToCD()`
`private void`	`joinCD()` If the user chooses to join a CD, a dialog will pop up offering three possibilities of joining a CD: local, create and Join a local CD, or provide the IP:Port of a non-local CD.
`protected JMenuBar`	`makeMenuBar()` Factory Method to create a generic Agent menu bar.
`void`	`print(String txt)`
`void`	`print(String tempTxt, boolean tempNormal, String color)` These variables are a work around so that we may access them in anonymous classes particularly that found in print(String,boolean).
`void`	`println(String txt)`
`protected void`	`printStatus(Status status, String commandString)`
`private void`	`registerAgent()`
`protected void`	`setDebugBar()`
`void`	`start()` Starts displaying the UI
`boolean`	`takesHTML()`
`private void`	`unregisterAgent()`
`void`	`updateEventHandler(Observable observable, String event, Object argObject)` This method is called whenever the `AbstractInternalFrame.update(Observable, Object)` gets an Object that's a `ObserverNotification`.
`void`	`updateHandler(Observable observable, Object obj)` This method is called from `AbstractInternalFrame.update(Observable, Object)` but this method to always be executed in the AWT Event thread.

Methods inherited from class casa.ui.AbstractInternalFrame
addFrameListener, addScript, addTab, CDMembersMouseHook, CDSelectionChanged, closeWindow, createRequestedMenuItem, dispose, doDefaultCloseAction, getBuildTime, getCommandPanel, getContentPane, getDesktopIcon, getFrame, getHeight, getLayeredPane, getListCDMembers, getMenuBarMenu, getRootPane, getTab, getTabComponent, getTabPane, getTitle, getWidth, insertMenuBar, insertMenuBarAfter, insertMenuBarBefore, insertTab, insertTabAfter, internalFrameActivated, internalFrameClosed, internalFrameClosing, internalFrameDeactivated, internalFrameDeiconified, internalFrameIconified, internalFrameOpened, isClosed, isIcon, isInternalFrameClosable, isMaximized, makeAgentMenu, makeCDPanel, makeCommandPanel, makeHelpMenu, makeTabPane, makeToolsMenu, makeTypeEditDialog, makeWindowMenu, pack, refreshTabMenu, removeTab, replaceMenuBar, replaceTabComponent, runInEventDispatchThread, runInEventDispatchThread, setClosable, setContentPane, setFrameIcon, setIcon, setIconifiable, setInfoPanel, setInfoPanel, setJMenuBar, setLocation, setMaximizable, setMaximized, setName, setOpaque, setResizable, setSelected, setSelectedTab, setSize, setTitle, setVisible, show, toFront, update, updateCDListFromAgent, updateCDmemberJList, updateMemberList, updateOptions, updateStrategyPanel, validate, windowActivated, windowClosed, windowClosing, windowDeactivated, windowDeiconified, windowIconified, windowOpened, withdrawCD

Methods inherited from class casa.ui.ObservingAgentUI
eval, evalWithHistory, handleEvent, handleOther, printlnObject

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

- Field Detail
  - menuAgent_setDebug
```
protected JCheckBoxMenuItem menuAgent_setDebug
```
  - menuAgent_showTrace
```
protected JMenuItem menuAgent_showTrace
```
  - menuAgent_showMessageArea
```
protected JCheckBoxMenuItem menuAgent_showMessageArea
```
  - menuAgent_options
```
protected JMenuItem menuAgent_options
```
  - menuAgent_editOntology
```
protected JMenuItem menuAgent_editOntology
```
  - menuAgent_Exit
```
protected JMenuItem menuAgent_Exit
```
  - menuLAC
```
protected JMenu menuLAC
```
  - menuLAC_RegisterInstance
```
protected JMenuItem menuLAC_RegisterInstance
```
  - menuLAC_UnregisterInstance
```
protected JMenuItem menuLAC_UnregisterInstance
```
  - menuYP
```
protected JMenu menuYP
```
  - menuCD
```
protected JMenu menuCD
```
  - menuCD_Join
```
protected JMenuItem menuCD_Join
```
  - menuWindow_showDebugBar
```
protected JMenuItem menuWindow_showDebugBar
```
  - menuWindow_hideDebugBar
```
protected JMenuItem menuWindow_hideDebugBar
```
  - contentPanel
```
protected final JPanel contentPanel
```
    /************ Tab panels in the interface ***************** /********************************************************** /** The pane that contains the various tab panels. It controls the splitting and unsplitting of panes.
  - debugBar
```
protected JToolBar debugBar
```
  - pauseButton
```
protected JButton pauseButton
```
  - resumeButton
```
protected JButton resumeButton
```
  - stepButton
```
protected JButton stepButton
```
  - pausedLabel
```
JLabel pausedLabel
```
  - splitPanes
```
protected LinkedList<JSplitPane> splitPanes
```
  - closingPort
```
protected boolean closingPort
```
  - noAction
```
protected static final int noAction
```
    See Also:
    
    Constant Field Values
  - menuREGISTER
```
protected static final int menuREGISTER
```
    See Also:
    
    Constant Field Values
  - menuUNREGISTER
```
protected static final int menuUNREGISTER
```
    See Also:
    
    Constant Field Values
  - menuINVITECD
```
protected static final int menuINVITECD
```
    See Also:
    
    Constant Field Values
  - menuGETYELLOWPAGES
```
protected static final int menuGETYELLOWPAGES
```
    See Also:
    
    Constant Field Values
  - menuCLEARDEBUG
```
protected static final int menuCLEARDEBUG
```
    See Also:
    
    Constant Field Values
  - menuEXIT
```
protected static final int menuEXIT
```
    See Also:
    
    Constant Field Values
  - menuJOINCD
```
protected static final int menuJOINCD
```
    See Also:
    
    Constant Field Values
  - menuWITHDRAWCD
```
protected static final int menuWITHDRAWCD
```
    See Also:
    
    Constant Field Values
  - menuSET_ACK_PROTOCOL
```
protected static final int menuSET_ACK_PROTOCOL
```
    See Also:
    
    Constant Field Values
  - menuOPTIONS
```
protected static final int menuOPTIONS
```
    See Also:
    
    Constant Field Values
  - menuSHOWTRACE
```
protected static final int menuSHOWTRACE
```
    See Also:
    
    Constant Field Values
  - menuEDIT_ONTOLOGY
```
protected static final int menuEDIT_ONTOLOGY
```
    See Also:
    
    Constant Field Values
  - menuSHOW_MESSAGE_AREA
```
protected static final int menuSHOW_MESSAGE_AREA
```
    See Also:
    
    Constant Field Values
  - menuHIDE_MESSAGE_AREA
```
protected static final int menuHIDE_MESSAGE_AREA
```
    See Also:
    
    Constant Field Values
  - buttonEXECUTE
```
protected static final int buttonEXECUTE
```
    See Also:
    
    Constant Field Values
  - menuINFO
```
protected static final int menuINFO
```
    See Also:
    
    Constant Field Values
  - buttonPAUSE
```
protected static final int buttonPAUSE
```
    See Also:
    
    Constant Field Values
  - buttonRESUME
```
protected static final int buttonRESUME
```
    See Also:
    
    Constant Field Values
  - buttonSTEP
```
protected static final int buttonSTEP
```
    See Also:
    
    Constant Field Values
  - menuSHOW_DEBUG_BAR
```
protected static final int menuSHOW_DEBUG_BAR
```
    See Also:
    
    Constant Field Values
  - menuHIDE_DEBUG_BAR
```
protected static final int menuHIDE_DEBUG_BAR
```
    See Also:
    
    Constant Field Values
  - menuEDIT_ONTOLOGY_GRAPHICAL
```
protected static final int menuEDIT_ONTOLOGY_GRAPHICAL
```
    See Also:
    
    Constant Field Values
  - menuADD_NEW_TAB
```
protected static final int menuADD_NEW_TAB
```
    See Also:
    
    Constant Field Values
  - menuUserManual
```
protected static final int menuUserManual
```
    See Also:
    
    Constant Field Values
  - menuFIRST_DYNAMIC_EVENT
```
protected static final int menuFIRST_DYNAMIC_EVENT
```
    See Also:
    
    Constant Field Values
  - menuLAST_DYNAMIC_EVENT
```
protected static final int menuLAST_DYNAMIC_EVENT
```
    See Also:
    
    Constant Field Values
  - transientAgentFrame_LAST_EVENT
```
protected static final int transientAgentFrame_LAST_EVENT
```
    See Also:
    
    Constant Field Values
  - VERTICAL
```
protected static final boolean VERTICAL
```
    See Also:
    
    Constant Field Values
  - HORIZONTAL
```
protected static final boolean HORIZONTAL
```
    See Also:
    
    Constant Field Values
  - DEFAULT_X
```
static int DEFAULT_X
```
  - DEFAULT_Y
```
static int DEFAULT_Y
```
  - registrationPanel
```
private JPanel registrationPanel
```
  - port
```
private JTextField port
```
- Constructor Detail
  - TransientAgentInternalFrame
```
public TransientAgentInternalFrame(TransientAgent agent,
                                   String title,
                                   Container aFrame)
```
    Constructor: builds a TransientAgentInternalFrame by calling makeJMenuBarand #addPanels.
    
    Parameters:
    
    agent - the agent for which this an interface
    
    title - The title of the window
    
    aFrame - Either a JFrame or a JInternal Frame object to use for the frame.
- Method Detail
  - takesHTML
```
public boolean takesHTML()
```
    Specified by:
    
    takesHTML in interface AgentUI
  - closeInternalFrame
```
protected void closeInternalFrame()
```
    Adaptor method: when isInternalFrameClosable() returns true, this method calls the agent's exit() method to shut down the agent.
    
    Overrides:
    
    closeInternalFrame in class AbstractInternalFrame
  - makeMenuBar
```
protected JMenuBar makeMenuBar()
```
    Factory Method to create a generic Agent menu bar. Subclasses may override to customize the menu. Used in the constructor of a window.
    
    Overrides:
    
    makeMenuBar in class AbstractInternalFrame
    
    Returns:
    
    a generic Agent menu bar
  - actionPerformed
```
public void actionPerformed(ActionEvent e)
```
    implementation of the ActionListener interface
    
    Specified by:
    
    actionPerformed in interface ActionListener
    
    Parameters:
    
    e - --> Object implemented as a listener. It interacts with getActionCommand() & intValue(). The value returned is assigned to the variable: command <-- used in the switch in order to set the activity of the Window, i.e. closeWindow()
  - printStatus
```
protected void printStatus(Status status,
                           String commandString)
```
  - setDebugBar
```
protected void setDebugBar()
```
  - inviteToCD
```
protected void inviteToCD()
```
  - joinCD
```
private void joinCD()
```
    If the user chooses to join a CD, a dialog will pop up offering three possibilities of joining a CD: local, create and Join a local CD, or provide the IP:Port of a non-local CD.
  - registerAgent
```
private void registerAgent()
```
  - getRegistrationPanel
```
private JPanel getRegistrationPanel()
```
  - unregisterAgent
```
private void unregisterAgent()
```
  - updateHandler
```
public void updateHandler(Observable observable,
                          Object obj)
```
    Description copied from class: AbstractInternalFrame
    
    This method is called from AbstractInternalFrame.update(Observable, Object) but this method to always be executed in the AWT Event thread. You should use this instead of AbstractInternalFrame.update(Observable, Object) (which is final).
    
    Overrides:
    
    updateHandler in class AbstractInternalFrame
    
    Parameters:
    
    observable - The Observable that triggered this update call
    
    obj - The parameter object
  - updateEventHandler
```
public void updateEventHandler(Observable observable,
                               String event,
                               Object argObject)
```
    Description copied from class: AbstractInternalFrame
    
    This method is called whenever the AbstractInternalFrame.update(Observable, Object) gets an Object that's a ObserverNotification. The ObserverNotification is split into the components, and that forms the arguments to this method. Note that if you need to you the raw info from AbstractInternalFrame.update(Observable, Object), then you should put your code in AbstractInternalFrame.updateHandler(Observable, Object) which is unconditionally called with the raw parameters. You can expect this method to always be executed in the AWT Event thread.
    
    Overrides:
    
    updateEventHandler in class AbstractInternalFrame
    
    Parameters:
    
    event -
    
    argObject -
    
    observable - The Observable that triggered this update call
  - print
```
public void print(String tempTxt,
                  boolean tempNormal,
                  String color)
```
    These variables are a work around so that we may access them in anonymous classes particularly that found in print(String,boolean).
  - print
```
public void print(String txt)
```
    Specified by:
    
    print in interface AgentUI
  - println
```
public void println(String txt)
```
    Specified by:
    
    println in interface AgentUI
  - ask
```
public String ask(String prompt,
                  String help,
                  int type,
                  String _default)
```
    Description copied from interface: AgentUI
    
    The general contract is that the UI will return a string from the user after prompting the use, that conforms to the the type specified by the type parameter. If the use just hits [return] the default parameter value is returned. The input prompt is repeated until an acceptable input is typed.
    Specified by:
    
    ask in interface AgentUI
    
    Parameters:
    
    prompt - The prompt the use will see
    
    help - An extended prompt if the user enters something inappropriate
    type - The type which may be
    
    AgentUI.TYPE_STRING: any String
    AgentUI.TYPE_ANY: any String
    AgentUI.TYPE_INT: an integer that can be parsed by Integer.parseInt(String)
    AgentUI.TYPE_FLOAT: any float number that can be parsed by Float.parseFloat(String)
    AgentUI.TYPE_BOOLEAN: any of "true", "yes", "on" or "1" for a return of "true"; or any of "false", "no", "off", or "0" for a return of "false" (case insensitive)
    _default - The value to return (unchecked) if the user just hits [return]
    
    Returns:
    
    A string conforming to the type parameter as listed above.
  - getOutStream
```
public OutputStream getOutStream()
```
    Returns an output stream that can be used to write to the interface
    
    Specified by:
    
    getOutStream in interface AgentUI
  - getTransientAgent
```
public TransientAgentInterface getTransientAgent()
```
  - start
```
public void start()
```
    Starts displaying the UI
    
    Specified by:
    
    start in interface AgentUI

Class TransientAgentInternalFrame

Field Summary

Fields inherited from class casa.ui.AbstractInternalFrame

Fields inherited from class casa.ui.ObservingAgentUI

Fields inherited from interface casa.ui.AgentUI

Constructor Summary

Method Summary

Methods inherited from class casa.ui.AbstractInternalFrame

Methods inherited from class casa.ui.ObservingAgentUI

Methods inherited from class java.lang.Object

Field Detail

menuAgent_setDebug

menuAgent_showTrace

menuAgent_showMessageArea

menuAgent_options

menuAgent_editOntology

menuAgent_Exit

menuLAC

menuLAC_RegisterInstance

menuLAC_UnregisterInstance

menuYP

menuCD

menuCD_Join

menuWindow_showDebugBar

menuWindow_hideDebugBar

contentPanel

debugBar

pauseButton

resumeButton

stepButton

pausedLabel

splitPanes

closingPort

noAction

menuREGISTER

menuUNREGISTER

menuINVITECD

menuGETYELLOWPAGES

menuCLEARDEBUG

menuEXIT

menuJOINCD

menuWITHDRAWCD

menuSET_ACK_PROTOCOL

menuOPTIONS

menuSHOWTRACE

menuEDIT_ONTOLOGY

menuSHOW_MESSAGE_AREA

menuHIDE_MESSAGE_AREA

buttonEXECUTE

menuINFO

buttonPAUSE

buttonRESUME

buttonSTEP

menuSHOW_DEBUG_BAR

menuHIDE_DEBUG_BAR

menuEDIT_ONTOLOGY_GRAPHICAL

menuADD_NEW_TAB

menuUserManual

menuFIRST_DYNAMIC_EVENT

menuLAST_DYNAMIC_EVENT

transientAgentFrame_LAST_EVENT

VERTICAL

HORIZONTAL

DEFAULT_X

DEFAULT_Y

registrationPanel

port

Constructor Detail

TransientAgentInternalFrame

Method Detail

takesHTML

closeInternalFrame

makeMenuBar

actionPerformed

printStatus

setDebugBar

inviteToCD

joinCD

registerAgent

getRegistrationPanel