some documentation
This commit is contained in:
parent
68dc665c65
commit
8df50acce7
|
@ -5,8 +5,10 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @brief foobar
|
||||
* @brief this object takes care of the filter funcationality on the user
|
||||
* management page
|
||||
* @param jQuery input element that works as the user text input field
|
||||
* @param object the UserList object
|
||||
*/
|
||||
function UserManagementFilter(filterInput, userList) {
|
||||
this.filterInput = filterInput;
|
||||
|
@ -16,6 +18,9 @@ function UserManagementFilter(filterInput, userList) {
|
|||
this.init();
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief sets up when the filter action shall be triggered
|
||||
*/
|
||||
UserManagementFilter.prototype.init = function() {
|
||||
umf = this;
|
||||
this.filterInput.keyup(function() {
|
||||
|
@ -29,11 +34,19 @@ UserManagementFilter.prototype.init = function() {
|
|||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief the filter action needs to be done, here the accurate steps are being
|
||||
* taken care of
|
||||
*/
|
||||
UserManagementFilter.prototype.run = function() {
|
||||
this.userList.empty();
|
||||
this.userList.update();
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief returns the filter String
|
||||
* @returns string
|
||||
*/
|
||||
UserManagementFilter.prototype.getPattern = function() {
|
||||
return this.filterInput.val();
|
||||
}
|
Loading…
Reference in New Issue