COSC_4P82_Assignment_1/lib/lilgp/lilgpSetup1.0/javadocs/SubPopFrame.html

159 lines
6.1 KiB
HTML
Raw Normal View History

2024-02-13 21:21:51 -05:00
<!--NewPage-->
<html>
<head>
<!-- Generated by javadoc on Sat May 10 12:20:47 1997 -->
<a name="_top_"></a>
<title>
Class SubPopFrame
</title>
</head>
<body>
<h1>
Class SubPopFrame
</h1>
<pre>
<a href="java.lang.Object.html#_top_">java.lang.Object</a>
|
+----<a href="java.awt.Component.html#_top_">java.awt.Component</a>
|
+----<a href="java.awt.Container.html#_top_">java.awt.Container</a>
|
+----<a href="java.awt.Window.html#_top_">java.awt.Window</a>
|
+----<a href="java.awt.Frame.html#_top_">java.awt.Frame</a>
|
+----SubPopFrame
</pre>
<hr>
<dl>
<dt> class <b>SubPopFrame</b>
<dt> extends <a href="java.awt.Frame.html#_top_">Frame</a>
</dl>
This frame contains a <tt>TitlePanel</tt> and groups of UI components
that allow the user to specify the following sub-pop exchange parameters:
<br><tt><ul><li>exch[#].from
<li>exch[#].fromselect
<li>exch[#].to
<li>exch[#].toselect
<li>exch[#].count</ul></tt><br>
There is also a group of buttons that allow the user to add, replace, edit,
and accept the exchanges. There is a List component in the bottom of the
frame that is used to show the current exchanges.
The constructor function creates a second frame that contains a <tt>SubPopGraph</tt>.
<dl>
<dt> <b>See Also:</b>
<dd> <a href="SubPopGraph.html#_top_">SubPopGraph</a>
</dl>
<hr>
<a name="index"></a>
<h2>
<img src="images/constructor-index.gif" width=275 height=38 alt="Constructor Index">
</h2>
<dl>
<dt> <img src="images/yellow-ball-small.gif" width=6 height=6 alt=" o ">
<a href="#SubPopFrame(int, boolean)"><b>SubPopFrame</b></a>(int, boolean)
<dd> Add each of the UI components needed to accept input.
</dl>
<h2>
<img src="images/method-index.gif" width=207 height=38 alt="Method Index">
</h2>
<dl>
<dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
<a href="#action(java.awt.Event, java.lang.Object)"><b>action</b></a>(Event, Object)
<dd> Trap <tt>Button</tt> events.
<dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
<a href="#keyDown(java.awt.Event, int)"><b>keyDown</b></a>(Event, int)
<dd> if there is a selected exchange and the user has not clicked
the edit button, deselect the exchange so it doesn't look like
they are editing it.
<dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
<a href="#loadParams()"><b>loadParams</b></a>()
<dd> This methos is responsible for loading parameters into the exchange hashtable
and refreshing the sub-pop graph.
<dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
<a href="#showGraphFrame()"><b>showGraphFrame</b></a>()
<dd> This method is called by the <tt>SubPopPanel</tt> when the user clicks on the <tt>go</tt>
button to reshow the sub-pop graph Frame.
</dl>
<a name="constructors"></a>
<h2>
<img src="images/constructors.gif" width=231 height=38 alt="Constructors">
</h2>
<a name="SubPopFrame"></a>
<a name="SubPopFrame(int, boolean)"><img src="images/yellow-ball.gif" width=12 height=12 alt=" o "></a>
<b>SubPopFrame</b>
<pre>
public SubPopFrame(int np,
boolean showGraph)
</pre>
<dl>
<dd> Add each of the UI components needed to accept input.
<dl>
<dt> <b>Parameters:</b>
<dd> np - the number of sub populations
<dt> <b>See Also:</b>
<dd> <a href="GridBagPanel.html#addComponent">addComponent</a>
</dl>
</dl>
<a name="methods"></a>
<h2>
<img src="images/methods.gif" width=151 height=38 alt="Methods">
</h2>
<a name="action(java.awt.Event, java.lang.Object)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="action"><b>action</b></a>
<pre>
public boolean action(<a href="java.awt.Event.html#_top_">Event</a> e,
<a href="java.lang.Object.html#_top_">Object</a> arg)
</pre>
<dl>
<dd> Trap <tt>Button</tt> events. If the <tt>Accept</tt> button is pressed,
then <tt>hide()</tt> the <tt>SubPopFrame</tt> and re-enable the <tt>Go</tt>
button and the <tt>purge</tt> button on the <tt>SubPopPanel</tt>. If the
<tt>accept</tt> button has been pressed, then all of the parameters associated
with sub-pops are purged from the database before adding the new ones.
<dl>
<dt> <b>Overrides:</b>
<dd> <a href="java.awt.Component.html#action(java.awt.Event, java.lang.Object)">action</a> in class <a href="java.awt.Component.html#_top_">Component</a>
<dt> <b>See Also:</b>
<dd> <a href="SubPopsPanel.html#_top_">SubPopsPanel</a>, <a href="SubPopsPanel.html#enableButtons">enableButtons</a>
</dl>
</dl>
<a name="keyDown(java.awt.Event, int)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="keyDown"><b>keyDown</b></a>
<pre>
public boolean keyDown(<a href="java.awt.Event.html#_top_">Event</a> e,
int key)
</pre>
<dl>
<dd> if there is a selected exchange and the user has not clicked
the edit button, deselect the exchange so it doesn't look like
they are editing it. This code is repeated from
the <tt>action()</tt> method since typing in a <tt>TextField</tt> doesn't
generate an <tt>ACTION_EVENT</tt>.
<dl>
<dt> <b>Overrides:</b>
<dd> <a href="java.awt.Component.html#keyDown(java.awt.Event, int)">keyDown</a> in class <a href="java.awt.Component.html#_top_">Component</a>
</dl>
</dl>
<a name="loadParams()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="loadParams"><b>loadParams</b></a>
<pre>
public void loadParams()
</pre>
<dl>
<dd> This methos is responsible for loading parameters into the exchange hashtable
and refreshing the sub-pop graph. It also loads the exchange descriptions into
the summary list.
</dl>
<a name="showGraphFrame()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="showGraphFrame"><b>showGraphFrame</b></a>
<pre>
public void showGraphFrame()
</pre>
<dl>
<dd> This method is called by the <tt>SubPopPanel</tt> when the user clicks on the <tt>go</tt>
button to reshow the sub-pop graph Frame.
</dl>
</body>
</html>