controlp5/reference/controlP5/ControlListener.html

270 lines
10 KiB
HTML

<!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 (version 1.7.0_51) on Sun Apr 27 21:39:47 SGT 2014 -->
<title>ControlListener (Javadocs: controlP5)</title>
<meta name="date" content="2014-04-27">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ControlListener (Javadocs: controlP5)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../controlP5/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../controlP5/ControllerView.html" title="interface in controlP5"><span class="strong">Prev Class</span></a></li>
<li><a href="../controlP5/ControlP5.html" title="class in controlP5"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?controlP5/ControlListener.html" target="_top">Frames</a></li>
<li><a href="ControlListener.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../allclasses-noframe.html">All 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>Constr&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>Constr&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">controlP5</div>
<h2 title="Interface ControlListener" class="title">Interface ControlListener</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../controlP5/Accordion.html" title="class in controlP5">Accordion</a>, <a href="../controlP5/CheckBox.html" title="class in controlP5">CheckBox</a>, <a href="../controlP5/ColorPicker.html" title="class in controlP5">ColorPicker</a>, <a href="../controlP5/ControlGroup.html" title="class in controlP5">ControlGroup</a>, <a href="../controlP5/ControllerGroup.html" title="class in controlP5">ControllerGroup</a>, <a href="../controlP5/DropdownList.html" title="class in controlP5">DropdownList</a>, <a href="../controlP5/Group.html" title="class in controlP5">Group</a>, <a href="../controlP5/ListBox.html" title="class in controlP5">ListBox</a>, <a href="../controlP5/MultiList.html" title="class in controlP5">MultiList</a>, <a href="../controlP5/Radio.html" title="class in controlP5">Radio</a>, <a href="../controlP5/RadioButton.html" title="class in controlP5">RadioButton</a>, <a href="../controlP5/ScrollableList.html" title="class in controlP5">ScrollableList</a>, <a href="../controlP5/Tab.html" title="class in controlP5">Tab</a>, <a href="../controlP5/Textarea.html" title="class in controlP5">Textarea</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">ControlListener</span></pre>
<div class="block">ControlListener is an interface that can be implemented by a custom class to be notified when
controller values change. To add a ControlListener to a controller use Controller.addListner()</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../controlP5/Controller.html#addListener(controlP5.ControlListener)"><code>Controller.addListener(ControlListener)</code></a>,
<a href="../controlP5/CallbackListener.html" title="interface in controlP5"><code>CallbackListener</code></a></dd><script type="text/javascript">
<!--
document.getElementsByTagName('html')[0].className = 'isjs';function toggle(dt) { var display, dd=dt; do{ dd = dd.nextSibling } while(dd.tagName!='DD'); toOpen =!dd.style.display;dd.style.display = toOpen? 'block':''; dt.getElementsByTagName('span')[0].innerHTML = toOpen? '-':'+' ; }
-->
</script>
<div id="test" class="toggleList"><dl><dt onclick="toggle(this);"><span>+</span>Example</dt><dd><code><pre>/**
* ControlP5 Listener.
* the ControlListener interface can be used to implement a custom
* ControlListener which listens for incoming ControlEvent from specific
* controller(s). MyControlListener in the example below listens to
* ControlEvents coming in from controller 'mySlider'.
*
* by andreas schlegel, 2012
*/
import controlP5.*;
ControlP5 cp5;
MyControlListener myListener;
void setup() {
size(700,400);
cp5 = new ControlP5(this);
cp5.setColor(ControlP5.THEME_RED);
cp5.addSlider("mySlider")
.setRange(100,200)
.setValue(140)
.setPosition(200,200)
.setSize(200,20);
myListener = new MyControlListener();
cp5.getController("mySlider").addListener(myListener);
}
void draw() {
background(myListener.col);
}
class MyControlListener implements ControlListener {
int col;
public void controlEvent(ControlEvent theEvent) {
println("i got an event from mySlider, " +
"changing background color to "+
theEvent.getController().getValue());
col = (int)theEvent.getController().getValue();
}
}
</pre></code></dd></dl></div></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ControlListener.html#controlEvent(controlP5.ControlEvent)">controlEvent</a></strong>(<a href="../controlP5/ControlEvent.html" title="class in controlP5">ControlEvent</a>&nbsp;theEvent)</code>
<div class="block">controlEvent is called by controlP5's ControlBroadcaster to inform available listeners about
value changes.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="controlEvent(controlP5.ControlEvent)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>controlEvent</h4>
<pre>void&nbsp;controlEvent(<a href="../controlP5/ControlEvent.html" title="class in controlP5">ControlEvent</a>&nbsp;theEvent)</pre>
<div class="block">controlEvent is called by controlP5's ControlBroadcaster to inform available listeners about
value changes. Use the CallbackListener to get informed when actions such as pressed,
release, drag, etc are performed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theEvent</code> - ControlEvent</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../controlP5/CallbackListener.html" title="interface in controlP5"><code>CallbackListener</code></a>,
<a href="../controlP5/CallbackEvent.html" title="class in controlP5"><code>CallbackEvent</code></a></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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../controlP5/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../controlP5/ControllerView.html" title="interface in controlP5"><span class="strong">Prev Class</span></a></li>
<li><a href="../controlP5/ControlP5.html" title="class in controlP5"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?controlP5/ControlListener.html" target="_top">Frames</a></li>
<li><a href="ControlListener.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../allclasses-noframe.html">All 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>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>processing library controlP5 by Andreas Schlegel. (c) 2006-2014</small></p>
</body>
</html>