aboutsummaryrefslogtreecommitdiffstats
path: root/doc/jcgp/gui/settings/SettingsPane.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/jcgp/gui/settings/SettingsPane.html')
-rw-r--r--doc/jcgp/gui/settings/SettingsPane.html41
1 files changed, 34 insertions, 7 deletions
diff --git a/doc/jcgp/gui/settings/SettingsPane.html b/doc/jcgp/gui/settings/SettingsPane.html
index 63f03d4..bb1e7b2 100644
--- a/doc/jcgp/gui/settings/SettingsPane.html
+++ b/doc/jcgp/gui/settings/SettingsPane.html
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (1.8.0_05) on Mon May 12 23:05:43 BST 2014 -->
+<!-- Generated by javadoc (1.8.0_05) on Thu May 22 06:02:31 BST 2014 -->
<title>SettingsPane</title>
-<meta name="date" content="2014-05-12">
+<meta name="date" content="2014-05-22">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
@@ -140,6 +140,15 @@ var activeTableTab = "activeTableTab";
<br>
<pre>public class <span class="typeNameLabel">SettingsPane</span>
extends javafx.scene.layout.AnchorPane</pre>
+<div class="block">This is a fairly hefty class which encapsulates the entire right-hand
+ control pane. It contains base parameters, module selectors and their
+ associated parameters, flow controls and file loading/saving buttons.
+ <br><br>
+ A single instance of this class is used in <code>GUI</code>.</div>
+<dl>
+<dt><span class="simpleTagLabel">Author:</span></dt>
+<dd>Eduardo Pedroni</dd>
+</dl>
</li>
</ul>
</div>
@@ -209,7 +218,10 @@ extends javafx.scene.layout.AnchorPane</pre>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
-<td class="colOne"><code><span class="memberNameLink"><a href="../../../jcgp/gui/settings/SettingsPane.html#SettingsPane-jcgp.gui.GUI-">SettingsPane</a></span>(<a href="../../../jcgp/gui/GUI.html" title="class in jcgp.gui">GUI</a>&nbsp;gui)</code>&nbsp;</td>
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../jcgp/gui/settings/SettingsPane.html#SettingsPane-jcgp.gui.GUI-">SettingsPane</a></span>(<a href="../../../jcgp/gui/GUI.html" title="class in jcgp.gui">GUI</a>&nbsp;gui)</code>
+<div class="block">Create a new instance of <code>SettingsPane</code> associated
+ with the specified <code>GUI</code> object.</div>
+</td>
</tr>
</table>
</li>
@@ -327,6 +339,12 @@ extends javafx.scene.layout.AnchorPane</pre>
<li class="blockList">
<h4>SettingsPane</h4>
<pre>public&nbsp;SettingsPane(<a href="../../../jcgp/gui/GUI.html" title="class in jcgp.gui">GUI</a>&nbsp;gui)</pre>
+<div class="block">Create a new instance of <code>SettingsPane</code> associated
+ with the specified <code>GUI</code> object.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>gui</code> - a reference to this object's parent.</dd>
+</dl>
</li>
</ul>
</li>
@@ -344,6 +362,10 @@ extends javafx.scene.layout.AnchorPane</pre>
<li class="blockList">
<h4>isExperimentRunning</h4>
<pre>public&nbsp;boolean&nbsp;isExperimentRunning()</pre>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>true if the experiment is currently evolving something, false otherwise.</dd>
+</dl>
</li>
</ul>
<a name="isResetRequired--">
@@ -381,7 +403,10 @@ extends javafx.scene.layout.AnchorPane</pre>
<pre>public&nbsp;void&nbsp;revalidateParameters()</pre>
<div class="block">Calls validate() on every parameter. This is called whenever a parameter changes,
so that other parameters update their status in case they were dependent on the
- changed parameter.</div>
+ changed parameter.
+ <br><br>
+ This also disables the controls if a reset is necessary, preventing the experiment
+ from running until it has happened.</div>
</li>
</ul>
<a name="applyParameters--">
@@ -392,7 +417,9 @@ extends javafx.scene.layout.AnchorPane</pre>
<h4>applyParameters</h4>
<pre>public&nbsp;void&nbsp;applyParameters()</pre>
<div class="block">Calls applyValue() on every parameter. This is called when a reset occurs, so that
- the new value will be used as a reference instead of the old reference value.</div>
+ the new value will be used as a reference instead of the old reference value.
+ <br><br>
+ It also closes the test case table, just in case.</div>
</li>
</ul>
<a name="updateControls-boolean-boolean-">
@@ -408,8 +435,8 @@ extends javafx.scene.layout.AnchorPane</pre>
running or finished.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>running</code> - true if the experiment is running</dd>
-<dd><code>finished</code> - true if the experiment is finished</dd>
+<dd><code>running</code> - true if the experiment is running.</dd>
+<dd><code>finished</code> - true if the experiment is finished.</dd>
</dl>
</li>
</ul>