Plan/all/com/djrapitops/plan/extension/table/Table.Factory.html

272 lines
20 KiB
HTML
Raw Normal View History

<!DOCTYPE HTML>
2019-08-05 11:13:19 +02:00
<!-- NewPage -->
<html lang="en">
2019-08-05 11:13:19 +02:00
<head>
<!-- Generated by javadoc (16) -->
<title>Table.Factory (Plan 5.4-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.djrapitops.plan.extension.table, class: Table, class: Factory">
<meta name="generator" content="javadoc/ClassWriterImpl">
2019-08-05 11:13:19 +02:00
<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">
2019-08-05 11:13:19 +02:00
<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>
2019-08-05 11:13:19 +02:00
</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>
2019-08-05 11:13:19 +02:00
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
2019-08-05 11:13:19 +02:00
<!-- ========= 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>
2019-08-05 11:13:19 +02:00
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
2019-08-05 11:13:19 +02:00
<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="sub-nav">
2019-08-05 11:13:19 +02:00
<div>
<ul class="sub-nav-list">
2019-08-05 11:13:19 +02:00
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
2019-08-05 11:13:19 +02:00
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" 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 ======== -->
2019-08-05 11:13:19 +02:00
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">com.djrapitops.plan.extension.table</a></div>
<h1 title="Class Table.Factory" class="title">Class Table.Factory</h1>
2019-08-05 11:13:19 +02:00
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/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">com.djrapitops.plan.extension.table.Table.Factory</div>
</div>
<section class="description">
<dl class="notes">
2019-08-05 11:13:19 +02:00
<dt>Enclosing class:</dt>
<dd><a href="Table.html" title="class in com.djrapitops.plan.extension.table">Table</a></dd>
2019-08-05 11:13:19 +02:00
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public static final class </span><span class="element-name type-name-label">Table.Factory</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
<div class="block">Factory for creating new <a href="Table.html" title="class in com.djrapitops.plan.extension.table"><code>Table</code></a> objects.</div>
</section>
<section class="summary">
<ul class="summary-list">
2019-08-05 11:13:19 +02:00
<!-- ========== 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-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">
<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-tab2 method-summary-table-tab4 method-summary-table"><code><a href="Table.Factory.html" title="class in com.djrapitops.plan.extension.table">Table.Factory</a></code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#addRow(java.lang.Object...)">addRow</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>...&nbsp;values)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
2019-08-05 11:13:19 +02:00
<div class="block">Add a row of values to the table.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="Table.html" title="class in com.djrapitops.plan.extension.table">Table</a></code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#build()">build</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
2019-08-05 11:13:19 +02:00
<div class="block">Finish building the table.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="Table.Factory.html" title="class in com.djrapitops.plan.extension.table">Table.Factory</a></code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#columnFive(java.lang.String,com.djrapitops.plan.extension.icon.Icon)">columnFive</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;columnName,
<a href="../icon/Icon.html" title="class in com.djrapitops.plan.extension.icon">Icon</a>&nbsp;icon)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
2019-08-05 11:13:19 +02:00
<div class="block">Set fifth column name and icon.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="Table.Factory.html" title="class in com.djrapitops.plan.extension.table">Table.Factory</a></code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#columnFour(java.lang.String,com.djrapitops.plan.extension.icon.Icon)">columnFour</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;columnName,
<a href="../icon/Icon.html" title="class in com.djrapitops.plan.extension.icon">Icon</a>&nbsp;icon)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
2019-08-05 11:13:19 +02:00
<div class="block">Set fourth column name and icon.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="Table.Factory.html" title="class in com.djrapitops.plan.extension.table">Table.Factory</a></code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#columnOne(java.lang.String,com.djrapitops.plan.extension.icon.Icon)">columnOne</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;columnName,
<a href="../icon/Icon.html" title="class in com.djrapitops.plan.extension.icon">Icon</a>&nbsp;icon)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
2019-08-05 11:13:19 +02:00
<div class="block">Set first column name and icon.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="Table.Factory.html" title="class in com.djrapitops.plan.extension.table">Table.Factory</a></code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#columnThree(java.lang.String,com.djrapitops.plan.extension.icon.Icon)">columnThree</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;columnName,
<a href="../icon/Icon.html" title="class in com.djrapitops.plan.extension.icon">Icon</a>&nbsp;icon)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
2019-08-05 11:13:19 +02:00
<div class="block">Set third column name and icon.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="Table.Factory.html" title="class in com.djrapitops.plan.extension.table">Table.Factory</a></code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#columnTwo(java.lang.String,com.djrapitops.plan.extension.icon.Icon)">columnTwo</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;columnName,
<a href="../icon/Icon.html" title="class in com.djrapitops.plan.extension.icon">Icon</a>&nbsp;icon)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
2019-08-05 11:13:19 +02:00
<div class="block">Set second column name and icon.</div>
</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/16/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/16/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/16/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/16/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/16/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/16/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/16/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/16/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/16/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/16/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/16/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/16/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>
2019-08-05 11:13:19 +02:00
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
2019-08-05 11:13:19 +02:00
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method.detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="columnOne(java.lang.String,com.djrapitops.plan.extension.icon.Icon)">
<h3>columnOne</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Table.Factory.html" title="class in com.djrapitops.plan.extension.table">Table.Factory</a></span>&nbsp;<span class="element-name">columnOne</span>&#8203;<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;columnName,
<a href="../icon/Icon.html" title="class in com.djrapitops.plan.extension.icon">Icon</a>&nbsp;icon)</span></div>
2019-08-05 11:13:19 +02:00
<div class="block">Set first column name and icon.</div>
<dl class="notes">
<dt>Parameters:</dt>
2019-08-05 11:13:19 +02:00
<dd><code>columnName</code> - Name of the column.</dd>
<dd><code>icon</code> - Icon of the column, color is ignored.</dd>
<dt>Returns:</dt>
2019-08-05 11:13:19 +02:00
<dd>Factory.</dd>
</dl>
</section>
2019-08-05 11:13:19 +02:00
</li>
<li>
<section class="detail" id="columnTwo(java.lang.String,com.djrapitops.plan.extension.icon.Icon)">
<h3>columnTwo</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Table.Factory.html" title="class in com.djrapitops.plan.extension.table">Table.Factory</a></span>&nbsp;<span class="element-name">columnTwo</span>&#8203;<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;columnName,
<a href="../icon/Icon.html" title="class in com.djrapitops.plan.extension.icon">Icon</a>&nbsp;icon)</span></div>
2019-08-05 11:13:19 +02:00
<div class="block">Set second column name and icon.</div>
<dl class="notes">
<dt>Parameters:</dt>
2019-08-05 11:13:19 +02:00
<dd><code>columnName</code> - Name of the column.</dd>
<dd><code>icon</code> - Icon of the column, color is ignored.</dd>
<dt>Returns:</dt>
2019-08-05 11:13:19 +02:00
<dd>Factory.</dd>
</dl>
</section>
2019-08-05 11:13:19 +02:00
</li>
<li>
<section class="detail" id="columnThree(java.lang.String,com.djrapitops.plan.extension.icon.Icon)">
<h3>columnThree</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Table.Factory.html" title="class in com.djrapitops.plan.extension.table">Table.Factory</a></span>&nbsp;<span class="element-name">columnThree</span>&#8203;<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;columnName,
<a href="../icon/Icon.html" title="class in com.djrapitops.plan.extension.icon">Icon</a>&nbsp;icon)</span></div>
2019-08-05 11:13:19 +02:00
<div class="block">Set third column name and icon.</div>
<dl class="notes">
<dt>Parameters:</dt>
2019-08-05 11:13:19 +02:00
<dd><code>columnName</code> - Name of the column.</dd>
<dd><code>icon</code> - Icon of the column, color is ignored.</dd>
<dt>Returns:</dt>
2019-08-05 11:13:19 +02:00
<dd>Factory.</dd>
</dl>
</section>
2019-08-05 11:13:19 +02:00
</li>
<li>
<section class="detail" id="columnFour(java.lang.String,com.djrapitops.plan.extension.icon.Icon)">
<h3>columnFour</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Table.Factory.html" title="class in com.djrapitops.plan.extension.table">Table.Factory</a></span>&nbsp;<span class="element-name">columnFour</span>&#8203;<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;columnName,
<a href="../icon/Icon.html" title="class in com.djrapitops.plan.extension.icon">Icon</a>&nbsp;icon)</span></div>
2019-08-05 11:13:19 +02:00
<div class="block">Set fourth column name and icon.</div>
<dl class="notes">
<dt>Parameters:</dt>
2019-08-05 11:13:19 +02:00
<dd><code>columnName</code> - Name of the column.</dd>
<dd><code>icon</code> - Icon of the column, color is ignored.</dd>
<dt>Returns:</dt>
2019-08-05 11:13:19 +02:00
<dd>Factory.</dd>
</dl>
</section>
2019-08-05 11:13:19 +02:00
</li>
<li>
<section class="detail" id="columnFive(java.lang.String,com.djrapitops.plan.extension.icon.Icon)">
<h3>columnFive</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Table.Factory.html" title="class in com.djrapitops.plan.extension.table">Table.Factory</a></span>&nbsp;<span class="element-name">columnFive</span>&#8203;<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;columnName,
<a href="../icon/Icon.html" title="class in com.djrapitops.plan.extension.icon">Icon</a>&nbsp;icon)</span></div>
2019-08-05 11:13:19 +02:00
<div class="block">Set fifth column name and icon.</div>
<dl class="notes">
<dt>Parameters:</dt>
2019-08-05 11:13:19 +02:00
<dd><code>columnName</code> - Name of the column.</dd>
<dd><code>icon</code> - Icon of the column, color is ignored.</dd>
<dt>Returns:</dt>
2019-08-05 11:13:19 +02:00
<dd>Factory.</dd>
</dl>
</section>
2019-08-05 11:13:19 +02:00
</li>
<li>
<section class="detail" id="addRow(java.lang.Object...)">
<h3>addRow</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Table.Factory.html" title="class in com.djrapitops.plan.extension.table">Table.Factory</a></span>&nbsp;<span class="element-name">addRow</span>&#8203;<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>...&nbsp;values)</span></div>
2019-08-05 11:13:19 +02:00
<div class="block">Add a row of values to the table.</div>
<dl class="notes">
<dt>Parameters:</dt>
2019-08-05 11:13:19 +02:00
<dd><code>values</code> - One value per column you have defined, <code>Object#toString()</code> will be called on the objects.</dd>
<dt>Returns:</dt>
2019-08-05 11:13:19 +02:00
<dd>Factory.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - If given varargs for 'values' is null.</dd>
2019-08-05 11:13:19 +02:00
</dl>
</section>
2019-08-05 11:13:19 +02:00
</li>
<li>
<section class="detail" id="build()">
<h3>build</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Table.html" title="class in com.djrapitops.plan.extension.table">Table</a></span>&nbsp;<span class="element-name">build</span>()</div>
2019-08-05 11:13:19 +02:00
<div class="block">Finish building the table.</div>
<dl class="notes">
<dt>Returns:</dt>
2019-08-05 11:13:19 +02:00
<dd>Finished Table object.</dd>
</dl>
</section>
2019-08-05 11:13:19 +02:00
</li>
</ul>
</section>
2019-08-05 11:13:19 +02:00
</li>
</ul>
</section>
2019-08-05 11:13:19 +02:00
<!-- ========= END OF CLASS DATA ========= -->
</main>
2019-08-05 11:13:19 +02:00
</div>
</div>
</body>
</html>