mirror of
https://github.com/AtlasMediaGroup/Scissors-Website.git
synced 2024-09-18 21:28:15 +00:00
223 lines
21 KiB
HTML
223 lines
21 KiB
HTML
|
<!DOCTYPE HTML>
|
||
|
<html lang="en">
|
||
|
<head>
|
||
|
<!-- Generated by javadoc (17) -->
|
||
|
<title>AsyncTabCompleteEvent.Completion (Scissors-API 1.18.2-R0.1-SNAPSHOT API)</title>
|
||
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
|
<meta name="description" content="declaration: package: com.destroystokyo.paper.event.server, class: AsyncTabCompleteEvent, interface: Completion">
|
||
|
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||
|
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
|
||
|
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
|
||
|
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
|
||
|
<script type="text/javascript" src="../../../../../script.js"></script>
|
||
|
<script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script>
|
||
|
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
|
||
|
</head>
|
||
|
<body class="class-declaration-page">
|
||
|
<script type="text/javascript">var evenRowColor = "even-row-color";
|
||
|
var oddRowColor = "odd-row-color";
|
||
|
var tableTab = "table-tab";
|
||
|
var activeTableTab = "active-table-tab";
|
||
|
var pathtoroot = "../../../../../";
|
||
|
loadScripts(document, 'script');</script>
|
||
|
<noscript>
|
||
|
<div>JavaScript is disabled on your browser.</div>
|
||
|
</noscript>
|
||
|
<div class="flex-box">
|
||
|
<header role="banner" class="flex-header">
|
||
|
<nav role="navigation">
|
||
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
||
|
<div class="top-nav" id="navbar-top">
|
||
|
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||
|
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||
|
<li><a href="../../../../../index.html">Overview</a></li>
|
||
|
<li><a href="package-summary.html">Package</a></li>
|
||
|
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
<div class="sub-nav">
|
||
|
<div>
|
||
|
<ul class="sub-nav-list">
|
||
|
<li>Summary: </li>
|
||
|
<li>Nested | </li>
|
||
|
<li>Field | </li>
|
||
|
<li>Constr | </li>
|
||
|
<li><a href="#method-summary">Method</a></li>
|
||
|
</ul>
|
||
|
<ul class="sub-nav-list">
|
||
|
<li>Detail: </li>
|
||
|
<li>Field | </li>
|
||
|
<li>Constr | </li>
|
||
|
<li><a href="#method-detail">Method</a></li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||
|
<input type="text" id="search-input" value="search" disabled="disabled">
|
||
|
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||
|
</div>
|
||
|
</div>
|
||
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
||
|
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||
|
</header>
|
||
|
<div class="flex-content">
|
||
|
<main role="main">
|
||
|
<!-- ======== START OF CLASS DATA ======== -->
|
||
|
<div class="header">
|
||
|
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.destroystokyo.paper.event.server</a></div>
|
||
|
<h1 title="Interface AsyncTabCompleteEvent.Completion" class="title">Interface AsyncTabCompleteEvent.Completion</h1>
|
||
|
</div>
|
||
|
<section class="class-description" id="class-description">
|
||
|
<dl class="notes">
|
||
|
<dt>All Superinterfaces:</dt>
|
||
|
<dd><code>net.kyori.examination.Examinable</code></dd>
|
||
|
</dl>
|
||
|
<dl class="notes">
|
||
|
<dt>Enclosing class:</dt>
|
||
|
<dd><a href="AsyncTabCompleteEvent.html" title="class in com.destroystokyo.paper.event.server">AsyncTabCompleteEvent</a></dd>
|
||
|
</dl>
|
||
|
<hr>
|
||
|
<div class="type-signature"><span class="modifiers">public static interface </span><span class="element-name type-name-label">AsyncTabCompleteEvent.Completion</span><span class="extends-implements">
|
||
|
extends net.kyori.examination.Examinable</span></div>
|
||
|
<div class="block">A rich tab completion, consisting of a string suggestion, and a nullable <a href="https://jd.adventure.kyori.net/api/4.11.0/net/kyori/adventure/text/Component.html" title="class or interface in net.kyori.adventure.text" class="external-link"><code>Component</code></a> tooltip.</div>
|
||
|
</section>
|
||
|
<section class="summary">
|
||
|
<ul class="summary-list">
|
||
|
<!-- ========== METHOD SUMMARY =========== -->
|
||
|
<li>
|
||
|
<section class="method-summary" id="method-summary">
|
||
|
<h2>Method Summary</h2>
|
||
|
<div id="method-summary-table">
|
||
|
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div>
|
||
|
<div id="method-summary-table.tabpanel" role="tabpanel">
|
||
|
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
||
|
<div class="table-header col-first">Modifier and Type</div>
|
||
|
<div class="table-header col-second">Method</div>
|
||
|
<div class="table-header col-last">Description</div>
|
||
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static <a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="AsyncTabCompleteEvent.Completion.html" title="interface in com.destroystokyo.paper.event.server">AsyncTabCompleteEvent.Completion</a></code></div>
|
||
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#completion(java.lang.String)" class="member-name-link">completion</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> suggestion)</code></div>
|
||
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab1">
|
||
|
<div class="block">Create a new <a href="AsyncTabCompleteEvent.Completion.html" title="interface in com.destroystokyo.paper.event.server"><code>AsyncTabCompleteEvent.Completion</code></a> from a suggestion string.</div>
|
||
|
</div>
|
||
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static <a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="AsyncTabCompleteEvent.Completion.html" title="interface in com.destroystokyo.paper.event.server">AsyncTabCompleteEvent.Completion</a></code></div>
|
||
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1"><code><a href="#completion(java.lang.String,net.kyori.adventure.text.Component)" class="member-name-link">completion</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> suggestion,
|
||
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://jd.adventure.kyori.net/api/4.11.0/net/kyori/adventure/text/Component.html" title="class or interface in net.kyori.adventure.text" class="external-link">Component</a> tooltip)</code></div>
|
||
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1">
|
||
|
<div class="block">Create a new <a href="AsyncTabCompleteEvent.Completion.html" title="interface in com.destroystokyo.paper.event.server"><code>AsyncTabCompleteEvent.Completion</code></a> from a suggestion string and a tooltip <a href="https://jd.adventure.kyori.net/api/4.11.0/net/kyori/adventure/text/Component.html" title="class or interface in net.kyori.adventure.text" class="external-link"><code>Component</code></a>.</div>
|
||
|
</div>
|
||
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/stream/Stream.html" title="class or interface in java.util.stream" class="external-link">Stream</a><? extends net.kyori.examination.ExaminableProperty></code></div>
|
||
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#examinableProperties()" class="member-name-link">examinableProperties</a>()</code></div>
|
||
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> </div>
|
||
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#suggestion()" class="member-name-link">suggestion</a>()</code></div>
|
||
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||
|
<div class="block">Get the suggestion string for this <a href="AsyncTabCompleteEvent.Completion.html" title="interface in com.destroystokyo.paper.event.server"><code>AsyncTabCompleteEvent.Completion</code></a>.</div>
|
||
|
</div>
|
||
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://jd.adventure.kyori.net/api/4.11.0/net/kyori/adventure/text/Component.html" title="class or interface in net.kyori.adventure.text" class="external-link">Component</a></code></div>
|
||
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#tooltip()" class="member-name-link">tooltip</a>()</code></div>
|
||
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||
|
<div class="block">Get the suggestion tooltip for this <a href="AsyncTabCompleteEvent.Completion.html" title="interface in com.destroystokyo.paper.event.server"><code>AsyncTabCompleteEvent.Completion</code></a>.</div>
|
||
|
</div>
|
||
|
</div>
|
||
|
</div>
|
||
|
</div>
|
||
|
<div class="inherited-list">
|
||
|
<h3 id="methods-inherited-from-class-net.kyori.examination.Examinable">Methods inherited from interface net.kyori.examination.Examinable</h3>
|
||
|
<code>examinableName, examine</code></div>
|
||
|
</section>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</section>
|
||
|
<section class="details">
|
||
|
<ul class="details-list">
|
||
|
<!-- ============ METHOD DETAIL ========== -->
|
||
|
<li>
|
||
|
<section class="method-details" id="method-detail">
|
||
|
<h2>Method Details</h2>
|
||
|
<ul class="member-list">
|
||
|
<li>
|
||
|
<section class="detail" id="suggestion()">
|
||
|
<h3>suggestion</h3>
|
||
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">suggestion</span>()</div>
|
||
|
<div class="block">Get the suggestion string for this <a href="AsyncTabCompleteEvent.Completion.html" title="interface in com.destroystokyo.paper.event.server"><code>AsyncTabCompleteEvent.Completion</code></a>.</div>
|
||
|
<dl class="notes">
|
||
|
<dt>Returns:</dt>
|
||
|
<dd>suggestion string</dd>
|
||
|
</dl>
|
||
|
</section>
|
||
|
</li>
|
||
|
<li>
|
||
|
<section class="detail" id="tooltip()">
|
||
|
<h3>tooltip</h3>
|
||
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
||
|
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://jd.adventure.kyori.net/api/4.11.0/net/kyori/adventure/text/Component.html" title="class or interface in net.kyori.adventure.text" class="external-link">Component</a></span> <span class="element-name">tooltip</span>()</div>
|
||
|
<div class="block">Get the suggestion tooltip for this <a href="AsyncTabCompleteEvent.Completion.html" title="interface in com.destroystokyo.paper.event.server"><code>AsyncTabCompleteEvent.Completion</code></a>.</div>
|
||
|
<dl class="notes">
|
||
|
<dt>Returns:</dt>
|
||
|
<dd>tooltip component</dd>
|
||
|
</dl>
|
||
|
</section>
|
||
|
</li>
|
||
|
<li>
|
||
|
<section class="detail" id="examinableProperties()">
|
||
|
<h3>examinableProperties</h3>
|
||
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
</span><span class="modifiers">default</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/stream/Stream.html" title="class or interface in java.util.stream" class="external-link">Stream</a><? extends net.kyori.examination.ExaminableProperty></span> <span class="element-name">examinableProperties</span>()</div>
|
||
|
<dl class="notes">
|
||
|
<dt>Specified by:</dt>
|
||
|
<dd><code>examinableProperties</code> in interface <code>net.kyori.examination.Examinable</code></dd>
|
||
|
</dl>
|
||
|
</section>
|
||
|
</li>
|
||
|
<li>
|
||
|
<section class="detail" id="completion(java.lang.String)">
|
||
|
<h3>completion</h3>
|
||
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
</span><span class="modifiers">static</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="AsyncTabCompleteEvent.Completion.html" title="interface in com.destroystokyo.paper.event.server">AsyncTabCompleteEvent.Completion</a></span> <span class="element-name">completion</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> suggestion)</span></div>
|
||
|
<div class="block">Create a new <a href="AsyncTabCompleteEvent.Completion.html" title="interface in com.destroystokyo.paper.event.server"><code>AsyncTabCompleteEvent.Completion</code></a> from a suggestion string.</div>
|
||
|
<dl class="notes">
|
||
|
<dt>Parameters:</dt>
|
||
|
<dd><code>suggestion</code> - suggestion string</dd>
|
||
|
<dt>Returns:</dt>
|
||
|
<dd>new completion instance</dd>
|
||
|
</dl>
|
||
|
</section>
|
||
|
</li>
|
||
|
<li>
|
||
|
<section class="detail" id="completion(java.lang.String,net.kyori.adventure.text.Component)">
|
||
|
<h3>completion</h3>
|
||
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
</span><span class="modifiers">static</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="AsyncTabCompleteEvent.Completion.html" title="interface in com.destroystokyo.paper.event.server">AsyncTabCompleteEvent.Completion</a></span> <span class="element-name">completion</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> suggestion,
|
||
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
||
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://jd.adventure.kyori.net/api/4.11.0/net/kyori/adventure/text/Component.html" title="class or interface in net.kyori.adventure.text" class="external-link">Component</a> tooltip)</span></div>
|
||
|
<div class="block">Create a new <a href="AsyncTabCompleteEvent.Completion.html" title="interface in com.destroystokyo.paper.event.server"><code>AsyncTabCompleteEvent.Completion</code></a> from a suggestion string and a tooltip <a href="https://jd.adventure.kyori.net/api/4.11.0/net/kyori/adventure/text/Component.html" title="class or interface in net.kyori.adventure.text" class="external-link"><code>Component</code></a>.
|
||
|
|
||
|
<p>If the provided component is null, the suggestion will not have a tooltip.</p></div>
|
||
|
<dl class="notes">
|
||
|
<dt>Parameters:</dt>
|
||
|
<dd><code>suggestion</code> - suggestion string</dd>
|
||
|
<dd><code>tooltip</code> - tooltip component, or null</dd>
|
||
|
<dt>Returns:</dt>
|
||
|
<dd>new completion instance</dd>
|
||
|
</dl>
|
||
|
</section>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</section>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</section>
|
||
|
<!-- ========= END OF CLASS DATA ========= -->
|
||
|
</main>
|
||
|
</div>
|
||
|
</div>
|
||
|
</body>
|
||
|
</html>
|