Uiinfrastructure API Docs  
 

SortedMetaDataListModel Members

SortedMetaDataListModel overview

Public Static Fields

STR_MVC_CLASS_NAME Class name for the activity space

Public Instance Constructors

SortedMetaDataListModel Constructor Initializes a new instance of the SortedMetaDataListModel class.

Public Instance Fields

m_asOwner (inherited from EditorHelperModel) Associated Activity Space.
m_intNumColumns (inherited from MultiColumnListModel) Number total of columns
m_nNextIndex (inherited from ExpListModel) To keep track of the next available index. This index is incremented each time a row is added to the list.

Public Instance Methods

AddRowsOnRepost (inherited from MultiColumnListModel) Adds one row at the bottom of the list and sets the following values: First column: m_nNextIndex Second column: m_sDefaultValue
AddRowsToList (inherited from MultiColumnListModel) Adds an array of new rows to the list.
CleanupAllData (inherited from EditorHelperModel) 
CleanupTempData (inherited from EditorHelperModel) 
Create 
DeleteRowsOnRepost (inherited from ExpListModel) Gets the array of checked rows and delete them from the list.
DisableAddButton (inherited from ExpListModel) DCA - Choose not to display add button
DisableCheckBoxes (inherited from ExpListModel) DCA - Disable check boxes.
EnablePagination (inherited from ExpListModel) Enables the pagination.
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetAddIcon (inherited from ExpListModel) Returns icon for the add action.
GetAddIconAlt (inherited from ExpListModel) Returns the alt text for the add icon.
GetAddLabel (inherited from ExpListModel) Returns the String to display next to the add icon.
GetAlertMessageForEmptyList (inherited from ExpListModel) Returns the message to display by the JavaScript when the list is empty.
GetArrayOfObjToDelete (inherited from ExpListModel) ROB: Make the available for other models.
GetArrExpListColInfo (inherited from ExpListModel) Returns the array of column titles, associated column IDs and column width.
GetColumnWidth Helper method to get the width of a column.
GetCurrentLowerObjectCount (inherited from ExpListModel) 
GetCurrentUpperObjectCount (inherited from ExpListModel) 
GetDeleteIcon (inherited from ExpListModel) Returns icon for the delete action.
GetDeleteIconAlt (inherited from ExpListModel) Returns the alt text for the delete icon.
GetDelRowConfirmMsg (inherited from ExpListModel) JF- Returns the confirmation message to display when the user tries to delete a row.
GetEmptyListInstructions (inherited from ExpListModel) Returns the secondary String to display when the String is empty. (Should give instructions to the user on what to do).
GetEmptyListMainMessage (inherited from ExpListModel) Returns the main String to diplay when the list is empty.
GetEnableMoveRowActions (inherited from ExpListModel) Returns true if the move up and down buttons should be displayed. (use GetHTMLForMoveRowActions in ExpListView to dsiplay the HTMl on each row)
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetIsListReadOnly (inherited from ExpListModel) Returns the value of the m_bIsReadOnly member variable. If this is true, the user will not be able to perform any action on the list.
GetItems (inherited from ExpListModel) Returns the array of data.
GetListKey (inherited from ExpListModel) Returns the key of the expandable list. (This key is used to avoid conflicts when there are multiple lists on the same page.)
GetListValues (inherited from MultiColumnListModel) This method should ge used by the client to get back the array of values at the end of the Editor and store them.
GetMainColumnSort (inherited from ExpListModel) Returns the column ID of the primary sorted column. (the array can be sorted by multiple columns)
GetMainColumnSortDirection (inherited from ExpListModel) Returns the sort direction of the primary sorted column.
GetModelStorageName (inherited from ExpListModel) Returns the storage key of this Model.
GetName Returns the Class name.
GetNumColumns (inherited from MultiColumnListModel) Returns the numColumns.
GetNumObjects (inherited from ExpListModel) 
GetNumVisibleColumns This returns the number of visible columns, as opposed to the number of data columns.
GetPaginationSize (inherited from ExpListModel) 
GetReadOnlyItems (inherited from ExpListModel) Returns a read-only interface of the data.
GetRowIcon (inherited from MultiColumnListModel) Returns the icon to display on each row before the input text. If the value is null, no icon is displayed.
GetSectionTitle (inherited from ExpListModel) Returns the section title.
GetTableInstructions (inherited from ExpListModel) JF- Returns table intructions
GetType (inherited from Object)Gets the Type of the current instance.
GetUniqueInt (inherited from ExpListModel) Creates dynamically a unique int and returns it. This method can be used for repost actions for example. This is to make sure that if there are more than one expandable list on the same dislpay page, there won't be any conflict between the two lists.
GetUniqueString (inherited from ExpListModel) Creates dynamically a unique name with the list key and returns it. This is to make sure that if there are more than one expandable list on the same dislpay page, there won't be any conflict between the two lists. This method should be used to create unique input names. It can also be used for JavaScript function names (other than postToSelf - for this one you just need to use the GetUniqueInt method to make sure your repost actions and other int values are unique).
GetUnusedProperties (inherited from ExpListModel) 
GetWrapColumnHeaders (inherited from ExpListModel) JF- Returns the wrap attribute for the column headers.
Init (inherited from EditorHelperModel) Inits the Model with the Activity Space.
InitializeExpandableList (inherited from ExpListModel) Initializes the expandable list.
InitializeMetaDataList Initializes the expandable meta data list. This list keeps track of 2 kinds of data, visible data and non-visible data. Most of the inputs to this method are arrays of the same length as the number of visible columns (I.E. Columns that display and need a column header). The exception is the column visibility array, which should be the same length as the number of total columns (data + visible). The data in the visible columns will be used to sort the rows, and will be displayed by default. This data should be Strings. Use a custom List View to display different values. All the visible columns should come first, and then the data only columns should come afterwards. This helps us to sort correctly. Non-visible column data can be of any object type.
InitializeMultiColumnList (inherited from SortedMultiColumnListModel)Overloaded. Initializes the expandable list.
InitializeMultiColumnList (inherited from MultiColumnListModel)Overloaded. Initializes the expandable list.
InitializeReadOnlyExpandableList (inherited from ExpListModel) Initializes the read-only expandable list.
InitializeSortedArray (inherited from SortedMultiColumnListModel) Initalizes the list (PTGrowableSortedArrayWrapper) with a column mapping and a sort array. The growable array will always be sorted by the 1st column ascending.
IsAddButtonDisabled (inherited from ExpListModel) DCA - Check if add button is to be displayed
IsCheckBoxesDisabled (inherited from ExpListModel) DCA - Check to see if check boxes has been disabled.
IsPaginationEnabled (inherited from ExpListModel) Returns true if the pagination is enabled for this expandable list.
ModifyRow (inherited from ExpListModel) Action for modifying a row
MoveRow (inherited from ExpListModel) Gets the row index back and the move action back. Then perform the associated action.
ReverseCurrentSort (inherited from ExpListModel) Reverses the sort of the primary sorted column.
SaveSection (inherited from ExpListModel) Saves the data when a repost occurs. Editors using this framework need to call that method from the savePage method of the main Model.
SetAddIcon (inherited from ExpListModel) The delete icon will be set by default to add.gif. Use that method if you want to change it.
SetAddIconAlt (inherited from ExpListModel) Sets the value of the alt text for the add icon. This is optional, by default this is set to empty String.
SetDefaultValue (inherited from MultiColumnListModel) Sets a new default value. By default this is an array of empty strings. This value is used on add to populate the input text of the newly added row.
SetDeleteIcon (inherited from ExpListModel) The delete icon will be set by default to delete.gif. Use that method if you want to change it.
SetDeleteIconAlt (inherited from ExpListModel) Sets the value of the alt text for the delete icon. This is optional, by default this is set to empty String.
SetDelRowConfirmMsg (inherited from ExpListModel) JF- Sets the confirmation message to display when the user tried to delete a row.
SetEmptyListMessages (inherited from ExpListModel) Sets messages to display when the list is empty.
SetEnableEmptyListClientValidation (inherited from ExpListModel) Enable the JavaScript validation to ensure that the list is not empty. The String in argument will be displayed by the JavaScript alert. And the String returned is the JavaScript name that should be registered for validation in the Editor. The name returned will be prefixed with the Expandable List key to avoid conflicts.
SetEnableMoveRowActions (inherited from ExpListModel) Set this flag to true if you want to display the move up and down buttons at the end of each row. Warning: if this is set to true, then the sort by column will NOT be available anymore.
SetFormDataKeys (inherited from MultiColumnListModel) Sets the base name for the form data items in each column.
SetIsListReadOnly (inherited from ExpListModel) Changes the value of the m_bIsReadOnly member variable. If the list is read only, no action will be displayed in the action bar.
SetListKey (inherited from ExpListModel) Sets a new value for this list key.
SetNumColumns (inherited from MultiColumnListModel) Sets the numColumns.
SetPagination (inherited from ExpListModel) 
SetRowIcon (inherited from MultiColumnListModel) Sets the icon to display on each row before the input text. By default, no icon is displayed.
SetSectionTitle (inherited from ExpListModel) Sets the section title.
SetTableInstructions (inherited from ExpListModel) JF- Sets table intructions.
SetWrapColumnHeaders (inherited from ExpListModel) JF- Sets the wrap cell attribute for the column headers. Is true by default.
SortByColumn (inherited from ExpListModel) Gets the column ID back from the form data and resort the array by that column ID, ascending.
ToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Fields

