documon
Version:
A documentation system for mortals. Use with any language.
628 lines (311 loc) • 18.4 kB
HTML
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Access</title>
<meta name="description" content="Toggles member parts inheritance, private/public and protected in the menu and on the pages.">
<!-- Normalize -->
<link rel="stylesheet" href="assets/vendor/normalize.css">
<!-- prettify -->
<link rel="stylesheet" href="assets/vendor/prettify/codamike.css">
<script src="assets/vendor/prettify/prettify.js"></script>
<!-- Documon Pages Info. (Used by various classes to identify this page.) -->
<script>
var pageCtx = {
id : "documon.Access",
name: "Access"
}
</script>
<!-- theme
<link rel="stylesheet" href="assets/fonts/Fira_Sans/FiraSans.css">
<link rel="stylesheet" href="assets/fonts/Inconsolata/inconsolata.css">
-->
<link rel="stylesheet" href="assets/css/pages.css">
<script src="assets/js/documon/Storage.js"></script>
<script src="assets/js/documon/Access.js"></script>
<script src="assets/js/documon/Pages.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-106684927-1', 'auto');
ga('send', 'pageview');
</script>
</head>
<body>
<div class="page">
<div class="main-method">
<a name="methods"></a>
<div class="part-methods">
<a name="documon.Access"></a><a name="Access"></a>
<div class="member" >
<div class="member-name clearfix">
<span class="member-name-left">
Access ()
</span>
<span class="member-name-right">
<span class="member-file">documon/template/assets/js/documon/Access.js</span>
<span class="member-line-number">18</span>
</span>
</div>
<div class="member-description">
<div class="meta-block meta-block-klass">
<div class="meta-line"><span class="meta-label" >xpath</span> <span class="meta-target">documon.Access<span></div>
<div class="meta-line"><span class="meta-label" >file</span> <span class="meta-target">documon/template/assets/js/documon/Access.js<span></div>
</div>
<p>Toggles member parts inheritance, private/public and protected in the menu and on the pages.</p>
<p>This class serves dual purpose, as it is loaded on the main (index.html) page as well as <br />
individual pages that are loaded into the main page.</p>
<p>Since individual pages are loaded as iframes, we use a messaging system to<br />
communicate between the index and content pages.</p>
</div>
</div>
</div>
</div>
<div class="parts">
<a name="methods"></a>
<div class="part-methods">
<div class="heading-part">Methods</div>
<a name="documon.Access.applyAccess"></a><a name="applyAccess"></a>
<div class="member" data-access="public" >
<div class="member-name clearfix">
<span class="member-name-left">
applyAccess (<span class="method-arguments">showQuery</span>, <span class="method-arguments">hideQuery</span>)
</span>
<span class="member-name-right">
<span class="member-file">documon/template/assets/js/documon/Access.js</span>
<span class="member-line-number">52</span>
</span>
</div>
<div class="member-description">
<p>Applies the access to the current page. When showQuery and hideQuery are<br />
provided, then these will be used to apply the access, when not provided, the<br />
previous values will be used.</p>
<p>Generallly, the index page defines the showQuery and hideQuery values via the<br />
checkbox actions, and the content pages rely on sending the arguments to the<br />
function to apply the access to the page.</p>
<div class="part-parameters">
<div class="heading-part">Parameters</div>
<div class="member">
<div class="member-block-group">
<div class="member-block" >
<div class="member-block-left">
<span class="member-name">showQuery</span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="type">string</span>
<div class="member-description">
<p>The string to use as a selector for querySelectorAll</p>
</div>
</div>
</div>
</div>
<div class="member-block" >
<div class="member-block-left">
<span class="member-name">hideQuery</span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="type">string</span>
<div class="member-description">
<p>hideQuery</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<a name="documon.Access.clickAccess"></a><a name="clickAccess"></a>
<div class="member" data-access="protected" >
<div class="member-name clearfix">
<span class="member-name-left">
clickAccess (<span class="method-arguments">e</span>)
<span class="flag protected">protected</span> <!-- public private protected -->
</span>
<span class="member-name-right">
<span class="member-file">documon/template/assets/js/documon/Access.js</span>
<span class="member-line-number">122</span>
</span>
</div>
<div class="member-description">
<p>The checkbox action handler</p>
<div class="part-parameters">
<div class="heading-part">Parameters</div>
<div class="member">
<div class="member-block-group">
<div class="member-block" >
<div class="member-block-left">
<span class="member-name">e</span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="type">type</span>
<div class="member-description">
<p>the window event</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<a name="documon.Access.init"></a><a name="init"></a>
<div class="member" data-access="public" >
<div class="member-name clearfix">
<span class="member-name-left">
init ()
</span>
<span class="member-name-right">
<span class="member-file">documon/template/assets/js/documon/Access.js</span>
<span class="member-line-number">229</span>
</span>
</div>
<div class="member-description">
<p>The startup initializer</p>
</div>
</div>
<a name="documon.Access.receiveMessage"></a><a name="receiveMessage"></a>
<div class="member" data-access="protected" >
<div class="member-name clearfix">
<span class="member-name-left">
receiveMessage (<span class="method-arguments">message</span>)
<span class="flag protected">protected</span> <!-- public private protected -->
</span>
<span class="member-name-right">
<span class="member-file">documon/template/assets/js/documon/Access.js</span>
<span class="member-line-number">287</span>
</span>
</div>
<div class="member-description">
<p>THe handler pinged when a content page is loaded to check to see what the access whoudl be on<br />
the page.</p>
<div class="part-parameters">
<div class="heading-part">Parameters</div>
<div class="member">
<div class="member-block-group">
<div class="member-block" >
<div class="member-block-left">
<span class="member-name">message</span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="type">type</span>
<div class="member-description">
<p>A message object.</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<a name="documon.Access.restoreChecked"></a><a name="restoreChecked"></a>
<div class="member" data-access="private" >
<div class="member-name clearfix">
<span class="member-name-left">
restoreChecked ()
<span class="flag private">private</span> <!-- public private protected -->
</span>
<span class="member-name-right">
<span class="member-file">documon/template/assets/js/documon/Access.js</span>
<span class="member-line-number">202</span>
</span>
</div>
<div class="member-description">
<p>Restores the checkboxes to the value used last visit</p>
</div>
</div>
<a name="documon.Access.setAccess"></a><a name="setAccess"></a>
<div class="member" data-access="public" >
<div class="member-name clearfix">
<span class="member-name-left">
setAccess (<span class="method-arguments">inherits</span>, <span class="method-arguments">pprivate</span>, <span class="method-arguments">pprotected</span>)
</span>
<span class="member-name-right">
<span class="member-file">documon/template/assets/js/documon/Access.js</span>
<span class="member-line-number">144</span>
</span>
</div>
<div class="member-description">
<p>Generates the selector strings for showing and hiding members.</p>
<p>The query is based on HTML tags that have data- attributes that match the value (for non boolena<br />
type access values such as public/private/protected. And for boolean access, such as inherits,<br />
just checks to see if the data-inherits attribute exists</p>
<div class="part-parameters">
<div class="heading-part">Parameters</div>
<div class="member">
<div class="member-block-group">
<div class="member-block" >
<div class="member-block-left">
<span class="member-name">inherits</span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="type">boolean</span>
<div class="member-description">
<p>true when you want to show memebers that are inherited</p>
</div>
</div>
</div>
</div>
<div class="member-block" >
<div class="member-block-left">
<span class="member-name">pprivate</span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="type">boolean</span>
<div class="member-description">
<p>true when you want to show memebers that are private</p>
</div>
</div>
</div>
</div>
<div class="member-block" >
<div class="member-block-left">
<span class="member-name">pprotected</span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="type">boolean</span>
<div class="member-description">
<p>true when you want to show memebers that are protected</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">Generated by <a href="http://www.documon.net" target="_blank">Documon</a></div>
</body>
</html>