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

java.lang.Object
  com.plumtree.uiinfrastructure.editor.EditorHelperModel
      com.plumtree.uiinfrastructure.expandablelist.ExpListModel
          com.plumtree.uiinfrastructure.expandablelist.multicolumnlist.MultiColumnListModel
              com.plumtree.uiinfrastructure.expandablelist.multicolumnlist.sorted.SortedMultiColumnListModel
                  com.plumtree.uiinfrastructure.expandablelist.multicolumnlist.sortedmetadata.SortedMetaDataListModel

All Implemented Interfaces:

IManagedObject, IModel, IModelRO, IMVCObject, IExpListModelRO, IMultiColumnListModelRO, IPaginationModel, IPaginationModelRO

public class SortedMetaDataListModel
extends SortedMultiColumnListModel

This list model allows you to sort by meta data, rather than the actual HTML displayed, allowing you to add images and descriptions to row entries without affecting sort order. This list is currently read only.

Author:

DonH

Field Summary

protected int	m_nNumVisibleColumns
static java.lang.String	STR_MVC_CLASS_NAME Class name for the activity space

Fields inherited from class com.plumtree.uiinfrastructure.expandablelist.multicolumnlist.sorted.SortedMultiColumnListModel

m_nDefaultSortColumn

Fields inherited from class com.plumtree.uiinfrastructure.expandablelist.multicolumnlist.MultiColumnListModel

m_arrDefaultValue, m_arrFormDataKeys, m_imgRowIcon, m_intNumColumns

Fields inherited from class com.plumtree.uiinfrastructure.expandablelist.ExpListModel

EXPLIST_COLUMN_COLSPAN, EXPLIST_COLUMN_ENABLESORT, EXPLIST_COLUMN_ID, EXPLIST_COLUMN_INVALID, EXPLIST_COLUMN_TITLE, EXPLIST_COLUMN_WIDTH, EXPLIST_SORTEDARRAY_PROPID_INDEX, m_arrExpListColInfo, m_bAddButtonDisabled, m_bCheckBoxesDisabled, m_bEnableMoveRowActions, m_bIsReadOnly, m_bWrapColumnHeaders, m_imgAddIcon, m_imgDeleteIcon, m_nListKey, m_nNextIndex, m_saData, m_sAddIconAlt, m_sAddLabel, m_sDeleteIconAlt, m_sDelRowConfirmMsg, m_sEmptyListAlert, m_sInstructions, m_sMainMessage, m_sSectionTitle, m_sTableInstructions, MAX_ROWS, MOVEACTION_DOWN, MOVEACTION_FIRST, MOVEACTION_LAST, MOVEACTION_UP, parent

Fields inherited from class com.plumtree.uiinfrastructure.editor.EditorHelperModel

m_asOwner

Constructor Summary

SortedMetaDataListModel()

Method Summary

java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
java.lang.String	GetColumnWidth(int _nVisibleColumnIndex) Helper method to get the width of a column.
java.lang.String	GetName() Returns the Class name.
int	GetNumVisibleColumns() This returns the number of visible columns, as opposed to the number of data columns.
void	InitializeMetaDataList(java.lang.String _sListTitle, java.lang.String[] _sColumnHeaders, java.lang.String[] _sColumnWidth, java.lang.Boolean[] _bEnableSort, int _nDefaultSortColumn, int _nTotalColumns, int _nListKey) Initializes the expandable meta data list.

Methods inherited from class com.plumtree.uiinfrastructure.expandablelist.multicolumnlist.sorted.SortedMultiColumnListModel

InitializeMultiColumnList, InitializeSortedArray

Methods inherited from class com.plumtree.uiinfrastructure.expandablelist.multicolumnlist.MultiColumnListModel

AddRowsOnRepost, AddRowsToList, GetListValues, GetNumColumns, GetRowIcon, InitializeMultiColumnList, SaveRow, SetDefaultValue, SetFormDataKeys, SetNumColumns, SetRowIcon

Methods inherited from class com.plumtree.uiinfrastructure.expandablelist.ExpListModel

