296 lines
13 KiB
HTML
296 lines
13 KiB
HTML
|
<!DOCTYPE HTML>
|
||
|
|
<!-- NewPage -->
|
||
|
|
<html lang="fr">
|
||
|
|
<head>
|
||
|
|
<!-- Generated by javadoc (15) on Fri May 07 15:56:25 CEST 2021 -->
|
||
|
|
<title>View</title>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf8">
|
||
|
|
<meta name="dc.created" content="2021-05-07">
|
||
|
|
<meta name="description" content="declaration: package: battleship.view, interface: View">
|
||
|
|
<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 data = {"i0":6,"i1":6,"i2":6,"i3":6};
|
||
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
|
||
|
|
var altColor = "alt-color";
|
||
|
|
var rowColor = "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">Help</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="sub-nav">
|
||
|
|
<div>
|
||
|
|
<ul class="sub-nav-list">
|
||
|
|
<li>Summary: </li>
|
||
|
|
<li>Nested | </li>
|
||
|
|
<li><a href="#field.summary">Field</a> | </li>
|
||
|
|
<li>Constr | </li>
|
||
|
|
<li><a href="#method.summary">Method</a></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="sub-nav-list">
|
||
|
|
<li>Detail: </li>
|
||
|
|
<li><a href="#field.detail">Field</a> | </li>
|
||
|
|
<li>Constr | </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 ======== -->
|
||
|
|
<div class="header">
|
||
|
|
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">battleship.view</a></div>
|
||
|
|
<h1 title="Interface View" class="title">Interface View</h1>
|
||
|
|
</div>
|
||
|
|
<section class="description">
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>All Known Implementing Classes:</dt>
|
||
|
|
<dd><code><a href="AbstractView.html" title="class in battleship.view">AbstractView</a></code>, <code><a href="Terminal.html" title="class in battleship.view">Terminal</a></code>, <code><a href="Window.html" title="class in battleship.view">Window</a></code></dd>
|
||
|
|
</dl>
|
||
|
|
<hr>
|
||
|
|
<pre>public interface <span class="type-name-label">View</span></pre>
|
||
|
|
<div class="block"><p>View interface, used as an API</p>
|
||
|
|
<p>This model (interface -> abstract class(es) -> concrete classes) prevent hard code.</p>
|
||
|
|
<p>This is the only object which interact with other object<br>
|
||
|
|
Allows an outside person easily change the code or add a view easily without modifying existing classes</p></div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>See Also:</dt>
|
||
|
|
<dd><a href="AbstractView.html" title="class in battleship.view"><code>AbstractView</code></a>,
|
||
|
|
<a href="Terminal.html" title="class in battleship.view"><code>Terminal</code></a>,
|
||
|
|
<a href="Window.html" title="class in battleship.view"><code>Window</code></a></dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
<section class="summary">
|
||
|
|
<ul class="summary-list">
|
||
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
||
|
|
<li>
|
||
|
|
<section class="field-summary" id="field.summary">
|
||
|
|
<h2>Field Summary</h2>
|
||
|
|
<div class="member-summary">
|
||
|
|
<table class="summary-table">
|
||
|
|
<caption><span>Fields</span></caption>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class="col-first" scope="col">Modifier and Type</th>
|
||
|
|
<th class="col-second" scope="col">Field</th>
|
||
|
|
<th class="col-last" scope="col">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr class="alt-color">
|
||
|
|
<td class="col-first"><code>static int[]</code></td>
|
||
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#shipsSize">shipsSize</a></span></code></th>
|
||
|
|
<td class="col-last"> </td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
||
|
|
<li>
|
||
|
|
<section class="method-summary" id="method.summary">
|
||
|
|
<h2>Method Summary</h2>
|
||
|
|
<div class="member-summary" id="method-summary-table">
|
||
|
|
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="active-table-tab">All Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="table-tab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="table-tab" onclick="show(4);">Abstract Methods</button></div>
|
||
|
|
<div id="method-summary-table.tabpanel" role="tabpanel">
|
||
|
|
<table class="summary-table" aria-labelledby="t0">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class="col-first" scope="col">Modifier and Type</th>
|
||
|
|
<th class="col-second" scope="col">Method</th>
|
||
|
|
<th class="col-last" scope="col">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr class="alt-color" id="i0">
|
||
|
|
<td class="col-first"><code><a href="../utils/Pair.html" title="class in battleship.utils">Pair</a><java.lang.Integer,​java.lang.Integer></code></td>
|
||
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#chooseMove(battleship.model.player.Player)">chooseMove</a></span>​(<a href="../model/player/Player.html" title="interface in battleship.model.player">Player</a> player)</code></th>
|
||
|
|
<td class="col-last">
|
||
|
|
<div class="block">ask the player the choose a position on its opponent grid</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-color" id="i1">
|
||
|
|
<td class="col-first"><code>void</code></td>
|
||
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#displayBoard()">displayBoard</a></span>()</code></th>
|
||
|
|
<td class="col-last">
|
||
|
|
<div class="block">Display all grids</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="alt-color" id="i2">
|
||
|
|
<td class="col-first"><code>void</code></td>
|
||
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#displayWinner(battleship.model.player.Player)">displayWinner</a></span>​(<a href="../model/player/Player.html" title="interface in battleship.model.player">Player</a> winner)</code></th>
|
||
|
|
<td class="col-last">
|
||
|
|
<div class="block">Display the winner of the game and then close the game</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-color" id="i3">
|
||
|
|
<td class="col-first"><code>void</code></td>
|
||
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#setShips(battleship.model.player.Player)">setShips</a></span>​(<a href="../model/player/Player.html" title="interface in battleship.model.player">Player</a> player)</code></th>
|
||
|
|
<td class="col-last">
|
||
|
|
<div class="block">Ask <code>player</code> to set position of its ships</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</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="shipsSize">
|
||
|
|
<h3>shipsSize</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">static final</span> <span class="return-type">int[]</span> <span class="member-name">shipsSize</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="setShips(battleship.model.player.Player)">
|
||
|
|
<h3>setShips</h3>
|
||
|
|
<div class="member-signature"><span class="return-type">void</span> <span class="member-name">setShips</span>​(<span class="parameters"><a href="../model/player/Player.html" title="interface in battleship.model.player">Player</a> player)</span>
|
||
|
|
throws <span class="exceptions">java.lang.InterruptedException</span></div>
|
||
|
|
<div class="block">Ask <code>player</code> to set position of its ships</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>player</code> - player instance we ask</dd>
|
||
|
|
<dt>Throws:</dt>
|
||
|
|
<dd><code>java.lang.InterruptedException</code> - see <a href="Window.html#setShips(battleship.model.player.Player)"><code>Window.setShips(Player)</code></a></dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="displayBoard()">
|
||
|
|
<h3>displayBoard</h3>
|
||
|
|
<div class="member-signature"><span class="return-type">void</span> <span class="member-name">displayBoard</span>()</div>
|
||
|
|
<div class="block">Display all grids</div>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="chooseMove(battleship.model.player.Player)">
|
||
|
|
<h3>chooseMove</h3>
|
||
|
|
<div class="member-signature"><span class="return-type"><a href="../utils/Pair.html" title="class in battleship.utils">Pair</a><java.lang.Integer,​java.lang.Integer></span> <span class="member-name">chooseMove</span>​(<span class="parameters"><a href="../model/player/Player.html" title="interface in battleship.model.player">Player</a> player)</span>
|
||
|
|
throws <span class="exceptions">java.lang.InterruptedException</span></div>
|
||
|
|
<div class="block">ask the player the choose a position on its opponent grid</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>player</code> - <a href="../model/Game.html#currentPlayer"><code>Game.currentPlayer</code></a></dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>a element containing the x and y coordinate (left side store Y and right side X)</dd>
|
||
|
|
<dt>Throws:</dt>
|
||
|
|
<dd><code>java.lang.InterruptedException</code> - see <a href="Window.html#chooseMove(battleship.model.player.Player)"><code>Window.chooseMove(Player)</code></a></dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="displayWinner(battleship.model.player.Player)">
|
||
|
|
<h3>displayWinner</h3>
|
||
|
|
<div class="member-signature"><span class="return-type">void</span> <span class="member-name">displayWinner</span>​(<span class="parameters"><a href="../model/player/Player.html" title="interface in battleship.model.player">Player</a> winner)</span></div>
|
||
|
|
<div class="block">Display the winner of the game and then close the game</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>winner</code> - the winner of the game.</dd>
|
||
|
|
<dt>See Also:</dt>
|
||
|
|
<dd><a href="Window.html#displayWinner(battleship.model.player.Player)"><code>Window.displayWinner(Player)</code></a>,
|
||
|
|
<a href="Terminal.html#displayWinner(battleship.model.player.Player)"><code>Terminal.displayWinner(Player)</code></a></dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
||
|
|
</main>
|
||
|
|
<footer role="contentinfo">
|
||
|
|
<nav role="navigation">
|
||
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||
|
|
<div class="bottom-nav" id="navbar.bottom">
|
||
|
|
<div class="skip-nav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
||
|
|
<ul id="navbar.bottom.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">Help</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="sub-nav">
|
||
|
|
<div>
|
||
|
|
<ul class="sub-nav-list">
|
||
|
|
<li>Summary: </li>
|
||
|
|
<li>Nested | </li>
|
||
|
|
<li><a href="#field.summary">Field</a> | </li>
|
||
|
|
<li>Constr | </li>
|
||
|
|
<li><a href="#method.summary">Method</a></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="sub-nav-list">
|
||
|
|
<li>Detail: </li>
|
||
|
|
<li><a href="#field.detail">Field</a> | </li>
|
||
|
|
<li>Constr | </li>
|
||
|
|
<li><a href="#method.detail">Method</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||
|
|
<span class="skip-nav" id="skip.navbar.bottom">
|
||
|
|
<!-- -->
|
||
|
|
</span></nav>
|
||
|
|
</footer>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|