1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
5 <!-- Generated by javadoc (build 1.5.0_09) on Tue Jan 08 20:46:02 GMT 2008 -->
7 ButtonCounter (leJOS NXT API documentation)
10 <META NAME="keywords" CONTENT="lejos.util.ButtonCounter class">
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
14 <SCRIPT type="text/javascript">
15 function windowTitle()
17 parent.document.title="ButtonCounter (leJOS NXT API documentation)";
25 <BODY BGCOLOR="white" onload="windowTitle();">
28 <!-- ========= START OF TOP NAVBAR ======= -->
29 <A NAME="navbar_top"><!-- --></A>
30 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
31 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
33 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
34 <A NAME="navbar_top_firstrow"><!-- --></A>
35 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
36 <TR ALIGN="center" VALIGN="top">
37 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
39 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
47 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
53 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
54 <A HREF="../../lejos/util/Assertion.html" title="class in lejos.util"><B>PREV CLASS</B></A>
55 <A HREF="../../lejos/util/Datalogger.html" title="class in lejos.util"><B>NEXT CLASS</B></A></FONT></TD>
56 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57 <A HREF="../../index.html?lejos/util/ButtonCounter.html" target="_top"><B>FRAMES</B></A>
58 <A HREF="ButtonCounter.html" target="_top"><B>NO FRAMES</B></A>
59 <SCRIPT type="text/javascript">
62 document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
67 <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
74 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
75 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
76 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
77 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
80 <A NAME="skip-navbar_top"></A>
81 <!-- ========= END OF TOP NAVBAR ========= -->
84 <!-- ======== START OF CLASS DATA ======== -->
89 Class ButtonCounter</H2>
91 <A HREF="../../java/lang/Object.html" title="class in java.lang">java.lang.Object</A>
92 <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>lejos.util.ButtonCounter</B>
96 <DT><PRE>public class <B>ButtonCounter</B><DT>extends <A HREF="../../java/lang/Object.html" title="class in java.lang">Object</A></DL>
100 This is class is for data entry using the NXT keyboard.
101 Counts number of presses of left and right buttons <br>
102 Press ENTER together with together with LEFT or RIGHT to decrease the count.
103 Press ESCAPE or ENTER alone to end counting.
104 Displays the count as it is entered, and makes a sound with each button press.
105 Stores the count in public fields
110 <DT><B>Author:</B></DT>
111 <DD>Roger Glassey 8/20/07</DD>
116 <!-- =========== FIELD SUMMARY =========== -->
118 <A NAME="field_summary"><!-- --></A>
119 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
120 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
121 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
122 <B>Field Summary</B></FONT></TH>
124 <TR BGCOLOR="white" CLASS="TableRowColor">
125 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
126 <CODE> int</CODE></FONT></TD>
127 <TD><CODE><B><A HREF="../../lejos/util/ButtonCounter.html#_leftCount">_leftCount</A></B></CODE>
130 Output only not used in calculations; use after count() returns;</TD>
132 <TR BGCOLOR="white" CLASS="TableRowColor">
133 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
134 <CODE> int</CODE></FONT></TD>
135 <TD><CODE><B><A HREF="../../lejos/util/ButtonCounter.html#_rightCount">_rightCount</A></B></CODE>
138 Output only not used in calculations ; use this value after count() returns;</TD>
142 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
144 <A NAME="constructor_summary"><!-- --></A>
145 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
146 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
147 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
148 <B>Constructor Summary</B></FONT></TH>
150 <TR BGCOLOR="white" CLASS="TableRowColor">
151 <TD><CODE><B><A HREF="../../lejos/util/ButtonCounter.html#ButtonCounter()">ButtonCounter</A></B>()</CODE>
154 </TD>
158 <!-- ========== METHOD SUMMARY =========== -->
160 <A NAME="method_summary"><!-- --></A>
161 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
162 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
163 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
164 <B>Method Summary</B></FONT></TH>
166 <TR BGCOLOR="white" CLASS="TableRowColor">
167 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
168 <CODE> void</CODE></FONT></TD>
169 <TD><CODE><B><A HREF="../../lejos/util/ButtonCounter.html#count()">count</A></B>()</CODE>
172 called by count( string)</TD>
174 <TR BGCOLOR="white" CLASS="TableRowColor">
175 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
176 <CODE> void</CODE></FONT></TD>
177 <TD><CODE><B><A HREF="../../lejos/util/ButtonCounter.html#count(java.lang.String)">count</A></B>(<A HREF="../../java/lang/String.html" title="class in java.lang">String</A> s)</CODE>
180 Start counting; parameter string is displayed; use it to identify this particular call <br>
181 returns when ESC or ENTER button is pressed <br>
182 Hold Enter and left or right to decrease count, otherwise it increases <br>
183 counters are reset when this method is called.</TD>
185 <TR BGCOLOR="white" CLASS="TableRowColor">
186 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
187 <CODE> void</CODE></FONT></TD>
188 <TD><CODE><B><A HREF="../../lejos/util/ButtonCounter.html#count(java.lang.String, int, int)">count</A></B>(<A HREF="../../java/lang/String.html" title="class in java.lang">String</A> s,
190 int right)</CODE>
193 Initializes values of left count and right count.</TD>
195 <TR BGCOLOR="white" CLASS="TableRowColor">
196 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
197 <CODE> int</CODE></FONT></TD>
198 <TD><CODE><B><A HREF="../../lejos/util/ButtonCounter.html#getLeftCount()">getLeftCount</A></B>()</CODE>
201 Use this method after counting is complete;</TD>
203 <TR BGCOLOR="white" CLASS="TableRowColor">
204 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
205 <CODE> int</CODE></FONT></TD>
206 <TD><CODE><B><A HREF="../../lejos/util/ButtonCounter.html#getRightCount()">getRightCount</A></B>()</CODE>
209 Use this method after counting is complete;</TD>
212 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
213 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
214 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
215 <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="../../java/lang/Object.html" title="class in java.lang">Object</A></B></TH>
217 <TR BGCOLOR="white" CLASS="TableRowColor">
218 <TD><CODE><A HREF="../../java/lang/Object.html#equals(java.lang.Object)">equals</A>, <A HREF="../../java/lang/Object.html#getClass()">getClass</A>, <A HREF="../../java/lang/Object.html#hashCode()">hashCode</A>, <A HREF="../../java/lang/Object.html#notify()">notify</A>, <A HREF="../../java/lang/Object.html#notifyAll()">notifyAll</A>, <A HREF="../../java/lang/Object.html#toString()">toString</A>, <A HREF="../../java/lang/Object.html#wait()">wait</A>, <A HREF="../../java/lang/Object.html#wait(long)">wait</A></CODE></TD>
224 <!-- ============ FIELD DETAIL =========== -->
226 <A NAME="field_detail"><!-- --></A>
227 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
228 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
229 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
230 <B>Field Detail</B></FONT></TH>
234 <A NAME="_rightCount"><!-- --></A><H3>
237 public int <B>_rightCount</B></PRE>
239 <DD>Output only not used in calculations ; use this value after count() returns;
246 <A NAME="_leftCount"><!-- --></A><H3>
249 public int <B>_leftCount</B></PRE>
251 <DD>Output only not used in calculations; use after count() returns;
257 <!-- ========= CONSTRUCTOR DETAIL ======== -->
259 <A NAME="constructor_detail"><!-- --></A>
260 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
261 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
262 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
263 <B>Constructor Detail</B></FONT></TH>
267 <A NAME="ButtonCounter()"><!-- --></A><H3>
270 public <B>ButtonCounter</B>()</PRE>
274 <!-- ============ METHOD DETAIL ========== -->
276 <A NAME="method_detail"><!-- --></A>
277 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
278 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
279 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
280 <B>Method Detail</B></FONT></TH>
284 <A NAME="getRightCount()"><!-- --></A><H3>
287 public int <B>getRightCount</B>()</PRE>
289 <DD>Use this method after counting is complete;
293 <DT><B>Returns:</B><DD>value of right count.</DL>
298 <A NAME="getLeftCount()"><!-- --></A><H3>
301 public int <B>getLeftCount</B>()</PRE>
303 <DD>Use this method after counting is complete;
307 <DT><B>Returns:</B><DD>value of left count.</DL>
312 <A NAME="count(java.lang.String)"><!-- --></A><H3>
315 public void <B>count</B>(<A HREF="../../java/lang/String.html" title="class in java.lang">String</A> s)</PRE>
317 <DD>Start counting; parameter string is displayed; use it to identify this particular call <br>
318 returns when ESC or ENTER button is pressed <br>
319 Hold Enter and left or right to decrease count, otherwise it increases <br>
320 counters are reset when this method is called.
328 <A NAME="count()"><!-- --></A><H3>
331 public void <B>count</B>()</PRE>
333 <DD>called by count( string)
341 <A NAME="count(java.lang.String, int, int)"><!-- --></A><H3>
344 public void <B>count</B>(<A HREF="../../java/lang/String.html" title="class in java.lang">String</A> s,
346 int right)</PRE>
348 <DD>Initializes values of left count and right count.
349 Displays parameter s ; sets _leftcount = left, _rightCount = right
355 <!-- ========= END OF CLASS DATA ========= -->
359 <!-- ======= START OF BOTTOM NAVBAR ====== -->
360 <A NAME="navbar_bottom"><!-- --></A>
361 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
362 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
364 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
365 <A NAME="navbar_bottom_firstrow"><!-- --></A>
366 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
367 <TR ALIGN="center" VALIGN="top">
368 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
369 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
370 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
371 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
372 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
373 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
374 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
378 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
384 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
385 <A HREF="../../lejos/util/Assertion.html" title="class in lejos.util"><B>PREV CLASS</B></A>
386 <A HREF="../../lejos/util/Datalogger.html" title="class in lejos.util"><B>NEXT CLASS</B></A></FONT></TD>
387 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
388 <A HREF="../../index.html?lejos/util/ButtonCounter.html" target="_top"><B>FRAMES</B></A>
389 <A HREF="ButtonCounter.html" target="_top"><B>NO FRAMES</B></A>
390 <SCRIPT type="text/javascript">
393 document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
398 <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
405 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
406 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
407 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
408 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
411 <A NAME="skip-navbar_bottom"></A>
412 <!-- ======== END OF BOTTOM NAVBAR ======= -->