aboutsummaryrefslogtreecommitdiffstats
path: root/doc/jcgp/backend/parameters/BooleanParameter.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/jcgp/backend/parameters/BooleanParameter.html')
-rw-r--r--doc/jcgp/backend/parameters/BooleanParameter.html394
1 files changed, 0 insertions, 394 deletions
diff --git a/doc/jcgp/backend/parameters/BooleanParameter.html b/doc/jcgp/backend/parameters/BooleanParameter.html
deleted file mode 100644
index 01f89aa..0000000
--- a/doc/jcgp/backend/parameters/BooleanParameter.html
+++ /dev/null
@@ -1,394 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<!-- NewPage -->
-<html lang="en">
-<head>
-<!-- Generated by javadoc (1.8.0_05) on Thu May 22 06:02:30 BST 2014 -->
-<title>BooleanParameter</title>
-<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>
-<body>
-<script type="text/javascript"><!--
- try {
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="BooleanParameter";
- }
- }
- catch(err) {
- }
-//-->
-var methods = {"i0":10,"i1":10};
-var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
-var altColor = "altColor";
-var rowColor = "rowColor";
-var tableTab = "tableTab";
-var activeTableTab = "activeTableTab";
-</script>
-<noscript>
-<div>JavaScript is disabled on your browser.</div>
-</noscript>
-<!-- ========= START OF TOP NAVBAR ======= -->
-<div class="topNav"><a name="navbar.top">
-<!-- -->
-</a>
-<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
-<a name="navbar.top.firstrow">
-<!-- -->
-</a>
-<ul class="navList" title="Navigation">
-<li><a href="../../../overview-summary.html">Overview</a></li>
-<li><a href="package-summary.html">Package</a></li>
-<li class="navBarCell1Rev">Class</li>
-<li><a href="class-use/BooleanParameter.html">Use</a></li>
-<li><a href="package-tree.html">Tree</a></li>
-<li><a href="../../../deprecated-list.html">Deprecated</a></li>
-<li><a href="../../../index-files/index-1.html">Index</a></li>
-<li><a href="../../../help-doc.html">Help</a></li>
-</ul>
-</div>
-<div class="subNav">
-<ul class="navList">
-<li>Prev&nbsp;Class</li>
-<li><a href="../../../jcgp/backend/parameters/DoubleParameter.html" title="class in jcgp.backend.parameters"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
-</ul>
-<ul class="navList">
-<li><a href="../../../index.html?jcgp/backend/parameters/BooleanParameter.html" target="_top">Frames</a></li>
-<li><a href="BooleanParameter.html" target="_top">No&nbsp;Frames</a></li>
-</ul>
-<ul class="navList" id="allclasses_navbar_top">
-<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
-</ul>
-<div>
-<script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_top");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
-</script>
-</div>
-<div>
-<ul class="subNavList">
-<li>Summary:&nbsp;</li>
-<li>Nested&nbsp;|&nbsp;</li>
-<li>Field&nbsp;|&nbsp;</li>
-<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
-<li><a href="#method.summary">Method</a></li>
-</ul>
-<ul class="subNavList">
-<li>Detail:&nbsp;</li>
-<li>Field&nbsp;|&nbsp;</li>
-<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
-<li><a href="#method.detail">Method</a></li>
-</ul>
-</div>
-<a name="skip.navbar.top">
-<!-- -->
-</a></div>
-<!-- ========= END OF TOP NAVBAR ========= -->
-<!-- ======== START OF CLASS DATA ======== -->
-<div class="header">
-<div class="subTitle">jcgp.backend.parameters</div>
-<h2 title="Class BooleanParameter" class="title">Class BooleanParameter</h2>
-</div>
-<div class="contentContainer">
-<ul class="inheritance">
-<li>java.lang.Object</li>
-<li>
-<ul class="inheritance">
-<li><a href="../../../jcgp/backend/parameters/Parameter.html" title="class in jcgp.backend.parameters">jcgp.backend.parameters.Parameter</a>&lt;java.lang.Boolean&gt;</li>
-<li>
-<ul class="inheritance">
-<li>jcgp.backend.parameters.BooleanParameter</li>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-<div class="description">
-<ul class="blockList">
-<li class="blockList">
-<dl>
-<dt>Direct Known Subclasses:</dt>
-<dd><a href="../../../jcgp/backend/parameters/monitors/BooleanMonitor.html" title="class in jcgp.backend.parameters.monitors">BooleanMonitor</a></dd>
-</dl>
-<hr>
-<br>
-<pre>public class <span class="typeNameLabel">BooleanParameter</span>
-extends <a href="../../../jcgp/backend/parameters/Parameter.html" title="class in jcgp.backend.parameters">Parameter</a>&lt;java.lang.Boolean&gt;</pre>
-<div class="block">Parameter subclass for the boolean type. Most of the
- functionality is already implemented in <code>Parameter</code>,
- leaving only construction and type definition to the
- subclasses.
- <br><br>
- This class contains three constructors, two of which are public.
- One assumes the parameter is not critical and only takes a name
- and initial value, while the other allows the critical flag
- to be set as well. The third constructor is protected and allows
- the monitor flag to be set as well, allowing subclasses of this class
- to be used as monitors. See <a href="../../../jcgp/backend/parameters/monitors/BooleanMonitor.html" title="class in jcgp.backend.parameters.monitors"><code>BooleanMonitor</code></a> for an example
- of this usage.
- <br><br>
- The validate method is overridden here and left blank since not all
- parameters actually require validation, but where validation is
- required this method can be anonymously overridden on an instance-to-instance
- basis.</div>
-<dl>
-<dt><span class="simpleTagLabel">Author:</span></dt>
-<dd>Eduardo Pedroni</dd>
-</dl>
-</li>
-</ul>
-</div>
-<div class="summary">
-<ul class="blockList">
-<li class="blockList">
-<!-- =========== PROPERTY SUMMARY =========== -->
-<ul class="blockList">
-<li class="blockList"><a name="property.summary">
-<!-- -->
-</a>
-<h3>Property Summary</h3>
-<ul class="blockList">
-<li class="blockList"><a name="properties.inherited.from.class.jcgp.backend.parameters.Parameter">
-<!-- -->
-</a>
-<h3>Properties inherited from class&nbsp;jcgp.backend.parameters.<a href="../../../jcgp/backend/parameters/Parameter.html" title="class in jcgp.backend.parameters">Parameter</a></h3>
-<code><a href="../../../jcgp/backend/parameters/Parameter.html#valueProperty">valueProperty</a></code></li>
-</ul>
-</li>
-</ul>
-<!-- ======== CONSTRUCTOR SUMMARY ======== -->
-<ul class="blockList">
-<li class="blockList"><a name="constructor.summary">
-<!-- -->
-</a>
-<h3>Constructor Summary</h3>
-<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
-<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
-<tr>
-<th class="colOne" scope="col">Constructor and Description</th>
-</tr>
-<tr class="altColor">
-<td class="colOne"><code><span class="memberNameLink"><a href="../../../jcgp/backend/parameters/BooleanParameter.html#BooleanParameter-boolean-java.lang.String-">BooleanParameter</a></span>(boolean&nbsp;value,
- java.lang.String&nbsp;name)</code>
-<div class="block">Creates a new instance of this class, assuming the parameter
- is not critical.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colOne"><code><span class="memberNameLink"><a href="../../../jcgp/backend/parameters/BooleanParameter.html#BooleanParameter-boolean-java.lang.String-boolean-">BooleanParameter</a></span>(boolean&nbsp;value,
- java.lang.String&nbsp;name,
- boolean&nbsp;critical)</code>
-<div class="block">Creates a new instance of this class.</div>
-</td>
-</tr>
-</table>
-</li>
-</ul>
-<!-- ========== METHOD SUMMARY =========== -->
-<ul class="blockList">
-<li class="blockList"><a name="method.summary">
-<!-- -->
-</a>
-<h3>Method Summary</h3>
-<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
-<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
-<tr>
-<th class="colFirst" scope="col">Modifier and Type</th>
-<th class="colLast" scope="col">Method and Description</th>
-</tr>
-<tr id="i0" class="altColor">
-<td class="colFirst"><code>java.lang.Boolean</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/parameters/BooleanParameter.html#get--">get</a></span>()</code>&nbsp;</td>
-</tr>
-<tr id="i1" class="rowColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/parameters/BooleanParameter.html#validate-java.lang.Boolean-">validate</a></span>(java.lang.Boolean&nbsp;newValue)</code>
-<div class="block">This is a callback method which gets called whenever changes
- to parameters (not only its own instance) are made.</div>
-</td>
-</tr>
-</table>
-<ul class="blockList">
-<li class="blockList"><a name="methods.inherited.from.class.jcgp.backend.parameters.Parameter">
-<!-- -->
-</a>
-<h3>Methods inherited from class&nbsp;jcgp.backend.parameters.<a href="../../../jcgp/backend/parameters/Parameter.html" title="class in jcgp.backend.parameters">Parameter</a></h3>
-<code><a href="../../../jcgp/backend/parameters/Parameter.html#getStatus--">getStatus</a>, <a href="../../../jcgp/backend/parameters/Parameter.html#isCritical--">isCritical</a>, <a href="../../../jcgp/backend/parameters/Parameter.html#isMonitor--">isMonitor</a>, <a href="../../../jcgp/backend/parameters/Parameter.html#set-T-">set</a>, <a href="../../../jcgp/backend/parameters/Parameter.html#toString--">toString</a>, <a href="../../../jcgp/backend/parameters/Parameter.html#valueProperty--">valueProperty</a></code></li>
-</ul>
-<ul class="blockList">
-<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
-<!-- -->
-</a>
-<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
-<code>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-</div>
-<div class="details">
-<ul class="blockList">
-<li class="blockList">
-<!-- ========= CONSTRUCTOR DETAIL ======== -->
-<ul class="blockList">
-<li class="blockList"><a name="constructor.detail">
-<!-- -->
-</a>
-<h3>Constructor Detail</h3>
-<a name="BooleanParameter-boolean-java.lang.String-">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>BooleanParameter</h4>
-<pre>public&nbsp;BooleanParameter(boolean&nbsp;value,
- java.lang.String&nbsp;name)</pre>
-<div class="block">Creates a new instance of this class, assuming the parameter
- is not critical.</div>
-<dl>
-<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>value</code> - the initial value for this parameter.</dd>
-<dd><code>name</code> - the name of this parameter, for GUI display.</dd>
-</dl>
-</li>
-</ul>
-<a name="BooleanParameter-boolean-java.lang.String-boolean-">
-<!-- -->
-</a>
-<ul class="blockListLast">
-<li class="blockList">
-<h4>BooleanParameter</h4>
-<pre>public&nbsp;BooleanParameter(boolean&nbsp;value,
- java.lang.String&nbsp;name,
- boolean&nbsp;critical)</pre>
-<div class="block">Creates a new instance of this class.</div>
-<dl>
-<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>value</code> - the initial value for this parameter.</dd>
-<dd><code>name</code> - the name of this parameter, for GUI display.</dd>
-<dd><code>critical</code> - true if the parameter is critical.</dd>
-</dl>
-</li>
-</ul>
-</li>
-</ul>
-<!-- ============ METHOD DETAIL ========== -->
-<ul class="blockList">
-<li class="blockList"><a name="method.detail">
-<!-- -->
-</a>
-<h3>Method Detail</h3>
-<a name="get--">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>get</h4>
-<pre>public&nbsp;java.lang.Boolean&nbsp;get()</pre>
-<dl>
-<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
-<dd><code><a href="../../../jcgp/backend/parameters/Parameter.html#get--">get</a></code>&nbsp;in class&nbsp;<code><a href="../../../jcgp/backend/parameters/Parameter.html" title="class in jcgp.backend.parameters">Parameter</a>&lt;java.lang.Boolean&gt;</code></dd>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>the parameter's current value.</dd>
-</dl>
-</li>
-</ul>
-<a name="validate-java.lang.Boolean-">
-<!-- -->
-</a>
-<ul class="blockListLast">
-<li class="blockList">
-<h4>validate</h4>
-<pre>public&nbsp;void&nbsp;validate(java.lang.Boolean&nbsp;newValue)</pre>
-<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jcgp/backend/parameters/Parameter.html#validate-T-">Parameter</a></code></span></div>
-<div class="block">This is a callback method which gets called whenever changes
- to parameters (not only its own instance) are made. This method
- is intended to set the <code>status</code> field according to the
- new value, so that the user can be informed if any parameters
- are currently set to invalid values.</div>
-<dl>
-<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
-<dd><code><a href="../../../jcgp/backend/parameters/Parameter.html#validate-T-">validate</a></code>&nbsp;in class&nbsp;<code><a href="../../../jcgp/backend/parameters/Parameter.html" title="class in jcgp.backend.parameters">Parameter</a>&lt;java.lang.Boolean&gt;</code></dd>
-<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>newValue</code> - the new value.</dd>
-</dl>
-</li>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-</div>
-</div>
-<!-- ========= END OF CLASS DATA ========= -->
-<!-- ======= START OF BOTTOM NAVBAR ====== -->
-<div class="bottomNav"><a name="navbar.bottom">
-<!-- -->
-</a>
-<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
-<a name="navbar.bottom.firstrow">
-<!-- -->
-</a>
-<ul class="navList" title="Navigation">
-<li><a href="../../../overview-summary.html">Overview</a></li>
-<li><a href="package-summary.html">Package</a></li>
-<li class="navBarCell1Rev">Class</li>
-<li><a href="class-use/BooleanParameter.html">Use</a></li>
-<li><a href="package-tree.html">Tree</a></li>
-<li><a href="../../../deprecated-list.html">Deprecated</a></li>
-<li><a href="../../../index-files/index-1.html">Index</a></li>
-<li><a href="../../../help-doc.html">Help</a></li>
-</ul>
-</div>
-<div class="subNav">
-<ul class="navList">
-<li>Prev&nbsp;Class</li>
-<li><a href="../../../jcgp/backend/parameters/DoubleParameter.html" title="class in jcgp.backend.parameters"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
-</ul>
-<ul class="navList">
-<li><a href="../../../index.html?jcgp/backend/parameters/BooleanParameter.html" target="_top">Frames</a></li>
-<li><a href="BooleanParameter.html" target="_top">No&nbsp;Frames</a></li>
-</ul>
-<ul class="navList" id="allclasses_navbar_bottom">
-<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
-</ul>
-<div>
-<script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_bottom");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
-</script>
-</div>
-<div>
-<ul class="subNavList">
-<li>Summary:&nbsp;</li>
-<li>Nested&nbsp;|&nbsp;</li>
-<li>Field&nbsp;|&nbsp;</li>
-<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
-<li><a href="#method.summary">Method</a></li>
-</ul>
-<ul class="subNavList">
-<li>Detail:&nbsp;</li>
-<li>Field&nbsp;|&nbsp;</li>
-<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
-<li><a href="#method.detail">Method</a></li>
-</ul>
-</div>
-<a name="skip.navbar.bottom">
-<!-- -->
-</a></div>
-<!-- ======== END OF BOTTOM NAVBAR ======= -->
-</body>
-</html>