All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class IMSWG.IW.SubSet.Modelet

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.Window
                           |
                           +----java.awt.Frame
                                   |
                                   +----IMSWG.IW.SubSet.Modelet

public abstract class Modelet
extends Frame
This class provides a framework for applets to be run under the EOSDIS IMS V0 Web Gateway. It provides basic mechanisms for accessing CGI parameters, building the exit URL, and handling the following user interface items:

Subclasses of this class will have to use a go() routine rather than the standard applet init() routine. This is necessary because we must ensure that the necessary initialization of Modelet occurs before any subclass of Modelet receives control.


Variable Index

 o applet
 o messageDialog
The Message Dialog.
 o messageLabel
The message dialog label.
 o messagePanel
The message dialog panel.
 o modeletCancelButton
The "Cancel" Button.
 o modeletChoice
The actual Choice (pop-up) to be added to the user interface by classes inheriting from Modelet.
 o modeletOKButton
The "OK" Button.
 o modeletStatusArea
The StatusArea text area.
 o modifyParameters
A copy of the original parameters that may be modified during processing by subclasses of Modelet.
 o myJumpMenu
Holds the 'command-and-control" info for the jump menu.
 o originalParameters
Original version of the parsed parameters.

Constructor Index

 o Modelet(Applet)
This method creates the basic Modelet interface objects.

Method Index

 o buildBaseInterface()
 o cleanUp()
Dummy routine to be overridden in any subclass of Modelet.
 o clearAwayFrame()
 o frameTitle(String)
 o go()
Dummy routine to be overridden in any subclass of Modelet.
 o goAway(Parameters)
This method accepts a set of parameters, determines where the Web Gateway should go after finishing this transaction, saves this in the information to be passed to the servlet, sends the info, and then builds the proper URL to force ModeApplet to be invoked.
 o goAwayCancel()
This method invokes the goAway method with the parameters that were originally provided with the applet.
 o goAwayOK()
This method invokes the goAway method with the parameters as modified by the user during this interaction with the Modelet.
 o letItGo(boolean)
This method restores the cursor to the default cursor and enables the frame.
 o loadMode(Parameters)
This method builds the necessary URL to get back in contact with the Web gateway and jumps to it.
 o loadMode(String, String, String)
 o loadMode(String, String, String, String)
This method builds the necessary URL to get back in contact with the Web gateway and pops up a new browser window using target name.
 o loadModePUKE(String, String, String, String, String)
 o lockItUp(String, boolean)
This method changes the cursor to a wait cursor and disables the frame.
 o post(Parameters, String)
Do a post request
 o reinit()
Abstract method which must be overriden by a child of Modelet.
 o run()
Abstract method to be overridden in any subclass of Modelet.
 o setTargetMode(String)
Sets the mode to which ModeAPPLET should dispatch after control is returned to the Web Gateway.
 o start()
Dummy routine to be overridden in any subclass of Modelet.

Variables

 o applet
 public Applet applet
 o myJumpMenu
 public JumpMenu myJumpMenu
Holds the 'command-and-control" info for the jump menu. Not initialized statically because we don't know what to put in it until we have read the parameters.

 o modeletChoice
 public Choice modeletChoice
The actual Choice (pop-up) to be added to the user interface by classes inheriting from Modelet. Accessible as this.modeletChoice in subclasses.

 o modeletOKButton
 public Button modeletOKButton
The "OK" Button. Accessible as this.modeletOKButton in subclasses.

 o modeletCancelButton
 public Button modeletCancelButton
The "Cancel" Button. Accessible as this.modeletCancelButton in subclasses.

 o originalParameters
 public Parameters originalParameters
Original version of the parsed parameters. Should not be modified.

 o modifyParameters
 public Parameters modifyParameters
A copy of the original parameters that may be modified during processing by subclasses of Modelet. Accessible as this.modifyParameters.

 o modeletStatusArea
 public StatusArea modeletStatusArea
The StatusArea text area. Accessible as this.modeletStatusArea in subclasses.

 o messageDialog
 public Dialog messageDialog
