mirror of
https://github.com/sojamo/controlp5
synced 2024-11-19 12:37:57 +01:00
685 lines
26 KiB
HTML
685 lines
26 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:48 SGT 2014 -->
|
||
|
|
<title>Tooltip (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="Tooltip (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/Toggle.html" title="class in controlP5"><span class="strong">Prev Class</span></a></li>
|
||
|
|
<li>Next Class</li>
|
||
|
|
</ul>
|
||
|
|
<ul class="navList">
|
||
|
|
<li><a href="../index.html?controlP5/Tooltip.html" target="_top">Frames</a></li>
|
||
|
|
<li><a href="Tooltip.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 Tooltip" class="title">Class Tooltip</h2>
|
||
|
|
</div>
|
||
|
|
<div class="contentContainer">
|
||
|
|
<ul class="inheritance">
|
||
|
|
<li>java.lang.Object</li>
|
||
|
|
<li>
|
||
|
|
<ul class="inheritance">
|
||
|
|
<li>controlP5.Tooltip</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<div class="description">
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<hr>
|
||
|
|
<br>
|
||
|
|
<pre>public class <span class="strong">Tooltip</span>
|
||
|
|
extends java.lang.Object</pre>
|
||
|
|
<div class="block">A tooltip can be registered for individual controllers
|
||
|
|
and is activated on rollover.</div>
|
||
|
|
<dl><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 Tooltip
|
||
|
|
*
|
||
|
|
* add a tooltip to a controller.
|
||
|
|
* hover your mouse on top of a slider in the example and wait
|
||
|
|
* for 1 second for the tooltip to appear.
|
||
|
|
*
|
||
|
|
* find a list of public methods available for the Tooltip Controller
|
||
|
|
* at the bottom of this sketch.
|
||
|
|
*
|
||
|
|
* NOTE: currently does not work for custom PGraphics context
|
||
|
|
*
|
||
|
|
* by Andreas Schlegel, 2011
|
||
|
|
* www.sojamo.de/libraries/controlp5
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
|
||
|
|
import controlP5.*;
|
||
|
|
|
||
|
|
|
||
|
|
ControlP5 cp5;
|
||
|
|
|
||
|
|
float s1 = 20, s2 = 100;
|
||
|
|
|
||
|
|
void setup() {
|
||
|
|
size(700,400);
|
||
|
|
smooth();
|
||
|
|
noStroke();
|
||
|
|
cp5 = new ControlP5(this);
|
||
|
|
cp5.begin(100,100);
|
||
|
|
cp5.addSlider("s1",10,200).linebreak();
|
||
|
|
cp5.addSlider("s2",0,150);
|
||
|
|
cp5.end();
|
||
|
|
|
||
|
|
cp5.getTooltip().setDelay(500);
|
||
|
|
cp5.getTooltip().register("s1","Changes the size of the ellipse.");
|
||
|
|
cp5.getTooltip().register("s2","Changes the Background");
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
void keyPressed() {
|
||
|
|
println("unregistering the tooltip for s2");
|
||
|
|
cp5.getTooltip().unregister("s2");
|
||
|
|
}
|
||
|
|
void draw() {
|
||
|
|
background(s2);
|
||
|
|
fill(255,100);
|
||
|
|
ellipse(width/2, height/2, s1,s1);
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
/*
|
||
|
|
a list of all methods available for the Tooltip Controller
|
||
|
|
use ControlP5.printPublicMethodsFor(Tooltip.class);
|
||
|
|
to print the following list into the console.
|
||
|
|
|
||
|
|
You can find further details about class Tooltip in the javadoc.
|
||
|
|
|
||
|
|
Format:
|
||
|
|
ClassName : returnType methodName(parameter type)
|
||
|
|
|
||
|
|
|
||
|
|
controlP5.Tooltip : Label getLabel()
|
||
|
|
controlP5.Tooltip : Tooltip disable()
|
||
|
|
controlP5.Tooltip : Tooltip enable()
|
||
|
|
controlP5.Tooltip : Tooltip register(Controller, String)
|
||
|
|
controlP5.Tooltip : Tooltip register(String, String)
|
||
|
|
controlP5.Tooltip : Tooltip setAlpha(int)
|
||
|
|
controlP5.Tooltip : Tooltip setBorder(int)
|
||
|
|
controlP5.Tooltip : Tooltip setColorBackground(int)
|
||
|
|
controlP5.Tooltip : Tooltip setColorLabel(int)
|
||
|
|
controlP5.Tooltip : Tooltip setDelay(long)
|
||
|
|
controlP5.Tooltip : Tooltip setDisplay(ControllerDisplay)
|
||
|
|
controlP5.Tooltip : Tooltip setHeight(int)
|
||
|
|
controlP5.Tooltip : Tooltip setLabel(Label)
|
||
|
|
controlP5.Tooltip : Tooltip setPositionOffset(float, float)
|
||
|
|
controlP5.Tooltip : Tooltip setWidth(int)
|
||
|
|
controlP5.Tooltip : Tooltip unregister(Controller)
|
||
|
|
controlP5.Tooltip : Tooltip unregister(String)
|
||
|
|
controlP5.Tooltip : boolean isEnabled()
|
||
|
|
controlP5.Tooltip : int getBorder()
|
||
|
|
java.lang.Object : String toString()
|
||
|
|
java.lang.Object : boolean equals(Object)
|
||
|
|
|
||
|
|
*/
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</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"> </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/Tooltip.html" title="class in controlP5">Tooltip</a></code></td>
|
||
|
|
<td class="colLast"><code><strong><a href="../controlP5/Tooltip.html#disable()">disable</a></strong>()</code>
|
||
|
|
<div class="block">disables the Tooltip on a global level, when
|
||
|
|
disabled, tooltip will not respond to any registered
|
||
|
|
controller.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="rowColor">
|
||
|
|
<td class="colFirst"><code><a href="../controlP5/Tooltip.html" title="class in controlP5">Tooltip</a></code></td>
|
||
|
|
<td class="colLast"><code><strong><a href="../controlP5/Tooltip.html#enable()">enable</a></strong>()</code>
|
||
|
|
<div class="block">in case the tooltip is disabled, use enable() to turn
|
||
|
|
the tooltip back on.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="altColor">
|
||
|
|
<td class="colFirst"><code>int</code></td>
|
||
|
|
<td class="colLast"><code><strong><a href="../controlP5/Tooltip.html#getBorder()">getBorder</a></strong>()</code>
|
||
|
|
<div class="block">returns the value of the border</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="rowColor">
|
||
|
|
<td class="colFirst"><code><a href="../controlP5/Label.html" title="class in controlP5">Label</a></code></td>
|
||
|
|
<td class="colLast"><code><strong><a href="../controlP5/Tooltip.html#getLabel()">getLabel</a></strong>()</code>
|
||
|
|
<div class="block">returns the current Label</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="altColor">
|
||
|
|
<td class="colFirst"><code>int</code></td>
|
||
|
|
<td class="colLast"><code><strong><a href="../controlP5/Tooltip.html#getWidth()">getWidth</a></strong>()</code> </td>
|
||
|
|
</tr>
|
||
|
|
<tr class="rowColor">
|
||
|
|
<td class="colFirst"><code>boolean</code></td>
|
||
|
|
<td class="colLast"><code><strong><a href="../controlP5/Tooltip.html#isEnabled()">isEnabled</a></strong>()</code>
|
||
|
|
<div class="block">check if the tooltip is enabled or disabled</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="altColor">
|
||
|
|
<td class="colFirst"><code><a href="../controlP5/Tooltip.html" title="class in controlP5">Tooltip</a></code></td>
|
||
|
|
<td class="colLast"><code><strong><a href="../controlP5/Tooltip.html#register(controlP5.Controller, java.lang.String)">register</a></strong>(<a href="../controlP5/Controller.html" title="class in controlP5">Controller</a><?> theController,
|
||
|
|
java.lang.String theText)</code>
|
||
|
|
<div class="block">registers a controller with the Tooltip, when
|
||
|
|
activating the tooltip for a particular controller,
|
||
|
|
the registered text (second parameter) will be
|
||
|
|
displayed.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="rowColor">
|
||
|
|
<td class="colFirst"><code><a href="../controlP5/Tooltip.html" title="class in controlP5">Tooltip</a></code></td>
|
||
|
|
<td class="colLast"><code><strong><a href="../controlP5/Tooltip.html#register(java.lang.String, java.lang.String)">register</a></strong>(java.lang.String theControllerName,
|
||
|
|
java.lang.String theText)</code> </td>
|
||
|
|
</tr>
|
||
|
|
<tr class="altColor">
|
||
|
|
<td class="colFirst"><code><a href="../controlP5/Tooltip.html" title="class in controlP5">Tooltip</a></code></td>
|
||
|
|
<td class="colLast"><code><strong><a href="../controlP5/Tooltip.html#setAlpha(int)">setAlpha</a></strong>(int theValue)</code>
|
||
|
|
<div class="block">sets the transparency of the default background,
|
||
|
|
default value is 200</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="rowColor">
|
||
|
|
<td class="colFirst"><code><a href="../controlP5/Tooltip.html" title="class in controlP5">Tooltip</a></code></td>
|
||
|
|
<td class="colLast"><code><strong><a href="../controlP5/Tooltip.html#setBorder(int)">setBorder</a></strong>(int theValue)</code>
|
||
|
|
<div class="block">sets the border of the tooltip, the default border is
|
||
|
|
4px.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="altColor">
|
||
|
|
<td class="colFirst"><code><a href="../controlP5/Tooltip.html" title="class in controlP5">Tooltip</a></code></td>
|
||
|
|
<td class="colLast"><code><strong><a href="../controlP5/Tooltip.html#setColorBackground(int)">setColorBackground</a></strong>(int theColor)</code>
|
||
|
|
<div class="block">sets the background color of the tooltip, the default
|
||
|
|
color is a dark grey</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="rowColor">
|
||
|
|
<td class="colFirst"><code><a href="../controlP5/Tooltip.html" title="class in controlP5">Tooltip</a></code></td>
|
||
|
|
<td class="colLast"><code><strong><a href="../controlP5/Tooltip.html#setColorLabel(int)">setColorLabel</a></strong>(int theColor)</code>
|
||
|
|
<div class="block">sets the text color of the tooltip's label, the
|
||
|
|
default color is a white</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="altColor">
|
||
|
|
<td class="colFirst"><code><a href="../controlP5/Tooltip.html" title="class in controlP5">Tooltip</a></code></td>
|
||
|
|
<td class="colLast"><code><strong><a href="../controlP5/Tooltip.html#setDelay(long)">setDelay</a></strong>(long theMillis)</code>
|
||
|
|
<div class="block">A tooltip is activated when entered by the mouse,
|
||
|
|
after a given delay time the Tooltip starts to fade
|
||
|
|
in.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="rowColor">
|
||
|
|
<td class="colFirst"><code><a href="../controlP5/Tooltip.html" title="class in controlP5">Tooltip</a></code></td>
|
||
|
|
<td class="colLast"><code><strong><a href="../controlP5/Tooltip.html#setHeight(int)">setHeight</a></strong>(int theHeight)</code> </td>
|
||
|
|
</tr>
|
||
|
|
<tr class="altColor">
|
||
|
|
<td class="colFirst"><code><a href="../controlP5/Tooltip.html" title="class in controlP5">Tooltip</a></code></td>
|
||
|
|
<td class="colLast"><code><strong><a href="../controlP5/Tooltip.html#setLabel(controlP5.Label)">setLabel</a></strong>(<a href="../controlP5/Label.html" title="class in controlP5">Label</a> theLabel)</code>
|
||
|
|
<div class="block">sets the Label to a custom label and replaces the
|
||
|
|
default label.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="rowColor">
|
||
|
|
<td class="colFirst"><code><a href="../controlP5/Tooltip.html" title="class in controlP5">Tooltip</a></code></td>
|
||
|
|
<td class="colLast"><code><strong><a href="../controlP5/Tooltip.html#setPositionOffset(float, float)">setPositionOffset</a></strong>(float theX,
|
||
|
|
float theY)</code>
|
||
|
|
<div class="block">adds an offset to the position of the controller
|
||
|
|
relative to the mouse cursor's position.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="altColor">
|
||
|
|
<td class="colFirst"><code><a href="../controlP5/Tooltip.html" title="class in controlP5">Tooltip</a></code></td>
|
||
|
|
<td class="colLast"><code><strong><a href="../controlP5/Tooltip.html#setView(controlP5.ControllerView)">setView</a></strong>(<a href="../controlP5/ControllerView.html" title="interface in controlP5">ControllerView</a><?> theDisplay)</code>
|
||
|
|
<div class="block">A custom view can be set for a Tooltip.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="rowColor">
|
||
|
|
<td class="colFirst"><code><a href="../controlP5/Tooltip.html" title="class in controlP5">Tooltip</a></code></td>
|
||
|
|
<td class="colLast"><code><strong><a href="../controlP5/Tooltip.html#setWidth(int)">setWidth</a></strong>(int theWidth)</code>
|
||
|
|
<div class="block">with the default display, the width of the tooltip is
|
||
|
|
set automatically, therefore setWidth() does not have
|
||
|
|
any effect without changing the default display to a
|
||
|
|
custom ControllerView.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="altColor">
|
||
|
|
<td class="colFirst"><code><a href="../controlP5/Tooltip.html" title="class in controlP5">Tooltip</a></code></td>
|
||
|
|
<td class="colLast"><code><strong><a href="../controlP5/Tooltip.html#unregister(controlP5.Controller)">unregister</a></strong>(<a href="../controlP5/Controller.html" title="class in controlP5">Controller</a><?> theController)</code>
|
||
|
|
<div class="block">removes a controller from the tooltip</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="rowColor">
|
||
|
|
<td class="colFirst"><code><a href="../controlP5/Tooltip.html" title="class in controlP5">Tooltip</a></code></td>
|
||
|
|
<td class="colLast"><code><strong><a href="../controlP5/Tooltip.html#unregister(java.lang.String)">unregister</a></strong>(java.lang.String theControllerName)</code> </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, toString, 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="disable()">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>disable</h4>
|
||
|
|
<pre>public <a href="../controlP5/Tooltip.html" title="class in controlP5">Tooltip</a> disable()</pre>
|
||
|
|
<div class="block">disables the Tooltip on a global level, when
|
||
|
|
disabled, tooltip will not respond to any registered
|
||
|
|
controller. to disable a tooltip for aparticular
|
||
|
|
controller, used unregister(Controller)</div>
|
||
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>Tooltip</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../controlP5/Tooltip.html#unregister(controlP5.Controller)"><code>unregister(Controller)</code></a></dd></dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="enable()">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>enable</h4>
|
||
|
|
<pre>public <a href="../controlP5/Tooltip.html" title="class in controlP5">Tooltip</a> enable()</pre>
|
||
|
|
<div class="block">in case the tooltip is disabled, use enable() to turn
|
||
|
|
the tooltip back on.</div>
|
||
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>Tooltip</dd></dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="getBorder()">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>getBorder</h4>
|
||
|
|
<pre>public int getBorder()</pre>
|
||
|
|
<div class="block">returns the value of the border</div>
|
||
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd></dd></dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="getLabel()">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>getLabel</h4>
|
||
|
|
<pre>public <a href="../controlP5/Label.html" title="class in controlP5">Label</a> getLabel()</pre>
|
||
|
|
<div class="block">returns the current Label</div>
|
||
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>Label</dd></dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="getWidth()">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>getWidth</h4>
|
||
|
|
<pre>public int getWidth()</pre>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="isEnabled()">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>isEnabled</h4>
|
||
|
|
<pre>public boolean isEnabled()</pre>
|
||
|
|
<div class="block">check if the tooltip is enabled or disabled</div>
|
||
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>boolean</dd></dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="register(controlP5.Controller, java.lang.String)">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>register</h4>
|
||
|
|
<pre>public <a href="../controlP5/Tooltip.html" title="class in controlP5">Tooltip</a> register(<a href="../controlP5/Controller.html" title="class in controlP5">Controller</a><?> theController,
|
||
|
|
java.lang.String theText)</pre>
|
||
|
|
<div class="block">registers a controller with the Tooltip, when
|
||
|
|
activating the tooltip for a particular controller,
|
||
|
|
the registered text (second parameter) will be
|
||
|
|
displayed.</div>
|
||
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theController</code> - </dd><dd><code>theText</code> - </dd>
|
||
|
|
<dt><span class="strong">Returns:</span></dt><dd>Tooltip</dd></dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="register(java.lang.String, java.lang.String)">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>register</h4>
|
||
|
|
<pre>public <a href="../controlP5/Tooltip.html" title="class in controlP5">Tooltip</a> register(java.lang.String theControllerName,
|
||
|
|
java.lang.String theText)</pre>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="setAlpha(int)">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>setAlpha</h4>
|
||
|
|
<pre>public <a href="../controlP5/Tooltip.html" title="class in controlP5">Tooltip</a> setAlpha(int theValue)</pre>
|
||
|
|
<div class="block">sets the transparency of the default background,
|
||
|
|
default value is 200</div>
|
||
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theValue</code> - </dd>
|
||
|
|
<dt><span class="strong">Returns:</span></dt><dd>Tooltip</dd></dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="setBorder(int)">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>setBorder</h4>
|
||
|
|
<pre>public <a href="../controlP5/Tooltip.html" title="class in controlP5">Tooltip</a> setBorder(int theValue)</pre>
|
||
|
|
<div class="block">sets the border of the tooltip, the default border is
|
||
|
|
4px.</div>
|
||
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theValue</code> - </dd>
|
||
|
|
<dt><span class="strong">Returns:</span></dt><dd>Tooltip</dd></dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="setColorBackground(int)">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>setColorBackground</h4>
|
||
|
|
<pre>public <a href="../controlP5/Tooltip.html" title="class in controlP5">Tooltip</a> setColorBackground(int theColor)</pre>
|
||
|
|
<div class="block">sets the background color of the tooltip, the default
|
||
|
|
color is a dark grey</div>
|
||
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theColor</code> - </dd>
|
||
|
|
<dt><span class="strong">Returns:</span></dt><dd>Tooltip</dd></dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="setColorLabel(int)">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>setColorLabel</h4>
|
||
|
|
<pre>public <a href="../controlP5/Tooltip.html" title="class in controlP5">Tooltip</a> setColorLabel(int theColor)</pre>
|
||
|
|
<div class="block">sets the text color of the tooltip's label, the
|
||
|
|
default color is a white</div>
|
||
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theColor</code> - </dd>
|
||
|
|
<dt><span class="strong">Returns:</span></dt><dd>Tooltip</dd></dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="setDelay(long)">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>setDelay</h4>
|
||
|
|
<pre>public <a href="../controlP5/Tooltip.html" title="class in controlP5">Tooltip</a> setDelay(long theMillis)</pre>
|
||
|
|
<div class="block">A tooltip is activated when entered by the mouse,
|
||
|
|
after a given delay time the Tooltip starts to fade
|
||
|
|
in. Use setDelay(long) to adjust the default delay
|
||
|
|
time of 1000 millis.</div>
|
||
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theMillis</code> - </dd>
|
||
|
|
<dt><span class="strong">Returns:</span></dt><dd>Tooltip</dd></dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="setHeight(int)">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>setHeight</h4>
|
||
|
|
<pre>public <a href="../controlP5/Tooltip.html" title="class in controlP5">Tooltip</a> setHeight(int theHeight)</pre>
|
||
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theHeight</code> - </dd>
|
||
|
|
<dt><span class="strong">Returns:</span></dt><dd>Tooltip</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../controlP5/Tooltip.html#setWidth(int)"><code>setWidth(int)</code></a></dd></dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="setLabel(controlP5.Label)">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>setLabel</h4>
|
||
|
|
<pre>public <a href="../controlP5/Tooltip.html" title="class in controlP5">Tooltip</a> setLabel(<a href="../controlP5/Label.html" title="class in controlP5">Label</a> theLabel)</pre>
|
||
|
|
<div class="block">sets the Label to a custom label and replaces the
|
||
|
|
default label.</div>
|
||
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theLabel</code> - </dd>
|
||
|
|
<dt><span class="strong">Returns:</span></dt><dd>Tooltip</dd></dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="setPositionOffset(float, float)">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>setPositionOffset</h4>
|
||
|
|
<pre>public <a href="../controlP5/Tooltip.html" title="class in controlP5">Tooltip</a> setPositionOffset(float theX,
|
||
|
|
float theY)</pre>
|
||
|
|
<div class="block">adds an offset to the position of the controller
|
||
|
|
relative to the mouse cursor's position. default
|
||
|
|
offset is (10,20)</div>
|
||
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theX</code> - </dd><dd><code>theY</code> - </dd>
|
||
|
|
<dt><span class="strong">Returns:</span></dt><dd>Tooltip</dd></dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="setView(controlP5.ControllerView)">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>setView</h4>
|
||
|
|
<pre>public <a href="../controlP5/Tooltip.html" title="class in controlP5">Tooltip</a> setView(<a href="../controlP5/ControllerView.html" title="interface in controlP5">ControllerView</a><?> theDisplay)</pre>
|
||
|
|
<div class="block">A custom view can be set for a Tooltip. The default
|
||
|
|
view class can be found at the bottom of the Tooltip
|
||
|
|
source.</div>
|
||
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theDisplay</code> - </dd>
|
||
|
|
<dt><span class="strong">Returns:</span></dt><dd>Tooltip</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../controlP5/ControllerView.html" title="interface in controlP5"><code>ControllerView</code></a></dd></dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="setWidth(int)">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>setWidth</h4>
|
||
|
|
<pre>public <a href="../controlP5/Tooltip.html" title="class in controlP5">Tooltip</a> setWidth(int theWidth)</pre>
|
||
|
|
<div class="block">with the default display, the width of the tooltip is
|
||
|
|
set automatically, therefore setWidth() does not have
|
||
|
|
any effect without changing the default display to a
|
||
|
|
custom ControllerView.</div>
|
||
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>Tooltip</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../controlP5/ControllerView.html" title="interface in controlP5"><code>ControllerView</code></a>,
|
||
|
|
<code>controlP5.Tooltip#setDisplay(ControllerView)</code></dd></dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="unregister(controlP5.Controller)">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>unregister</h4>
|
||
|
|
<pre>public <a href="../controlP5/Tooltip.html" title="class in controlP5">Tooltip</a> unregister(<a href="../controlP5/Controller.html" title="class in controlP5">Controller</a><?> theController)</pre>
|
||
|
|
<div class="block">removes a controller from the tooltip</div>
|
||
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theController</code> - </dd>
|
||
|
|
<dt><span class="strong">Returns:</span></dt><dd>Tooltip</dd></dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="unregister(java.lang.String)">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockListLast">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>unregister</h4>
|
||
|
|
<pre>public <a href="../controlP5/Tooltip.html" title="class in controlP5">Tooltip</a> unregister(java.lang.String theControllerName)</pre>
|
||
|
|
</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/Toggle.html" title="class in controlP5"><span class="strong">Prev Class</span></a></li>
|
||
|
|
<li>Next Class</li>
|
||
|
|
</ul>
|
||
|
|
<ul class="navList">
|
||
|
|
<li><a href="../index.html?controlP5/Tooltip.html" target="_top">Frames</a></li>
|
||
|
|
<li><a href="Tooltip.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>
|