<!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>ListBoxItem (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="ListBoxItem (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/ListBox.html" title="class in controlP5"><span class="strong">Prev Class</span></a></li>
<li><a href="../controlP5/Matrix.html" title="class in controlP5"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?controlP5/ListBoxItem.html" target="_top">Frames</a></li>
<li><a href="ListBoxItem.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: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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="Class ListBoxItem" class="title">Class ListBoxItem</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>controlP5.ListBoxItem</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">ListBoxItem</span>
extends java.lang.Object</pre>
<div class="block">Used by the ListBox class.</div>
</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"> </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><a href="../controlP5/CColor.html" title="class in controlP5">CColor</a></code></td>
<td class="colLast"><code><strong><a href="../controlP5/ListBoxItem.html#getColor()">getColor</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ListBoxItem.html#getId()">getId</a></strong>()</code>
<div class="block">returns the id of a listboxitem.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ListBoxItem.html#getName()">getName</a></strong>()</code>
<div class="block">returns the name of the listboxitem.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ListBoxItem.html#getText()">getText</a></strong>()</code>
<div class="block">returns the text displayed for this listboxitem.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ListBoxItem.html#getToUpperCase()">getToUpperCase</a></strong>()</code>
<div class="block">returns the uppercase status of this listboxitem.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ListBoxItem.html#getValue()">getValue</a></strong>()</code>
<div class="block">returns the value of the listboxitem.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ListBoxItem.html#isActive()">isActive</a></strong>()</code>
<div class="block">TODO no effect yet.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ListBoxItem.html#setColor(controlP5.CColor)">setColor</a></strong>(<a href="../controlP5/CColor.html" title="class in controlP5">CColor</a> theColor)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ListBoxItem.html#setColorActive(int)">setColorActive</a></strong>(int theColor)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ListBoxItem.html#setColorBackground(int)">setColorBackground</a></strong>(int theColor)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ListBoxItem.html#setColorForeground(int)">setColorForeground</a></strong>(int theColor)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ListBoxItem.html#setColorLabel(int)">setColorLabel</a></strong>(int theColor)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ListBoxItem.html#setId(int)">setId</a></strong>(int theId)</code>
<div class="block">set the id of a listboxitem</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../controlP5/ListBoxItem.html" title="class in controlP5">ListBoxItem</a></code></td>
<td class="colLast"><code><strong><a href="../controlP5/ListBoxItem.html#setText(java.lang.String)">setText</a></strong>(java.lang.String theText)</code>
<div class="block">change text text of a lsitboxitem's label.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ListBoxItem.html#toString()">toString</a></strong>()</code></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../controlP5/ListBoxItem.html#toUpperCase(boolean)">toUpperCase</a></strong>(boolean theFlag)</code>
<div class="block">by default the text of a listboxitem is set to uppercase, use toUpperCase(false) to make
changes.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class 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">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getColor()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColor</h4>
<pre>public <a href="../controlP5/CColor.html" title="class in controlP5">CColor</a> getColor()</pre>
</li>
</ul>
<a name="getId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getId</h4>
<pre>public int getId()</pre>
<div class="block">returns the id of a listboxitem.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>int</dd></dl>
</li>
</ul>
<a name="getName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>public java.lang.String getName()</pre>
<div class="block">returns the name of the listboxitem. use ListBox.itme(ListBoxItem.getName()) to access a
listboxitem by name.</div>
</li>
</ul>
<a name="getText()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getText</h4>
<pre>public java.lang.String getText()</pre>
<div class="block">returns the text displayed for this listboxitem. use setText(String) to apply changes.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd></dd></dl>
</li>
</ul>
<a name="getToUpperCase()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getToUpperCase</h4>
<pre>public boolean getToUpperCase()</pre>
<div class="block">returns the uppercase status of this listboxitem.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd></dd></dl>
</li>
</ul>
<a name="getValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre>public int getValue()</pre>
<div class="block">returns the value of the listboxitem.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>int</dd></dl>
</li>
</ul>
<a name="isActive()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isActive</h4>
<pre>public boolean isActive()</pre>
<div class="block">TODO no effect yet.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd></dd></dl>
</li>
</ul>
<a name="setColor(controlP5.CColor)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setColor</h4>
<pre>public void setColor(<a href="../controlP5/CColor.html" title="class in controlP5">CColor</a> theColor)</pre>
</li>
</ul>
<a name="setColorActive(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setColorActive</h4>
<pre>public void setColorActive(int theColor)</pre>
</li>
</ul>
<a name="setColorBackground(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setColorBackground</h4>
<pre>public void setColorBackground(int theColor)</pre>
</li>
</ul>
<a name="setColorForeground(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setColorForeground</h4>
<pre>public void setColorForeground(int theColor)</pre>
</li>
</ul>
<a name="setColorLabel(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setColorLabel</h4>
<pre>public void setColorLabel(int theColor)</pre>
</li>
</ul>
<a name="setId(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setId</h4>
<pre>public void setId(int theId)</pre>
<div class="block">set the id of a listboxitem</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theId</code> - </dd></dl>
</li>
</ul>
<a name="setText(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setText</h4>
<pre>public <a href="../controlP5/ListBoxItem.html" title="class in controlP5">ListBoxItem</a> setText(java.lang.String theText)</pre>
<div class="block">change text text of a lsitboxitem's label.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theText</code> - </dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="toUpperCase(boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toUpperCase</h4>
<pre>public void toUpperCase(boolean theFlag)</pre>
<div class="block">by default the text of a listboxitem is set to uppercase, use toUpperCase(false) to make
changes.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theFlag</code> - </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/ListBox.html" title="class in controlP5"><span class="strong">Prev Class</span></a></li>
<li><a href="../controlP5/Matrix.html" title="class in controlP5"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?controlP5/ListBoxItem.html" target="_top">Frames</a></li>
<li><a href="ListBoxItem.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: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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>