The Message Dialog. Used to inform users when the frame is locked up. Accessible as this.messageDialog in subclasses.

 o messageLabel
 public Label messageLabel
The message dialog label. Used when frame is locked up as an explanatory message. Accessible as this.messageLabel in subclasses.

 o messagePanel
 public Panel messagePanel
The message dialog panel. Used when frame is locked up as panel for explanatory message. Accessible as this.messagePanel in subclasses.

Constructors

 o Modelet
 public Modelet(Applet passedApplet)
This method creates the basic Modelet interface objects. It parses the parameters, creating a Parameter object, and builds (but does not display) the user interface items it is responsible for. It must be called before any subclass can start using these items.

Methods

 o go
 public void go()
Dummy routine to be overridden in any subclass of Modelet. This method is used in the same manner as the init() method would be used in a standard Applet.

See Also:
init
 o start
 public void start()
Dummy routine to be overridden in any subclass of Modelet. This method is used in the same manner as the start() method would be used in a standard Applet. All child classes of Modelet are now required to have a start() method which makes sure the applet is put into a consistent state if the browser back button is used.

See Also:
start
 o cleanUp
 public void cleanUp()
Dummy routine to be overridden in any subclass of Modelet. This method is used to close/stop/cleanup any windows/processes that are running that should be stopped prior to the Frame being closed

 o buildBaseInterface
 public void buildBaseInterface()
 o run
 public void run()
Abstract method to be overridden in any subclass of Modelet. This method is used in the same manner as the init() method would be used in a standard Applet.

See Also:
init
 o reinit
 public void reinit()
Abstract method which must be overriden by a child of Modelet. This gets called by StartMapplet's (should be StartModelet) start() method, anytime a Modelet applet is restarted.

 o post
 public void post(Parameters theParameters,
                  String postString)
Do a post request

 o goAway
 public void goAway(Parameters theParameters)
This method accepts a set of parameters, determines where the Web Gateway should go after finishing this transaction, saves this in the information to be passed to the servlet, sends the info, and then builds the proper URL to force ModeApplet to be invoked.

 o goAwayOK
 public void goAwayOK()
This method invokes the goAway method with the parameters as modified by the user during this interaction with the Modelet. This method may be overridden to provide additional functionality when the OK button is clicked.

See Also:
goAway
 o goAwayCancel
 public void goAwayCancel()
This method invokes the goAway method with the parameters that were originally provided with the applet. This method may be overridden to provide additional functionality when the Cancel button is clicked.

See Also:
goAway
 o setTargetMode
 public void setTargetMode(String newMode)
Sets the mode to which ModeAPPLET should dispatch after control is returned to the Web Gateway. Note that this is "mode", and not "p.mode". Mode::switch expects "mode".

 o loadMode
 public void loadMode(Parameters theParameters)
This method builds the necessary URL to get back in contact with the Web gateway and jumps to it.

 o loadMode
 public void loadMode(String mode,
                      String submode,
                      String moreParams,
                      String target)
This method builds the necessary URL to get back in contact with the Web gateway and pops up a new browser window using target name. mode is the mode to go to. submode is the submode to go to. moreParams is a string of extra param tags. Each param tag should have ¶mName="value". target is the name of the new browser window. Note: This does not do a "clearAwayFrame".

 o loadMode
 public void loadMode(String mode,
                      String submode,
                      String moreParams)
 o loadModePUKE
 public void loadModePUKE(String errNumber,
                          String errMessage,
                          String httpdHost,
                          String scriptName,
                          String sid)
 o clearAwayFrame
 public void clearAwayFrame()
 o frameTitle
 public void frameTitle(String title)
 o lockItUp
 public void lockItUp(String dialogMessage,
                      boolean showIt)
This method changes the cursor to a wait cursor and disables the frame.

 o letItGo
 public void letItGo(boolean hideIt)
This method restores the cursor to the default cursor and enables the frame.


All Packages  Class Hierarchy  This Package  Previous  Next  Index