m_arrDefaultValue (inherited from MultiColumnListModel) This is used on add to populate the input text of the newly added row. Note, it MUST be initialized explicitly by the client.
m_arrExpListColInfo (inherited from ExpListModel) Array of column titles, associated column IDs and column width
m_arrFormDataKeys (inherited from MultiColumnListModel) The names of the form items for each column.
m_bAddButtonDisabled (inherited from ExpListModel) DCA - Variable to show add button or not.
m_bCheckBoxesDisabled (inherited from ExpListModel) DCA - Variable to show check boxes or not.
m_bEnableMoveRowActions (inherited from ExpListModel) Set this flag to true if you want to display the move up and down buttons at the end of each row. Warning: if this is set to true, then the sort by column will NOT be available anymore. You can't have both it doesn't make sense.
m_bIsReadOnly (inherited from ExpListModel) Special mode to have a read-only expandable list: all actions are hidden.
m_bWrapColumnHeaders (inherited from ExpListModel) JF- Wrap attribute for the column headers
m_imgAddIcon (inherited from ExpListModel) The add icon.
m_imgDeleteIcon (inherited from ExpListModel) The delete icon.
m_imgRowIcon (inherited from MultiColumnListModel) Icon to display on each row, just before the input text.
m_nDefaultSortColumn (inherited from SortedMultiColumnListModel) Zero based column id for the default column to sort by.
m_nListKey (inherited from ExpListModel) This key is used when there is more than one expandable list on the same Display Page.
m_nNumVisibleColumns 
m_saData (inherited from ExpListModel) This is where we store the data displayed on the list. We are taking advantage of the sorting features offered by the Array Wrapper framework.
m_sAddIconAlt (inherited from ExpListModel) Alt text for the add icon.
m_sAddLabel (inherited from ExpListModel) Text to display next to the add icon.
m_sDeleteIconAlt (inherited from ExpListModel) Alt text for the delete icon.
m_sDelRowConfirmMsg (inherited from ExpListModel) JF- COnfirmation message to display when the user deletes a row.
m_sEmptyListAlert (inherited from ExpListModel) Message to display as a JavaScript alert if the list is empty.
m_sInstructions (inherited from ExpListModel) Instructions to display when the list is empty.
m_sMainMessage (inherited from ExpListModel) Main message to display when the list is empty (in red).
m_sSectionTitle (inherited from ExpListModel) The section main title.
m_sTableInstructions (inherited from ExpListModel) JF- List instructions.
parent (inherited from ExpListModel) Associated AS class

Protected Instance Methods

Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
GetMoveAction (inherited from ExpListModel) Helper method to retrieve the move action type from the form data.
GetRowIndex (inherited from ExpListModel) Helper method to retrieve the row index from the form data.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.
MoveDown (inherited from ExpListModel) Moves the row identified by the index in argument, one row down. The idea is that we are going to change the value of the index column. We just need to swap that value with the one of the row just after.
MoveFirst (inherited from ExpListModel) Moves the row identified by the index in argument, to the top of the list.
MoveLast (inherited from ExpListModel) Moves the row identified by the index in argument, to the last position of the list.
MoveUp (inherited from ExpListModel) Moves the row identified by the index in argument, one row up. The idea is that we are going to change the value of the index column. We just need to swap that value with the one of the previous row.
SaveRow (inherited from MultiColumnListModel) Saves the data on the row _nRowIndex.

See Also

SortedMetaDataListModel Class | com.plumtree.uiinfrastructure.expandablelist.multicolumnlist.sortedmetadata Namespace