Website/static/javadoc/dev/plex/menu/AbstractMenu.html

399 lines
28 KiB
HTML

<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (21) -->
<title>AbstractMenu (server 1.5-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: dev.plex.menu, class: AbstractMenu">
<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">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-3.6.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 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">
<button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false"
aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span
class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span>
</button>
<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>
<ul class="sub-nav-list-small">
<li>
<p>Summary:</p>
<ul>
<li><a href="#nested-class-summary">Nested</a></li>
<li><a href="#field-summary">Field</a></li>
<li><a href="#constructor-summary">Constr</a></li>
<li><a href="#method-summary">Method</a></li>
</ul>
</li>
<li>
<p>Detail:</p>
<ul>
<li><a href="#field-detail">Field</a></li>
<li><a href="#constructor-detail">Constr</a></li>
<li><a href="#method-detail">Method</a></li>
</ul>
</li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list">
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><a href="../../../search.html">SEARCH</a>
<input type="text" id="search-input" disabled placeholder="Search">
<input type="reset" id="reset-button" disabled value="reset">
</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>&nbsp;<a
href="package-summary.html">dev.plex.menu</a></div>
<h1 title="Class AbstractMenu" class="title">Class AbstractMenu</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"
title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">dev.plex.menu.AbstractMenu</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="pagination/PageableMenu.Page.html" title="class in dev.plex.menu.pagination">PageableMenu.Page</a></code>,
<code><a href="impl/ToggleMenu.html" title="class in dev.plex.menu.impl">ToggleMenu</a></code>
</dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public abstract class </span><span
class="element-name type-name-label">AbstractMenu</span>
<span class="extends-implements">extends <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"
title="class or interface in java.lang" class="external-link">Object</a></span></div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="caption"><span>Nested Classes</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static enum&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="AbstractMenu.Rows.html"
class="type-name-link"
title="enum class in dev.plex.menu">AbstractMenu.Rows</a></code>
</div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static final <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Map.html"
title="class or interface in java.util" class="external-link">Map</a>
<wbr>&lt;net.kyori.adventure.text.Component,
<wbr>
<a href="AbstractMenu.html"
title="class in dev.plex.menu">AbstractMenu</a>&gt;</code></div>
<div class="col-second even-row-color"><code><a href="#INVENTORIES"
class="member-name-link">INVENTORIES</a></code>
</div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>private final
org.bukkit.inventory.Inventory</code></div>
<div class="col-second odd-row-color"><code><a href="#inventory"
class="member-name-link">inventory</a></code>
</div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>private final
net.kyori.adventure.text.Component</code></div>
<div class="col-second even-row-color"><code><a href="#name" class="member-name-link">name</a></code>
</div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a
href="#%3Cinit%3E(java.lang.String,dev.plex.menu.AbstractMenu.Rows)"
class="member-name-link">AbstractMenu</a>
<wbr>
(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="AbstractMenu.Rows.html" title="enum class in dev.plex.menu">AbstractMenu.Rows</a>&nbsp;rows)</code>
</div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-constructor-name odd-row-color"><code><a
href="#%3Cinit%3E(net.kyori.adventure.text.Component,dev.plex.menu.AbstractMenu.Rows)"
class="member-name-link">AbstractMenu</a>
<wbr>
(net.kyori.adventure.text.Component&nbsp;name,
<a href="AbstractMenu.Rows.html" title="enum class in dev.plex.menu">AbstractMenu.Rows</a>&nbsp;rows)</code>
</div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== 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-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-tab4" role="tab" aria-selected="false"
aria-controls="method-summary-table.tabpanel" tabindex="-1"
onkeydown="switchTab(event)"
onclick="show('method-summary-table', 'method-summary-table-tab4', 3)"
class="table-tab">Concrete Methods
</button>
</div>
<div id="method-summary-table.tabpanel" role="tabpanel"
aria-labelledby="method-summary-table-tab0">
<div class="summary-table three-column-summary">
<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-tab2 method-summary-table-tab3">
<code>abstract boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<code><a
href="#onClick(org.bukkit.inventory.InventoryView,org.bukkit.inventory.Inventory,org.bukkit.entity.Player,org.bukkit.inventory.ItemStack)"
class="member-name-link">onClick</a>
<wbr>
(org.bukkit.inventory.InventoryView&nbsp;view,
org.bukkit.inventory.Inventory&nbsp;inventory,
org.bukkit.entity.Player&nbsp;player,
org.bukkit.inventory.ItemStack&nbsp;clicked)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
&nbsp;
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code><a href="#open(org.bukkit.entity.Player)" class="member-name-link">open</a>
<wbr>
(org.bukkit.entity.Player&nbsp;player)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
&nbsp;
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"
title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#clone()"
title="class or interface in java.lang" class="external-link">clone</a>, <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)"
title="class or interface in java.lang" class="external-link">equals</a>, <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#finalize()"
title="class or interface in java.lang" class="external-link">finalize</a>, <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#getClass()"
title="class or interface in java.lang" class="external-link">getClass</a>, <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#hashCode()"
title="class or interface in java.lang" class="external-link">hashCode</a>, <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#notify()"
title="class or interface in java.lang" class="external-link">notify</a>, <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#notifyAll()"
title="class or interface in java.lang" class="external-link">notifyAll</a>, <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#toString()"
title="class or interface in java.lang" class="external-link">toString</a>, <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait()"
title="class or interface in java.lang" class="external-link">wait</a>, <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long)"
title="class or interface in java.lang" class="external-link">wait</a>, <a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long,int)"
title="class or interface in java.lang" class="external-link">wait</a></code>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="INVENTORIES">
<h3>INVENTORIES</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span
class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Map.html"
title="class or interface in java.util" class="external-link">Map</a>&lt;net.kyori.adventure.text.Component,<wbr><a
href="AbstractMenu.html" title="class in dev.plex.menu">AbstractMenu</a>&gt;</span>&nbsp;<span
class="element-name">INVENTORIES</span></div>
</section>
</li>
<li>
<section class="detail" id="name">
<h3>name</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span
class="return-type">net.kyori.adventure.text.Component</span>&nbsp;<span
class="element-name">name</span></div>
</section>
</li>
<li>
<section class="detail" id="inventory">
<h3>inventory</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span
class="return-type">org.bukkit.inventory.Inventory</span>&nbsp;<span
class="element-name">inventory</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail"
id="&lt;init&gt;(net.kyori.adventure.text.Component,dev.plex.menu.AbstractMenu.Rows)">
<h3>AbstractMenu</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span
class="element-name">AbstractMenu</span>
<wbr>
<span class="parameters">(net.kyori.adventure.text.Component&nbsp;name,
<a href="AbstractMenu.Rows.html" title="enum class in dev.plex.menu">AbstractMenu.Rows</a>&nbsp;rows)</span></div>
</section>
</li>
<li>
<section class="detail"
id="&lt;init&gt;(java.lang.String,dev.plex.menu.AbstractMenu.Rows)">
<h3>AbstractMenu</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span
class="element-name">AbstractMenu</span>
<wbr>
<span class="parameters">(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a>&nbsp;name,
<a href="AbstractMenu.Rows.html" title="enum class in dev.plex.menu">AbstractMenu.Rows</a>&nbsp;rows)</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail"
id="onClick(org.bukkit.inventory.InventoryView,org.bukkit.inventory.Inventory,org.bukkit.entity.Player,org.bukkit.inventory.ItemStack)">
<h3>onClick</h3>
<div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span
class="return-type">boolean</span>&nbsp;<span class="element-name">onClick</span>
<wbr>
<span class="parameters">(org.bukkit.inventory.InventoryView&nbsp;view,
org.bukkit.inventory.Inventory&nbsp;inventory,
org.bukkit.entity.Player&nbsp;player,
org.bukkit.inventory.ItemStack&nbsp;clicked)</span></div>
</section>
</li>
<li>
<section class="detail" id="open(org.bukkit.entity.Player)">
<h3>open</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span
class="return-type">void</span>&nbsp;<span
class="element-name">open</span>
<wbr>
<span class="parameters">(org.bukkit.entity.Player&nbsp;player)</span></div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>