bgabriel998/SoftwareDevProject

View on GitHub
doc/JavaDoc/ch/epfl/sdp/peakar/utils/TopBarHandlerFragments.html

Summary

Maintainability
Test Coverage
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_242-release) on Fri Jun 04 18:15:41 CEST 2021 -->
<title>TopBarHandlerFragments</title>
<meta name="date" content="2021-06-04">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="TopBarHandlerFragments";
        }
    }
    catch(err) {
    }
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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">
<li><a href="../../../../../ch/epfl/sdp/peakar/utils/StorageHandler.html" title="class in ch.epfl.sdp.peakar.utils"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../ch/epfl/sdp/peakar/utils/UIUtils.html" title="class in ch.epfl.sdp.peakar.utils"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?ch/epfl/sdp/peakar/utils/TopBarHandlerFragments.html" target="_top">Frames</a></li>
<li><a href="TopBarHandlerFragments.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">ch.epfl.sdp.peakar.utils</div>
<h2 title="Class TopBarHandlerFragments" class="title">Class TopBarHandlerFragments</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>ch.epfl.sdp.peakar.utils.TopBarHandlerFragments</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">TopBarHandlerFragments</span>
extends java.lang.Object</pre>
<div class="block">Only contains static functions to control the top bar that is to be
 displayed in several activities.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/utils/TopBarHandlerFragments.html#TopBarHandlerFragments--">TopBarHandlerFragments</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/utils/TopBarHandlerFragments.html#setupDots-androidx.fragment.app.Fragment-android.view.View.OnClickListener-">setupDots</a></span>(androidx.fragment.app.Fragment&nbsp;fragment,
         android.view.View.OnClickListener&nbsp;listener)</code>
<div class="block">Setup the dots button given a listener that gets called when dots button is clicked.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/utils/TopBarHandlerFragments.html#setupGreyTopBar-androidx.fragment.app.Fragment-">setupGreyTopBar</a></span>(androidx.fragment.app.Fragment&nbsp;fragment)</code>
<div class="block">Sets up the top bar in it's grey form.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/utils/TopBarHandlerFragments.html#setupSwitch-androidx.fragment.app.Fragment-java.lang.String-java.lang.String-android.widget.CompoundButton.OnCheckedChangeListener-">setupSwitch</a></span>(androidx.fragment.app.Fragment&nbsp;fragment,
           java.lang.String&nbsp;leftText,
           java.lang.String&nbsp;rightText,
           android.widget.CompoundButton.OnCheckedChangeListener&nbsp;listener)</code>
<div class="block">Setup the switch given two texts and a listener for switch event</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/utils/TopBarHandlerFragments.html#setupTransparentTopBar-androidx.fragment.app.Fragment-int-">setupTransparentTopBar</a></span>(androidx.fragment.app.Fragment&nbsp;fragment,
                      int&nbsp;iconColorId)</code>
<div class="block">Sets up the top bar in it's transparent form.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/utils/TopBarHandlerFragments.html#setVisibilityTopBar-androidx.fragment.app.Fragment-boolean-">setVisibilityTopBar</a></span>(androidx.fragment.app.Fragment&nbsp;fragment,
                   boolean&nbsp;visible)</code>
<div class="block">Sets the visibility of the top bar</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="TopBarHandlerFragments--">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TopBarHandlerFragments</h4>
<pre>public&nbsp;TopBarHandlerFragments()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="setupTransparentTopBar-androidx.fragment.app.Fragment-int-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setupTransparentTopBar</h4>
<pre>public static&nbsp;void&nbsp;setupTransparentTopBar(androidx.fragment.app.Fragment&nbsp;fragment,
                                          int&nbsp;iconColorId)</pre>
<div class="block">Sets up the top bar in it's transparent form.
 By coloring top bar transparent and setting all icons to a given color</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fragment</code> - active fragment.</dd>
<dd><code>iconColorId</code> - color to set icons to.</dd>
</dl>
</li>
</ul>
<a name="setupGreyTopBar-androidx.fragment.app.Fragment-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setupGreyTopBar</h4>
<pre>public static&nbsp;void&nbsp;setupGreyTopBar(androidx.fragment.app.Fragment&nbsp;fragment)</pre>
<div class="block">Sets up the top bar in it's grey form.
 By coloring top bar grey and setting all icons to DarkGreen</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fragment</code> - Active fragment.</dd>
</dl>
</li>
</ul>
<a name="setupSwitch-androidx.fragment.app.Fragment-java.lang.String-java.lang.String-android.widget.CompoundButton.OnCheckedChangeListener-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setupSwitch</h4>
<pre>public static&nbsp;void&nbsp;setupSwitch(androidx.fragment.app.Fragment&nbsp;fragment,
                               java.lang.String&nbsp;leftText,
                               java.lang.String&nbsp;rightText,
                               android.widget.CompoundButton.OnCheckedChangeListener&nbsp;listener)</pre>
<div class="block">Setup the switch given two texts and a listener for switch event</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fragment</code> - currently using</dd>
<dd><code>leftText</code> - text that appears left of switch.</dd>
<dd><code>rightText</code> - text that appears right of switch.</dd>
<dd><code>listener</code> - listener to event when switch is pressed.</dd>
</dl>
</li>
</ul>
<a name="setupDots-androidx.fragment.app.Fragment-android.view.View.OnClickListener-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setupDots</h4>
<pre>public static&nbsp;void&nbsp;setupDots(androidx.fragment.app.Fragment&nbsp;fragment,
                             android.view.View.OnClickListener&nbsp;listener)</pre>
<div class="block">Setup the dots button given a listener that gets called when dots button is clicked.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fragment</code> - currently using</dd>
<dd><code>listener</code> - to be called when dots button is clicked</dd>
</dl>
</li>
</ul>
<a name="setVisibilityTopBar-androidx.fragment.app.Fragment-boolean-">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setVisibilityTopBar</h4>
<pre>public static&nbsp;void&nbsp;setVisibilityTopBar(androidx.fragment.app.Fragment&nbsp;fragment,
                                       boolean&nbsp;visible)</pre>
<div class="block">Sets the visibility of the top bar</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fragment</code> - active fragment</dd>
<dd><code>visible</code> - If true visible else invisible</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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">
<li><a href="../../../../../ch/epfl/sdp/peakar/utils/StorageHandler.html" title="class in ch.epfl.sdp.peakar.utils"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../ch/epfl/sdp/peakar/utils/UIUtils.html" title="class in ch.epfl.sdp.peakar.utils"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?ch/epfl/sdp/peakar/utils/TopBarHandlerFragments.html" target="_top">Frames</a></li>
<li><a href="TopBarHandlerFragments.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>