OSDN Git Service

lejos_NXJ_win32_0_6_0beta.zip
[nxt-jsp/lejos_nxj.git] / nxtOSEK / lejos_nxj / docs / apidocs / lejos / nxt / Button.html
index a1263a6..902b202 100644 (file)
@@ -2,7 +2,7 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.5.0_09) on Tue Jan 08 20:46:01 GMT 2008 -->
+<!-- Generated by javadoc (build 1.5.0_09) on Mon May 05 21:42:41 BST 2008 -->
 <TITLE>
 Button (leJOS NXT API documentation)
 </TITLE>
@@ -160,6 +160,14 @@ Abstraction for an NXT button.
 <BR>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The Right button.</TD>
 </TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;<A HREF="../../java/lang/String.html" title="class in java.lang">String</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../lejos/nxt/Button.html#VOL_SETTING">VOL_SETTING</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+</TR>
 </TABLE>
 &nbsp;
 <!-- ========== METHOD SUMMARY =========== -->
@@ -196,6 +204,30 @@ Abstraction for an NXT button.
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;int</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../lejos/nxt/Button.html#getKeyClickLength()">getKeyClickLength</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the current key click length.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;int</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../lejos/nxt/Button.html#getKeyClickTone(int)">getKeyClickTone</A></B>(int&nbsp;key)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the click freq for a particular key.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;int</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../lejos/nxt/Button.html#getKeyClickVolume()">getKeyClickVolume</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the current key click volume.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>&nbsp;boolean</CODE></FONT></TD>
 <TD><CODE><B><A HREF="../../lejos/nxt/Button.html#isPressed()">isPressed</A></B>()</CODE>
 
@@ -204,6 +236,14 @@ Abstraction for an NXT button.
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../lejos/nxt/Button.html#loadSettings()">loadSettings</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Load the current system settings associated with this class.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>static&nbsp;int</CODE></FONT></TD>
 <TD><CODE><B><A HREF="../../lejos/nxt/Button.html#readButtons()">readButtons</A></B>()</CODE>
 
@@ -212,6 +252,31 @@ Abstraction for an NXT button.
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../lejos/nxt/Button.html#setKeyClickLength(int)">setKeyClickLength</A></B>(int&nbsp;len)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the len used for key clicks</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../lejos/nxt/Button.html#setKeyClickTone(int, int)">setKeyClickTone</A></B>(int&nbsp;key,
+                int&nbsp;freq)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the frequency used for a particular key.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../lejos/nxt/Button.html#setKeyClickVolume(int)">setKeyClickVolume</A></B>(int&nbsp;vol)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the volume used for key clicks</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>static&nbsp;int</CODE></FONT></TD>
 <TD><CODE><B><A HREF="../../lejos/nxt/Button.html#waitForPress()">waitForPress</A></B>()</CODE>
 
@@ -249,6 +314,16 @@ Abstraction for an NXT button.
 </TR>
 </TABLE>
 
+<A NAME="VOL_SETTING"><!-- --></A><H3>
+VOL_SETTING</H3>
+<PRE>
+public static final <A HREF="../../java/lang/String.html" title="class in java.lang">String</A> <B>VOL_SETTING</B></PRE>
+<DL>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#lejos.nxt.Button.VOL_SETTING">Constant Field Values</A></DL>
+</DL>
+<HR>
+
 <A NAME="ENTER"><!-- --></A><H3>
 ENTER</H3>
 <PRE>
@@ -437,6 +512,125 @@ public void <B>callListeners</B>()</PRE>
 </DL>
 </DD>
 </DL>
+<HR>
+
+<A NAME="setKeyClickVolume(int)"><!-- --></A><H3>
+setKeyClickVolume</H3>
+<PRE>
+public static void <B>setKeyClickVolume</B>(int&nbsp;vol)</PRE>
+<DL>
+<DD>Set the volume used for key clicks
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>vol</CODE> - </DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getKeyClickVolume()"><!-- --></A><H3>
+getKeyClickVolume</H3>
+<PRE>
+public static int <B>getKeyClickVolume</B>()</PRE>
+<DL>
+<DD>Return the current key click volume.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>current click volume</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setKeyClickLength(int)"><!-- --></A><H3>
+setKeyClickLength</H3>
+<PRE>
+public static void <B>setKeyClickLength</B>(int&nbsp;len)</PRE>
+<DL>
+<DD>Set the len used for key clicks
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>len</CODE> - the click duration</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getKeyClickLength()"><!-- --></A><H3>
+getKeyClickLength</H3>
+<PRE>
+public static int <B>getKeyClickLength</B>()</PRE>
+<DL>
+<DD>Return the current key click length.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>key click duration</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setKeyClickTone(int, int)"><!-- --></A><H3>
+setKeyClickTone</H3>
+<PRE>
+public static void <B>setKeyClickTone</B>(int&nbsp;key,
+                                   int&nbsp;freq)</PRE>
+<DL>
+<DD>Set the frequency used for a particular key. Setting this to 0 disables
+ the click. Note that key may also be a corded set of keys.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - the NXT key<DD><CODE>freq</CODE> - the frequency</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getKeyClickTone(int)"><!-- --></A><H3>
+getKeyClickTone</H3>
+<PRE>
+public static int <B>getKeyClickTone</B>(int&nbsp;key)</PRE>
+<DL>
+<DD>Return the click freq for a particular key.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>key click duration</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="loadSettings()"><!-- --></A><H3>
+loadSettings</H3>
+<PRE>
+public static void <B>loadSettings</B>()</PRE>
+<DL>
+<DD>Load the current system settings associated with this class. Called
+ automatically to initialize the class. May be called if it is required
+ to reload any settings.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
 <!-- ========= END OF CLASS DATA ========= -->
 <HR>