* Better loading

* Fix draw issue with newIndicator
* Preserve initialFocusIndex between views (note: WIP: needs additional work for expected behavior)
This commit is contained in:
Bryan Ashby 2016-07-13 22:44:55 -06:00
parent c94f663947
commit 9155832139

View file

@ -1,16 +1,15 @@
/* jslint node: true */ /* jslint node: true */
'use strict'; 'use strict';
var MenuModule = require('../core/menu_module.js').MenuModule; // ENiGMA½
var ViewController = require('../core/view_controller.js').ViewController; const MenuModule = require('../core/menu_module.js').MenuModule;
var messageArea = require('../core/message_area.js'); const ViewController = require('../core/view_controller.js').ViewController;
var Message = require('../core/message.js'); const messageArea = require('../core/message_area.js');
//var moment = require('moment'); // deps
var async = require('async'); const async = require('async');
var assert = require('assert'); const _ = require('lodash');
var _ = require('lodash'); const moment = require('moment');
var moment = require('moment');
/* /*
Available listFormat/focusListFormat members (VM1): Available listFormat/focusListFormat members (VM1):
@ -30,6 +29,8 @@ var moment = require('moment');
TL5 : Total messages in area TL5 : Total messages in area
*/ */
// :TODO: We need a way to update |initialFocusIndex| after next/prev in actual message viewing -- e.g. from child menu!!
exports.getModule = MessageListModule; exports.getModule = MessageListModule;
exports.moduleInfo = { exports.moduleInfo = {
@ -49,8 +50,8 @@ var MciCodesIds = {
function MessageListModule(options) { function MessageListModule(options) {
MenuModule.call(this, options); MenuModule.call(this, options);
var self = this; const self = this;
var config = this.menuConfig.config; const config = this.menuConfig.config;
this.messageAreaTag = config.messageAreaTag; this.messageAreaTag = config.messageAreaTag;
@ -69,9 +70,11 @@ function MessageListModule(options) {
} }
this.menuMethods = { this.menuMethods = {
selectMessage : function(formData, extraArgs) { selectMessage : function(formData) {
if(1 === formData.submitId) { if(1 === formData.submitId) {
var modOpts = { self.initialFocusIndex = formData.value.message;
const modOpts = {
extraArgs : { extraArgs : {
messageAreaTag : self.messageAreaTag, messageAreaTag : self.messageAreaTag,
messageList : self.messageList, messageList : self.messageList,
@ -85,7 +88,7 @@ function MessageListModule(options) {
}; };
this.setViewText = function(id, text) { this.setViewText = function(id, text) {
var v = self.viewControllers.allViews.getView(id); const v = self.viewControllers.allViews.getView(id);
if(v) { if(v) {
v.setText(text); v.setText(text);
} }
@ -107,10 +110,8 @@ MessageListModule.prototype.enter = function() {
}; };
MessageListModule.prototype.mciReady = function(mciData, cb) { MessageListModule.prototype.mciReady = function(mciData, cb) {
var self = this; const self = this;
var vc = self.viewControllers.allViews = new ViewController( { client : self.client } ); const vc = self.viewControllers.allViews = new ViewController( { client : self.client } );
var firstNewEntryIndex;
async.series( async.series(
[ [
@ -148,58 +149,53 @@ MessageListModule.prototype.mciReady = function(mciData, cb) {
callback(null); // ignore any errors, e.g. missing value callback(null); // ignore any errors, e.g. missing value
}); });
}, },
function updateMessageListObjects(callback) {
const dateTimeFormat = self.menuConfig.config.dateTimeFormat || 'ddd MMM Do';
const newIndicator = self.menuConfig.config.newIndicator || '*';
const regIndicator = new Array(newIndicator.length + 1).join(' '); // fill with space to avoid draw issues
let msgNum = 1;
self.messageList.forEach( (listItem, index) => {
listItem.msgNum = msgNum++;
listItem.ts = moment(listItem.modTimestamp).format(dateTimeFormat);
listItem.newIndicator = listItem.messageId > self.lastReadId ? newIndicator : regIndicator;
if(_.isUndefined(self.initialFocusIndex) && listItem.messageId > self.lastReadId) {
self.initialFocusIndex = index;
}
});
return callback(null);
},
function populateList(callback) { function populateList(callback) {
var msgListView = vc.getView(MciCodesIds.MsgList); const msgListView = vc.getView(MciCodesIds.MsgList);
const listFormat = self.menuConfig.config.listFormat || '{msgNum} - {subject} - {toUserName}';
const focusListFormat = self.menuConfig.config.focusListFormat || listFormat; // :TODO: default change color here
// :TODO: fix default format // :TODO: This can take a very long time to load large lists. What we need is to implement the "owner draw" concept in
var listFormat = self.menuConfig.config.listFormat || '{msgNum} - {subj} - {to}'; // which items are requested (e.g. their format at least) *as-needed* vs trying to get the format for all of them at once
var focusListFormat = self.menuConfig.config.focusListFormat || listFormat; // :TODO: default change color here
var dateTimeFormat = self.menuConfig.config.dateTimeFormat || 'ddd MMM Do';
var newIndicator = self.menuConfig.config.newIndicator || '*';
var msgNum = 1; msgListView.setItems(_.map(self.messageList, listEntry => {
return listFormat.format(listEntry);
function getMsgFmtObj(mle) {
if(_.isUndefined(firstNewEntryIndex) &&
mle.messageId > self.lastReadId)
{
firstNewEntryIndex = msgNum - 1;
}
return {
msgNum : msgNum++,
subj : mle.subject,
from : mle.fromUserName,
to : mle.toUserName,
ts : moment(mle.modTimestamp).format(dateTimeFormat),
newIndicator : mle.messageId > self.lastReadId ? newIndicator : '',
};
}
msgListView.setItems(_.map(self.messageList, function formatMsgListEntry(mle) {
return listFormat.format(getMsgFmtObj(mle));
})); }));
msgNum = 1; msgListView.setFocusItems(_.map(self.messageList, listEntry => {
msgListView.setFocusItems(_.map(self.messageList, function formatMsgListEntry(mle) { return focusListFormat.format(listEntry);
return focusListFormat.format(getMsgFmtObj(mle));
})); }));
msgListView.on('index update', function indexUpdated(idx) { msgListView.on('index update', function indexUpdated(idx) {
self.setViewText(MciCodesIds.MsgSelNum, (idx + 1).toString()); self.setViewText(MciCodesIds.MsgSelNum, (idx + 1).toString());
}); });
if(self.initialFocusIndex > 0) {
// note: causes redraw()
msgListView.setFocusItemIndex(self.initialFocusIndex);
} else {
msgListView.redraw(); msgListView.redraw();
if(firstNewEntryIndex > 0) {
msgListView.setFocusItemIndex(firstNewEntryIndex);
} }
callback(null); callback(null);
}, },
function populateOtherMciViews(callback) { function populateOtherMciViews(callback) {
self.setViewText(MciCodesIds.MsgAreaDesc, messageArea.getMessageAreaByTag(self.messageAreaTag).name); self.setViewText(MciCodesIds.MsgAreaDesc, messageArea.getMessageAreaByTag(self.messageAreaTag).name);
self.setViewText(MciCodesIds.MsgSelNum, (vc.getView(MciCodesIds.MsgList).getData() + 1).toString()); self.setViewText(MciCodesIds.MsgSelNum, (vc.getView(MciCodesIds.MsgList).getData() + 1).toString());
self.setViewText(MciCodesIds.MsgTotal, self.messageList.length.toString()); self.setViewText(MciCodesIds.MsgTotal, self.messageList.length.toString());
@ -209,11 +205,19 @@ MessageListModule.prototype.mciReady = function(mciData, cb) {
], ],
function complete(err) { function complete(err) {
if(err) { if(err) {
self.client.log.error( { error : err.toString() }, 'Error loading message list'); self.client.log.error( { error : err.message }, 'Error loading message list');
} }
cb(err); cb(err);
} }
); );
}; };
MessageListModule.prototype.getSaveState = function() {
return { initialFocusIndex : this.initialFocusIndex };
};
MessageListModule.prototype.restoreSavedState = function(savedState) {
if(savedState) {
this.initialFocusIndex = savedState.initialFocusIndex;
}
};