diff options
| author | Foghrye4 <foghrye4@gmail.com> | 2017-06-17 08:12:18 +0300 |
|---|---|---|
| committer | Foghrye4 <foghrye4@gmail.com> | 2017-06-17 08:12:18 +0300 |
| commit | dc3df3edd5843bde0c1335d6a8e460b2c832aa48 (patch) | |
| tree | af13bfeee567f2351e35e1ef176d168fe37c8aac /javadoc/cpw/mods/fml/client/config/HoverChecker.html | |
| parent | 1da8dcd58647e34c9af94ceeecaeaf3b0d08c48c (diff) | |
full project files
Diffstat (limited to 'javadoc/cpw/mods/fml/client/config/HoverChecker.html')
| -rw-r--r-- | javadoc/cpw/mods/fml/client/config/HoverChecker.html | 344 |
1 files changed, 344 insertions, 0 deletions
diff --git a/javadoc/cpw/mods/fml/client/config/HoverChecker.html b/javadoc/cpw/mods/fml/client/config/HoverChecker.html new file mode 100644 index 0000000..a36ced1 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/HoverChecker.html @@ -0,0 +1,344 @@ +<!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_65) on Thu Feb 05 20:10:11 EST 2015 --> +<title>HoverChecker (Forge API)</title> +<meta name="date" content="2015-02-05"> +<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="HoverChecker (Forge API)"; + } +//--> +</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="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</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="../../../../../cpw/mods/fml/client/config/GuiUtils.html" title="class in cpw.mods.fml.client.config"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?cpw/mods/fml/client/config/HoverChecker.html" target="_top">Frames</a></li> +<li><a href="HoverChecker.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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">cpw.mods.fml.client.config</div> +<h2 title="Class HoverChecker" class="title">Class HoverChecker</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>cpw.mods.fml.client.config.HoverChecker</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">HoverChecker</span> +extends java.lang.Object</pre> +<div class="block">This class implements an easy way to check if the mouse has hovered within a certain region of the screen for a given + period of time. The region can be defined manually or by supplying a GuiButton object.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../cpw/mods/fml/client/config/HoverChecker.html#HoverChecker(net.minecraft.client.gui.GuiButton,%20int)">HoverChecker</a></strong>(<a href="../../../../../net/minecraft/client/gui/GuiButton.html" title="class in net.minecraft.client.gui">GuiButton</a> button, + int threshold)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../cpw/mods/fml/client/config/HoverChecker.html#HoverChecker(int,%20int,%20int,%20int,%20int)">HoverChecker</a></strong>(int top, + int bottom, + int left, + int right, + int threshold)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../cpw/mods/fml/client/config/HoverChecker.html#checkHover(int,%20int)">checkHover</a></strong>(int mouseX, + int mouseY)</code> +<div class="block">Checks if the mouse is in the hover region.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../cpw/mods/fml/client/config/HoverChecker.html#checkHover(int,%20int,%20boolean)">checkHover</a></strong>(int mouseX, + int mouseY, + boolean canHover)</code> +<div class="block">Checks if the mouse is in the hover region.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../cpw/mods/fml/client/config/HoverChecker.html#resetHoverTimer()">resetHoverTimer</a></strong>()</code> +<div class="block">Manually resets the hover timer.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../cpw/mods/fml/client/config/HoverChecker.html#updateBounds(int,%20int,%20int,%20int)">updateBounds</a></strong>(int top, + int bottom, + int left, + int right)</code> +<div class="block">Call this method if the intended region has changed such as if the region must follow a scrolling list.</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>clone, equals, finalize, 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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="HoverChecker(int, int, int, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>HoverChecker</h4> +<pre>public HoverChecker(int top, + int bottom, + int left, + int right, + int threshold)</pre> +</li> +</ul> +<a name="HoverChecker(net.minecraft.client.gui.GuiButton, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>HoverChecker</h4> +<pre>public HoverChecker(<a href="../../../../../net/minecraft/client/gui/GuiButton.html" title="class in net.minecraft.client.gui">GuiButton</a> button, + int threshold)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="updateBounds(int, int, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>updateBounds</h4> +<pre>public void updateBounds(int top, + int bottom, + int left, + int right)</pre> +<div class="block">Call this method if the intended region has changed such as if the region must follow a scrolling list. + It is not necessary to call this method if a GuiButton defines the hover region.</div> +</li> +</ul> +<a name="checkHover(int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>checkHover</h4> +<pre>public boolean checkHover(int mouseX, + int mouseY)</pre> +<div class="block">Checks if the mouse is in the hover region. If the specified time period has elapsed the method returns true. + The hover timer is reset if the mouse is not within the region.</div> +</li> +</ul> +<a name="checkHover(int, int, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>checkHover</h4> +<pre>public boolean checkHover(int mouseX, + int mouseY, + boolean canHover)</pre> +<div class="block">Checks if the mouse is in the hover region. If the specified time period has elapsed the method returns true. + The hover timer is reset if the mouse is not within the region.</div> +</li> +</ul> +<a name="resetHoverTimer()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>resetHoverTimer</h4> +<pre>public void resetHoverTimer()</pre> +<div class="block">Manually resets the hover timer.</div> +</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="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</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="../../../../../cpw/mods/fml/client/config/GuiUtils.html" title="class in cpw.mods.fml.client.config"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?cpw/mods/fml/client/config/HoverChecker.html" target="_top">Frames</a></li> +<li><a href="HoverChecker.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> |