Skip to content

Refactoring helper.js #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
suryaprasanna merged 5 commits into from
Sep 6, 2017
Merged

Refactoring helper.js #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c7cb7f8
Refactoring helper.js.
tbembersimeao Sep 6, 2017
20495cd
Merge branch 'develop' of github.com:tbembersimeao/auto_populate_fiel…
tbembersimeao Sep 6, 2017
e6f8ea5
Little adjustment on helper.js.
tbembersimeao Sep 6, 2017
815a7ac
Fixing condition.
tbembersimeao Sep 6, 2017
b547ea1
Fixing typo.
tbembersimeao Sep 6, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Auto populate field values
# REDCap Auto Populate Fields
This REDCap Module provides tools to autopopulate fields.

## Prerequisites
Expand All @@ -11,17 +11,14 @@ This REDCap Module provides tools to autopopulate fields.

## Features included
This module provides 3 new [action tags](https://wiki.chpc.utah.edu/pages/viewpage.action?pageId=595001400):
- `@DEFAULT-FROM-FIELD`
- `@DEFAULT-WHEN-VISIBLE`
- `@DEFAULT-FROM-PREVIOUS-EVENT`

### @DEFAULT-FROM-FIELD
#### @DEFAULT-FROM-FIELD
It allows users to set up a field's default value from an existing field on the same form. Use case examples:
- Using hidden fields as source for visible fields, e.g. `@DEFAULT-FROM-FIELD="hidden_first_name"`.
- When a form field has been populated in the backend by a DET or API call - `@DEFAULT` cannot handle this.

### @DEFAULT-WHEN-VISIBLE
#### @DEFAULT-WHEN-VISIBLE
If the field is visible it sets the initial value otherwise it removes the value. This is mainly useful in fields which are visible and hidden by branching logic, e.g. `@DEFAULT-FROM-FIELD="10"`.

### @DEFAULT-FROM-PREVIOUS-EVENT
#### @DEFAULT-FROM-PREVIOUS-EVENT
Sets a field's default value based on its own value in a previous event. To map the default value from another field, you may specify the source as a parameter to the action tag, e.g `@DEFAULT-FROM-PREVIOUS-EVENT="source_field"`.
104 changes: 49 additions & 55 deletions js/helper.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,57 +1,51 @@
$(document).ready(function() {
// Checking if we are on the Online Designer page.
if ($('#div_field_annotation') === 0) {
return false;
}

$('body').on('dialogopen', function(event, ui) {
var $popup = $(event.target);
if ($popup.prop('id') !== 'action_tag_explain_popup') {
// That's not the popup we are looking for...
return false;
}

// Aux function that checks if text matches the "@DEFAULT" string.
var isDefaultLabelColumn = function() {
return $(this).text() === '@DEFAULT';
}

// Getting @DEFAULT row from action tags help table.
var $default_action_tag = $popup.find('td').filter(isDefaultLabelColumn).parent();
if ($default_action_tag.length !== 1) {
return;
}

// Creating a new action tag row - @DEFAULT-FROM-FIELD - from @DEFAULT.
var $new_action_tag1 = $default_action_tag.clone();
// Creating a new action tag row - @DEFAULT-ON-VISIBLE - from @DEFAULT.
var $new_action_tag2 = $default_action_tag.clone();
// Creating a new action tag row - @DEFAULT-FROM-PREVIOUS-VALUE - from @DEFAULT.
var $new_action_tag3 = $default_action_tag.clone();

// Column 1: updating button behavior.
var $button1 = $new_action_tag1.find('td button');
$button1.attr('onclick', $button1.attr('onclick').replace('@DEFAULT', '@DEFAULT-FROM-FIELD'));

var $button2 = $new_action_tag2.find('td button');
$button2.attr('onclick', $button2.attr('onclick').replace('@DEFAULT', '@DEFAULT-ON-VISIBLE'));

var $button3 = $new_action_tag3.find('td button');
$button3.attr('onclick', $button3.attr('onclick').replace('@DEFAULT', '@DEFAULT-FROM-PREVIOUS-VALUE'));

// Columns 2: updating action tag label.
$new_action_tag1.children('td').filter(isDefaultLabelColumn).text('@DEFAULT-FROM-FIELD');
$new_action_tag2.children('td').filter(isDefaultLabelColumn).text('@DEFAULT-ON-VISIBLE');
$new_action_tag3.children('td').filter(isDefaultLabelColumn).text('@DEFAULT-FROM-PREVIOUS-VALUE');

// Column 3: updating action tag description.
$new_action_tag1.children('td').last().text('Sets a fields\'s default value from an existing field on the same form. This is useful when using hidden fields as source for visible fields, e.g. @DEFAULT-FROM-FIELD=\'hidden_first_name\'.');
$new_action_tag2.children('td').last().text('If the field is visible it sets the initial value otherwise it removes the value. This is mainly useful in fields which are visible and hidden by branching logic, e.g. @DEFAULT-FROM-FIELD=\'10\'.');
$new_action_tag3.children('td').last().text('Sets a field\'s default value based on its own value in a previous event. To map the default value from another field, you may specify the source as a parameter to the action tag, e.g @DEFAULT-FROM-PREVIOUS-EVENT="source_field".');

// Inserting new action tags after @DEFAULT.
$new_action_tag1.insertAfter($default_action_tag);
$new_action_tag2.insertAfter($new_action_tag1);
$new_action_tag3.insertAfter($new_action_tag2);
});
// Checking if we are on the Online Designer page.
if ($('#div_field_annotation').length === 0) {
return false;
}

$('body').on('dialogopen', function(event, ui) {
var $popup = $(event.target);
if ($popup.prop('id') !== 'action_tag_explain_popup') {
// That's not the popup we are looking for...
return false;
}

// Aux function that checks if text matches the "@DEFAULT" string.
var isDefaultLabelColumn = function() {
return $(this).text() === '@DEFAULT';
}

// Getting @DEFAULT row from action tags help table.
var $default_action_tag = $popup.find('td').filter(isDefaultLabelColumn).parent();
if ($default_action_tag.length !== 1) {
return;
}

// Setting up action tags description texts.
var texts = {
'@DEFAULT-FROM-PREVIOUS-EVENT': 'Sets a field\'s default value based on its own value in a previous event. To map the default value from another field, you may specify the source as a parameter to the action tag, e.g @DEFAULT-FROM-PREVIOUS-EVENT="source_field".',
'@DEFAULT-WHEN-VISIBLE': 'If the field is visible it sets the initial value otherwise it removes the value. This is mainly useful in fields which are visible and hidden by branching logic, e.g. @DEFAULT-FROM-FIELD=\'10\'.',
'@DEFAULT-FROM-FIELD': 'Sets a field\'s default value from an existing field on the same form. This is useful when using hidden fields as source for visible fields, e.g. @DEFAULT-FROM-FIELD=\'hidden_first_name\'.'
};

$.each(texts, function(tag_name, descr) {
// Creating a new action tag row.
var $new_action_tag = $default_action_tag.clone();
var $cols = $new_action_tag.children('td');
var $button = $cols.find('button');

// Column 1: updating button behavior.
$button.attr('onclick', $button.attr('onclick').replace('@DEFAULT', tag_name));

// Columns 2: updating action tag label.
$cols.filter(isDefaultLabelColumn).text(tag_name);

// Column 3: updating action tag description.
$cols.last().text(descr);

// Placing new action tag.
$new_action_tag.insertAfter($default_action_tag);
});
});
});