Add JSDoc

This commit is contained in:
Ilya Daynatovich 2016-10-21 18:14:12 +03:00
parent d4df6f2dda
commit 5e8c5b3ce4
2 changed files with 46 additions and 1 deletions

View File

@ -17,11 +17,20 @@ export default class RequirePasswordDialog {
this.isOpened = false;
}
/**
* Registering dialog listeners
* @private
*/
_registerListeners() {
let el = document.getElementById(this.inputId);
el.addEventListener('keypress', this._hideError.bind(this));
}
/**
* Helper method returning dialog body
* @returns {string}
* @private
*/
_getBodyMessage() {
return (
`<div class="input-control">
@ -37,6 +46,10 @@ export default class RequirePasswordDialog {
);
}
/**
* Asking for a password
* @returns {Promise}
*/
askForPassword() {
if (!this.isOpened) {
return this.open();
@ -49,6 +62,10 @@ export default class RequirePasswordDialog {
});
}
/**
* Opens the dialog
* @returns {Promise}
*/
open() {
let { titleKey } = this;
let msgString = this._getBodyMessage();
@ -73,6 +90,14 @@ export default class RequirePasswordDialog {
});
}
/**
* Submit dialog callback
* @param e - event
* @param v - value
* @param m - message
* @param f - form
* @private
*/
_submitFunction(e, v, m, f) {
e.preventDefault();
@ -83,23 +108,38 @@ export default class RequirePasswordDialog {
}
}
/**
* Close dialog callback
* @private
*/
_closeFunction() {
this._hideError();
this.close();
}
/**
* Method showing error hint
* @private
*/
_showError() {
let className = this.inputErrorClass;
document.getElementById(this.errorId).classList.remove('hide');
document.getElementById(this.inputId).classList.add(className);
}
/**
* Method hiding error hint
* @private
*/
_hideError() {
let className = this.inputErrorClass;
document.getElementById(this.errorId).classList.add('hide');
document.getElementById(this.inputId).classList.remove(className);
}
/**
* Close the dialog
*/
close() {
APP.UI.messageHandler.closeDialog();
this.isOpened = false;

View File

@ -118,8 +118,13 @@ export default function createRoomLocker (room) {
);
},
/**
* Hides require password dialog
*/
hideRequirePasswordDialog() {
requirePasswordDialog.close();
if (requirePasswordDialog.isOpened) {
requirePasswordDialog.close();
}
}
};
}