DeleteRowsOnRepost, DisableAddButton, DisableCheckBoxes, EnablePagination, GetAddIcon, GetAddIconAlt, GetAddLabel, GetAlertMessageForEmptyList, GetArrayOfObjToDelete, GetArrExpListColInfo, GetCurrentLowerObjectCount, GetCurrentUpperObjectCount, GetDeleteIcon, GetDeleteIconAlt, GetDelRowConfirmMsg, GetEmptyListInstructions, GetEmptyListMainMessage, GetEnableMoveRowActions, GetIsListReadOnly, GetItems, GetListKey, GetMainColumnSort, GetMainColumnSortDirection, GetModelStorageName, GetMoveAction, GetNumObjects, GetPaginationSize, GetReadOnlyItems, GetRowIndex, GetSectionTitle, GetTableInstructions, GetUniqueInt, GetUniqueString, GetUnusedProperties, GetWrapColumnHeaders, InitializeExpandableList, InitializeReadOnlyExpandableList, IsAddButtonDisabled, IsCheckBoxesDisabled, IsPaginationEnabled, ModifyRow, MoveDown, MoveFirst, MoveLast, MoveRow, MoveUp, ReverseCurrentSort, SaveSection, SetAddIcon, SetAddIconAlt, SetDeleteIcon, SetDeleteIconAlt, SetDelRowConfirmMsg, SetEmptyListMessages, SetEnableEmptyListClientValidation, SetEnableMoveRowActions, SetIsListReadOnly, SetListKey, SetPagination, SetSectionTitle, SetTableInstructions, SetWrapColumnHeaders, SortByColumn

Methods inherited from class com.plumtree.uiinfrastructure.editor.EditorHelperModel

CleanupAllData, CleanupTempData, Init

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.plumtree.uiinfrastructure.expandablelist.IExpListModelRO

GetAddIcon, GetAddIconAlt, GetAddLabel, GetAlertMessageForEmptyList, GetArrExpListColInfo, GetDeleteIcon, GetDeleteIconAlt, GetDelRowConfirmMsg, GetEmptyListInstructions, GetEmptyListMainMessage, GetEnableMoveRowActions, GetIsListReadOnly, GetListKey, GetMainColumnSort, GetMainColumnSortDirection, GetModelStorageName, GetReadOnlyItems, GetSectionTitle, GetTableInstructions, GetUniqueInt, GetUniqueString, GetUnusedProperties, GetWrapColumnHeaders, IsAddButtonDisabled, IsCheckBoxesDisabled, IsPaginationEnabled

Methods inherited from interface com.plumtree.uiinfrastructure.form.pagination.IPaginationModelRO

GetCurrentLowerObjectCount, GetCurrentUpperObjectCount, GetNumObjects, GetPaginationSize

Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IModel

CleanupAllData, CleanupTempData, Init

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

Class name for the activity space

See Also:

Constant Field Values

m_nNumVisibleColumns

protected int m_nNumVisibleColumns

Constructor Detail

SortedMetaDataListModel

public SortedMetaDataListModel()

Method Detail

InitializeMetaDataList

public void InitializeMetaDataList(java.lang.String _sListTitle,
                                   java.lang.String[] _sColumnHeaders,
                                   java.lang.String[] _sColumnWidth,
                                   java.lang.Boolean[] _bEnableSort,
                                   int _nDefaultSortColumn,
                                   int _nTotalColumns,
                                   int _nListKey)

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.

Parameters:

_sListTitle - List title.

_sColumnHeaders - The titles for each visible column

_sColumnWidth - The numeric width for each visible column (not percentage width). If left null for a column, that column will recieve an equal percentage of the remainder (100%).

_bEnableSort - Enable sort for each visible column

_nDefaultSortColumn - The zero based column id for the default visible column to sort by.

_nTotalColumsn - The total number of visible and data only columns.

_nListKey - In case you have multiple Expandable Lists on the same DP, they should have a different key (otherwise, just set it to 1).

GetColumnWidth

public java.lang.String GetColumnWidth(int _nVisibleColumnIndex)

Helper method to get the width of a column.

Parameters:

_nVisibleColumnIndex - The non-zero based column index.

Returns:

String The column width (can be an integer or %).

GetNumVisibleColumns

public int GetNumVisibleColumns()

This returns the number of visible columns, as opposed to the number of data columns.

Returns:

Create

public java.lang.Object Create()

Description copied from class: EditorHelperModel

This method is used by the ASManager to return new instances of managed objects.

Specified by:

Create in interface IManagedObject

Overrides:

Create in class SortedMultiColumnListModel

Returns:

A new instance of the managed class (i.e. return new Foo();)

See Also:

IManagedObject.Create()

GetName

public java.lang.String GetName()

Returns the Class name.

Specified by:

GetName in interface IMVCObject

Overrides:

GetName in class SortedMultiColumnListModel

Returns:

String