Access () documon/template/assets/js/documon/Access.js 18
xpath documon.Access
file documon/template/assets/js/documon/Access.js

Toggles member parts inheritance, private/public and protected in the menu and on the pages.

This class serves dual purpose, as it is loaded on the main (index.html) page as well as
individual pages that are loaded into the main page.

Since individual pages are loaded as iframes, we use a messaging system to
communicate between the index and content pages.

Methods
applyAccess (showQuery, hideQuery) documon/template/assets/js/documon/Access.js 52

Applies the access to the current page. When showQuery and hideQuery are
provided, then these will be used to apply the access, when not provided, the
previous values will be used.

Generallly, the index page defines the showQuery and hideQuery values via the
checkbox actions, and the content pages rely on sending the arguments to the
function to apply the access to the page.

Parameters
showQuery
string

The string to use as a selector for querySelectorAll

hideQuery
string

hideQuery

clickAccess (e) protected documon/template/assets/js/documon/Access.js 122

The checkbox action handler

Parameters
e
type

the window event

init () documon/template/assets/js/documon/Access.js 229

The startup initializer

receiveMessage (message) protected documon/template/assets/js/documon/Access.js 287

THe handler pinged when a content page is loaded to check to see what the access whoudl be on
the page.

Parameters
message
type

A message object.

restoreChecked () private documon/template/assets/js/documon/Access.js 202

Restores the checkboxes to the value used last visit

setAccess (inherits, pprivate, pprotected) documon/template/assets/js/documon/Access.js 144

Generates the selector strings for showing and hiding members.

The query is based on HTML tags that have data- attributes that match the value (for non boolena
type access values such as public/private/protected. And for boolean access, such as inherits,
just checks to see if the data-inherits attribute exists

Parameters
inherits
boolean

true when you want to show memebers that are inherited

pprivate
boolean

true when you want to show memebers that are private

pprotected
boolean

true when you want to show memebers that are protected

Generated by Documon