The future is now. Read Hardware inputs from devices plugged into a computer, cross-platform!
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
jinput2.10/docs/net/java/games/input/class-use/Component.html

425 lines
21 KiB

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.13) on Wed Jun 08 18:20:40 UTC 2022 -->
<title>Uses of Interface net.java.games.input.Component (jinput API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-06-08">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Uses of Interface net.java.games.input.Component (jinput API)";
}
}
catch(err) {
}
//-->
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../Component.html" title="interface in net.java.games.input">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="header">
<h2 title="Uses of Interface net.java.games.input.Component" class="title">Uses of Interface<br>net.java.games.input.Component</h2>
</div>
<div class="classUseContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary">
<caption><span>Packages that use <a href="../Component.html" title="interface in net.java.games.input">Component</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="#net.java.games.input">net.java.games.input</a></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<ul class="blockList">
<li class="blockList">
<section role="region"><a id="net.java.games.input">
<!-- -->
</a>
<h3>Uses of <a href="../Component.html" title="interface in net.java.games.input">Component</a> in <a href="../package-summary.html">net.java.games.input</a></h3>
<table class="useSummary">
<caption><span>Classes in <a href="../package-summary.html">net.java.games.input</a> that implement <a href="../Component.html" title="interface in net.java.games.input">Component</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../AbstractComponent.html" title="class in net.java.games.input">AbstractComponent</a></span></code></th>
<td class="colLast">
<div class="block">Skeleton implementation of a named axis.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../LinuxJoystickPOV.html" title="class in net.java.games.input">LinuxJoystickPOV</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../WinTabButtonComponent.html" title="class in net.java.games.input">WinTabButtonComponent</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../WinTabComponent.html" title="class in net.java.games.input">WinTabComponent</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../WinTabCursorComponent.html" title="class in net.java.games.input">WinTabCursorComponent</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
<table class="useSummary">
<caption><span>Methods in <a href="../package-summary.html">net.java.games.input</a> that return <a href="../Component.html" title="interface in net.java.games.input">Component</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../Component.html" title="interface in net.java.games.input">Component</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">Mouse.</span><code><span class="memberNameLink"><a href="../Mouse.html#getBack()">getBack</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the back mouse button, null if the mouse hasn't
got one.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../Component.html" title="interface in net.java.games.input">Component</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">Mouse.</span><code><span class="memberNameLink"><a href="../Mouse.html#getButton3()">getButton3</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns forth mouse button, null if the mouse hasn't
got one.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../Component.html" title="interface in net.java.games.input">Component</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">Mouse.</span><code><span class="memberNameLink"><a href="../Mouse.html#getButton4()">getButton4</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns fifth mouse button, null if the mouse hasn't
got one.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../Component.html" title="interface in net.java.games.input">Component</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">AbstractController.</span><code><span class="memberNameLink"><a href="../AbstractController.html#getComponent(net.java.games.input.Component.Identifier)">getComponent</a></span>&#8203;(<a href="../Component.Identifier.html" title="class in net.java.games.input">Component.Identifier</a>&nbsp;id)</code></th>
<td class="colLast">
<div class="block">Returns a single component based on its identifier, or null
if no component with the specified type could be found.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../Component.html" title="interface in net.java.games.input">Component</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">Controller.</span><code><span class="memberNameLink"><a href="../Controller.html#getComponent(net.java.games.input.Component.Identifier)">getComponent</a></span>&#8203;(<a href="../Component.Identifier.html" title="class in net.java.games.input">Component.Identifier</a>&nbsp;id)</code></th>
<td class="colLast">
<div class="block">Returns a single axis based on its type, or null
if no axis with the specified type could be found.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../Component.html" title="interface in net.java.games.input">Component</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">Event.</span><code><span class="memberNameLink"><a href="../Event.html#getComponent()">getComponent</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../Component.html" title="interface in net.java.games.input">Component</a>[]</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">AbstractController.</span><code><span class="memberNameLink"><a href="../AbstractController.html#getComponents()">getComponents</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the components on this controller, in order of assignment priority.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../Component.html" title="interface in net.java.games.input">Component</a>[]</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">Controller.</span><code><span class="memberNameLink"><a href="../Controller.html#getComponents()">getComponents</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the components on this controller, in order of assignment priority.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../Component.html" title="interface in net.java.games.input">Component</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">Mouse.</span><code><span class="memberNameLink"><a href="../Mouse.html#getExtra()">getExtra</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the extra or 5th mouse button, null if the mouse has
fewer than 5 buttons.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../Component.html" title="interface in net.java.games.input">Component</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">Mouse.</span><code><span class="memberNameLink"><a href="../Mouse.html#getForward()">getForward</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the forward mouse button, null if the mouse hasn't
got one.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../Component.html" title="interface in net.java.games.input">Component</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">Mouse.</span><code><span class="memberNameLink"><a href="../Mouse.html#getLeft()">getLeft</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the left mouse button.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../Component.html" title="interface in net.java.games.input">Component</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">Mouse.</span><code><span class="memberNameLink"><a href="../Mouse.html#getMiddle()">getMiddle</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the middle, null if the mouse has fewer than three buttons.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../Component.html" title="interface in net.java.games.input">Component</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">Mouse.</span><code><span class="memberNameLink"><a href="../Mouse.html#getPrimaryButton()">getPrimaryButton</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the left or primary mouse button, never null.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../Component.html" title="interface in net.java.games.input">Component</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">Mouse.</span><code><span class="memberNameLink"><a href="../Mouse.html#getRight()">getRight</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the right, null if the mouse is a single-button mouse.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../Component.html" title="interface in net.java.games.input">Component</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">Mouse.</span><code><span class="memberNameLink"><a href="../Mouse.html#getSecondaryButton()">getSecondaryButton</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the right or secondary mouse button, null if the mouse is
a single-button mouse.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../Component.html" title="interface in net.java.games.input">Component</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">Mouse.</span><code><span class="memberNameLink"><a href="../Mouse.html#getSide()">getSide</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the side or 4th mouse button, null if the mouse has
fewer than 4 buttons.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../Component.html" title="interface in net.java.games.input">Component</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">Mouse.</span><code><span class="memberNameLink"><a href="../Mouse.html#getTertiaryButton()">getTertiaryButton</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the middle or tertiary mouse button, null if the mouse has
fewer than three buttons.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../Component.html" title="interface in net.java.games.input">Component</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">Mouse.</span><code><span class="memberNameLink"><a href="../Mouse.html#getWheel()">getWheel</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the mouse wheel, or null if no mouse wheel is present.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../Component.html" title="interface in net.java.games.input">Component</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">Mouse.</span><code><span class="memberNameLink"><a href="../Mouse.html#getX()">getX</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the x-axis for the mouse ball, never null.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../Component.html" title="interface in net.java.games.input">Component</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">Mouse.</span><code><span class="memberNameLink"><a href="../Mouse.html#getY()">getY</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the y-axis for the mouse ball, never null.</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary">
<caption><span>Methods in <a href="../package-summary.html">net.java.games.input</a> with parameters of type <a href="../Component.html" title="interface in net.java.games.input">Component</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">Event.</span><code><span class="memberNameLink"><a href="../Event.html#set(net.java.games.input.Component,float,long)">set</a></span>&#8203;(<a href="../Component.html" title="interface in net.java.games.input">Component</a>&nbsp;component,
float&nbsp;value,
long&nbsp;nanos)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
<table class="useSummary">
<caption><span>Constructors in <a href="../package-summary.html">net.java.games.input</a> with parameters of type <a href="../Component.html" title="interface in net.java.games.input">Component</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../AbstractController.html#%3Cinit%3E(java.lang.String,net.java.games.input.Component%5B%5D,net.java.games.input.Controller%5B%5D,net.java.games.input.Rumbler%5B%5D)">AbstractController</a></span>&#8203;(java.lang.String&nbsp;name,
<a href="../Component.html" title="interface in net.java.games.input">Component</a>[]&nbsp;components,
<a href="../Controller.html" title="interface in net.java.games.input">Controller</a>[]&nbsp;children,
<a href="../Rumbler.html" title="interface in net.java.games.input">Rumbler</a>[]&nbsp;rumblers)</code></th>
<td class="colLast">
<div class="block">Protected constructor for a controller containing the specified
axes, child controllers, and rumblers</div>
</td>
</tr>
<tr class="rowColor">
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../Keyboard.html#%3Cinit%3E(java.lang.String,net.java.games.input.Component%5B%5D,net.java.games.input.Controller%5B%5D,net.java.games.input.Rumbler%5B%5D)">Keyboard</a></span>&#8203;(java.lang.String&nbsp;name,
<a href="../Component.html" title="interface in net.java.games.input">Component</a>[]&nbsp;keys,
<a href="../Controller.html" title="interface in net.java.games.input">Controller</a>[]&nbsp;children,
<a href="../Rumbler.html" title="interface in net.java.games.input">Rumbler</a>[]&nbsp;rumblers)</code></th>
<td class="colLast">
<div class="block">Protected constructor.</div>
</td>
</tr>
<tr class="altColor">
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../Mouse.html#%3Cinit%3E(java.lang.String,net.java.games.input.Component%5B%5D,net.java.games.input.Controller%5B%5D,net.java.games.input.Rumbler%5B%5D)">Mouse</a></span>&#8203;(java.lang.String&nbsp;name,
<a href="../Component.html" title="interface in net.java.games.input">Component</a>[]&nbsp;components,
<a href="../Controller.html" title="interface in net.java.games.input">Controller</a>[]&nbsp;children,
<a href="../Rumbler.html" title="interface in net.java.games.input">Rumbler</a>[]&nbsp;rumblers)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</section>
</li>
</ul>
</li>
</ul>
</div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../Component.html" title="interface in net.java.games.input">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>