MMBatchList_Column functions
SetDisplayInMenu( true | false )
Default is true, so there is really no need to call SetDisplayInMenu( true ). Calling SetDisplayInMenu( false ) will hide the column from the "Show/Hide Columns" menu. This basically allows you to force a column to either always be visible in the list, or always be hidden (when used in conjunction with SetDisplayInList)
SetDisplayInList( true | false )
Default is true, so there is really no need to call SetDisplayInList( true ). Calling SetDisplayInList( false ) will hide the column from the mmbatchlist (you will still see it in the menu if you don't call SetDisplayInMenu( false )). There are two main reasons to use this. The first would be to make a column sortable but not visible (sorting by an ID would be an example of this. You don't want to display the id, but it would be nice to sort by it). The second reason to use this is for search purposes... Occasionally, a list will need to display one set of data, while allowing you to search for something else. In cases like this, you would have a non-searchable column visible that shows your data, and then have one or more columns that are visible only in advanced search. Take the Product Attribute batchlist as an example. We only show the code/prompt columns in the list and we don't differentiate between attribute and option, but if you open the Advanced Search dialog there exists four columns instead of two: Attribute Code, Attribute Prompt, Option Code, and Option Prompt.
SetSearchable( true | false )
Columns are searchable by default. SetSearchable( false ) will disable all search functionality (simple, find in list, AND advanced search)
SetSimpleSearchEnabled( true | false )
Enabled by default. Enables/Disables Simple Search only (which also enables/disables Find In List) for a given column. This is useful if you want to have a column that is advanced-searchable but NOT searchable from the input field on the list itself (you would, for example, use this in the above example for SetDisplayInList).
SetAdvancedSearchEnabled( true | false )
Enabled by default. Enables/Disables Advanced Search only for a given column. This is useful if you want to have a column be simple searchable (from the search input on the batchlist), but NOT searchable when viewing the advanced search dialog.
SetSortByField( field_name )
The sort by field name is the string value passed to the backend JSON function used for that column's sort. For example, if I wanted to sort the column based on the "id" value, I could pass "id" as the field_name and any time I sorted by that column, we'd pass "id" as the sort by field. You would then handle this on the back end via SQL_Query_OrderBy_Fields (the MMBatchList tutorial should go into more detail for that). Passing a blank string will disable sort for the column.
SetOnRetrieveValue( onretrievevalue )
onretrievevalue is actually a function. This can be an anonymous function, or a declared function, but it must follow the format: function( record ) { return record.some_member; }. This is useful in circumstances where the value you want to display differs from the column code. Take the shipment list as an example. The JSON response we get back has the shipment information with the order information as a nested object (ie, record.order.xxx_member instead of record.xxx_member). In that example, our column code might be 'orderdate', but the data is nested in another object, so we would need to have a new retriever function in order to properly get the orderdate from the loaded data: SetOnRetrieveValue( function( record ) { return record.order.orderdate; } ); You can also use this to show/retrieve the data for a given row's column for any value you want. You could even hard code a response if you wanted.
SetOnSetValue( onsetvalue )
This function is the other end of SetOnRetrieveValue. It too takes a function as a parameter: function( record, value ) { record.some_member = value; }. This allows you to set any member in a record to the value passed in. This is used when in inline edit mode. There are numerous uses for this: updating two fields with the data from one (take a store selector as an example. You want to display the store code or name, but pass the store_id as a parameter, so when you change the store dropdown to another store, your onSetValue function would change both the record.store_id value AND the record.store_code/name value), updating a nested record (ie, instead of record.orderdate, record.order.orderdate), etc.
SetWidth( css_width_string )
This sets the default/minimum column width.
SetUpdateOnModifiedOnly( true | false )
If the list supports inline row editing, you can set a given column to update its data only when the value has changed (instead of every time). This is useful for things like custom fields (as an example of its use in Miva Merchant) so that we update/send the fields ONLY when they are changed to avoid unnecessary update calls. This also prevents using up unnecessary bandwidth. If you have 50 custom fields and you want to change the product code, for instance, you wouldn't want to send the data from 50 custom fields just to save the one code. Instead, you would have that column update its data only when the data is modified from its original value.
SetOnParseEditableColumn( onparseeditablecolumn )
onParseEditableColumn is the function that parses out the values from inputs, selects, radios, checkboxes, etc when in inline add/edit mode. If your editable column has custom edit mode fields that cannot be parsed by the default onParseEditableColumn function, you will need to use this function and pass in a function( new_record, element_column ) { ; } to handle the custom parsing. I won't go into too much detail with this, because examples can be seen in the LSK, and each case here will be different.
SetOnDisplayFieldError( ondisplayfielderror )
Similar in concept to onParseEditableColumn. You can override how errors for your column are displayed (make them have green borders or flashing pink swirly circles)
SetOnDisplayData( function( record, item, mmbatchlist ) { return document.createTextNode( record.some_member ); } )
This function allows you to display your data in a specific way (custom select fields, divs, adding buttons, etc). You are passed the row's record, the row's item (which contains a whole host of information), and a reference to the mmbatchlist variable (the list). You must ALWAYS return an element.
SetOnDisplayEdit( function( record, item, mmbatchlist ) { var input; input = newElement( 'input', { 'type': 'text', 'name': name, 'class': 'mm9_batchlist_data_col_editableinput' }, null, null ); return input; } )
Exactly the same as SetOnDisplayData, but for edit mode. You can use this to make custom displayed edit fields or you can make certain columns not editable by outputting the data in a non-editable field.
SetOnExportData( function( record ) { return record.some_member; } )
This is used for the CSV download functionality. You can have your column export custom data (ie, if your visual data shows you formatted price, you can output the price without the dollar sign)
SetSortByText( text )
Use this to change the text displayed in the "Sort" dropdown menu for your column
SetFieldName( fieldname )
This sets the field name that gets passed to the server as the "Name" in the name-value-pair for the edited/added data. Example: column cost would have "Cost" as the fieldname value and when passed to the server you would get g.Cost with a value of whatever your editable field had.
SetDefaultActive( true | false )
Default is false. If false, the column is not visible by default (you would have to go into the Show/Hide Columns menu and manually show it). If true, it WILL be shown by default.
new MMBatchList_Column_Text( 'Address 1', 'address1', 'Address1' ) .SetDisplayInList( false )
.SetSearchable( false ),
new MMBatchList_Column_Text( 'Address 2', 'address2', 'Address2' )
.SetDisplayInList( false )
.SetSearchable( false ),
new MMBatchList_Column_Text( 'City', 'city', 'City' ),
new MMBatchList_Column_Text( 'State', 'state', 'State' ),
new MMBatchList_Column_Text( 'Zip', 'postal_code', 'Zip' ),
new MMBatchList_Column_Text( 'Country', 'country', 'Country' ),
Gmap_List.prototype.onGeolocate = function()
{
var self = this;
var i, i_len, item, delegator;
if ( this.ActiveItemList_Count() == 0 )
{
return;
}
delegator = new AJAX_ThreadPool( 3 );
delegator.onComplete = function()
{
// Do something here. You don't need to, but it is available. This will run once ALL ajax calls have been completed from your list below
};
for ( i = 0, i_len = this.ActiveItemList_Count(); i < i_len; i++ )
{
if ( ( item = this.ActiveItemList_ItemAtIndex( i ) ) !== null )
{
Gmap_Geolocate( item.record.id, function( response ) { /* Do Something */; }, delegator );
}
}
delegator.Run();
}
Gmap_List.prototype.onGeolocate = function()
{
var self = this;
var i, i_len, item, id_list, delegator;
if ( this.ActiveItemList_Count() == 0 )
{
return;
}
delegator = new AJAX_ThreadPool( 3 );
delegator.onComplete = function()
{
// Do something here. You don't need to, but it is available. This will run once ALL ajax calls have been completed from your list below
};
for ( i = 0, i_len = this.ActiveItemList_Count(); i < i_len; i++ )
{
if ( ( item = this.ActiveItemList_ItemAtIndex( i ) ) === null )
{
continue;
}
id_list.push( item.record.id );
if ( id_list.length >= stoi_max( this.batchlist_count * 5, this.batchlist_max_delete_count ) )
{
Gmap_GeolocateList( id_list, function( response ) { /* Do Something */; }, delegator );
id_list = new Array();
}
}
delegator.Run();
}
Gmap_List.prototype.onGeolocate = function() {
var self = this;
var i, i_len, item, delegator;
var id_list = new Array();
if ( this.ActiveItemList_Count() == 0 ) {
return;
}
delegator = new AJAX_ThreadPool( 3 );
delegator.onComplete = function() {
self.Refresh();
};
for ( i = 0, i_len = this.ActiveItemList_Count(); i < i_len; i++ ) {
if ( ( item = this.ActiveItemList_ItemAtIndex( i ) ) === null ) {
continue;
}
id_list.push( item.record.id );
if ( id_list.length >= stoi_max( this.batchlist_count * 5, this.batchlist_max_delete_count ) ) {
Gmap_GeolocateList( id_list, function( response ) { /* Do Something */; }, delegator );
id_list = new Array();
}
}
if ( id_list.length > 0 ) {
Gmap_GeolocateList( id_list, function( response ) { /* Do Something */; }, delegator );
}
delegator.Run();
}
Gmap_List.prototype.EditSettings = function( ) {
var self = this;
var gmapsettings;
gmapsettings = new Gmap_SettingsDialog( );
gmapsettings.onsave = function() {
UpdateMessage_Display( 'Settings Updated' ); // obviously this does not work
}
gmapsettings.Show();
}
if ( top.mm9_screen )
{
top.mm9_screen.UpdateMessage_Display( 'Settings Updated' );
}
Comment