Plumtree Portal UI  
 

PTMultiColumnListModel Methods

The methods of the PTMultiColumnListModel class are listed below. For a complete list of PTMultiColumnListModel class members, see the PTMultiColumnListModel Members topic.

Public Static Methods

ParseFields Parses the string of mapped fields and returns a two dimensional array in the format expected by the Plumtree server

Public Instance Methods

AddControlParamsToURL Helper function for extracting and adding extra control parameters from the create object string.
AddRowsOnRepost Clear the list and add all the values selected from the tree, as well as values or defaults for the other columns in the control.
AddRowsToList Adds an array of new rows to the list. This is only called when m_bIncludePTSelect is FALSE.
CleanupAllData (inherited from com.plumtree.uiinfrastructure.editor.EditorHelperModel) 
CleanupTempData (inherited from com.plumtree.uiinfrastructure.editor.EditorHelperModel) 
ContainsObject Tells whether the Object identified by the class ID and the object ID in argument is in the list or no.
Create 
DeleteRowsOnRepost (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
DisableAddButton (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
DisableCheckBoxes (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
DoTaskOnComeBackFromSubEditor This method will be called when you come back to the main Editor from a sub Editor.
EnablePagination (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetAccessLevel Returns the accesslevel of the objects for the tree control to display.
GetAddIcon (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetAddIconAlt (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetAddLabel (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetAlertMessageForEmptyList (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetArrayOfObjToDelete (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetArrExpListColInfo (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetCreateNewInfo Returns the create new actions information.
GetCreateNewURL Returns the URL to the Editor in create mode (new object).
GetCurrentLowerObjectCount (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetCurrentUpperObjectCount (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetDeleteIcon (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetDeleteIconAlt (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetDelRowConfirmMsg (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetDisplayObjects Returns the array of objects to display in the tree.
GetEditObjectURL Returns the URL to edit the object.
GetEditRow Returns the row currently being edited.
GetEmptyListInstructions (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetEmptyListMainMessage (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetEnableMoveRowActions (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
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.
GetHiddenObjects Returns the comma-delimited string of classids and objectids for objects that are to be hidden by the tree. The format of the string is as follows: ClassID1,ObjectID1, ClassID2,ObjectID2, etc..
GetIncludePTSelect Returns true if this list includes a Plumtree object selected from the tree object selector.
GetIsListReadOnly (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetItems (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetListKey (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetListValues This method should ge used by the client to get back the array of values other than the 3 columns used for the Plumtree selected object (ObjectID, ClassID, and Name) at the end of the Editor and store them. It should only be called in cases where there are columns other than the Plumtree object columns (i.e. m_intNumColumns > 0)
GetMainColumnSort (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetMainColumnSortDirection (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetModelStorageName (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetName Returns the Class name.
GetNumColumns Returns the number of columns other than the columns used by the Plumtree selected object.
GetNumObjects (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetObjectClassIDs Returns String of Class ID of the Objects displayed in the tree. E.g.: "2,45,3" This is the format used by the tree.
GetPaginationSize (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetPTObjectPosition Returns the zero-based display position of the selected Plumtree object, if applicable.
GetReadOnlyItems (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetRowIcon Returns the icon to display on each row before the input text. If the value is null, no icon is displayed.
GetSectionTitle (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetSelectedItems Returns a String of Class IDs and Object IDs of the Objects to select in the tree. E.g.: "classID1,ObjID1,classID2,objID2" This is the format used by the tree.
GetTableInstructions (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetTreeLeafType Returns the leaf type of the tree.
GetTreeMultiSelect Returns the selection type of the tree. Converts the boolean value to a string so that it can be put in the query string for the tree.
GetTreeQueryFilter Returns the query filter for the tree.
GetTreeSpaceID Returns tree AS ID.
GetTreeSubTitle Returns the Tree sub title.
GetTreeTitle Returns the Tree title.
GetType (inherited from Object)Gets the Type of the current instance.
GetUniqueInt (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetUniqueString (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetUnusedProperties (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetWrapColumnHeaders (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
Init (inherited from com.plumtree.uiinfrastructure.editor.EditorHelperModel) 
InitializeExpandableList (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
InitializePTMultiColumnList Initializes the expandable list.
InitializeReadOnlyExpandableList (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
InitializeSortedArray Initalizes the list (PTGrowableSortedArrayWrapper) with a column mapping and an array of sort. The growable array will always be sorted by the 1st column ascending.
IsAddButtonDisabled (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
IsCheckBoxesDisabled (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
IsEditLinkEnabled Returns true if it should be possible to edit Objects from this class ID.
IsPaginationEnabled (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
ModifyRow Action for modifying a row
MoveRow (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
ReverseCurrentSort (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SaveSection (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SetAccessLevel Sets the accesslevel of the objects for the tree control to display.
SetAddIcon (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SetAddIconAlt (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SetDefaultObjects Add the array passed in argument to the list. The array should be created using the EXPLIST_COL constants defined in this class.
SetDefaultValue 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 com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SetDeleteIconAlt (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SetDelRowConfirmMsg (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SetDisplayObjects Sets the array of objects to display in the tree. (Only those objects will be display in the tree.) The array in argument should be in the following format: classid1,objectid1,classid2,objectid2....
SetEditRow Sets the row currently being edited.
SetEmptyListMessages (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SetEnableCreateNew Enables the create new links for the Class ID in argument. Doing this will also enbale the links to Edit the Objects in the list.
SetEnableEmptyListClientValidation (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SetEnableMoveRowActions Because this select ptobject list needs to support both move row actions enable and disable, we need to change the colspan of the header row when this happens.
SetHiddenObjects Populates m_strObjectsToHide, a comma-delimited list of classid/objectid pairs. The format of the string is as follows: ClassID1,ObjectID1, ClassID2,ObjectID2, etc..
SetIncludePTSelect Sets the value for m_bIncludePTSelect, indicating whether a Plumtree object selector should be included with this list.
SetIsListReadOnly (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SetListKey (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SetNumColumns Returns the number of columns other than the columns used by the Plumtree selected object.
SetPagination (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SetPTObjectPosition Sets the the zero-based display position of the selected Plumtree object, if applicable.
SetRowIcon Sets the icon to display on each row before the input text. By default, no icon is displayed.
SetSectionTitle (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SetTableInstructions (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SetTreeLeafType Sets the leaf type for the tree. Is set to N_LEAFSELECT by default.
SetTreeMultiSelect Sets the selection type for the tree. Multiselect is set to true by default.
SetTreeQueryFilter Sets the query filter for the tree. By default there is no query filter.
SetTreeSubTitle Sets the Tree sub title.
SetTreeTitle Sets the Tree title.
SetWrapColumnHeaders (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SortByColumn (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
ToString (inherited from Object)Returns a String that represents the current Object.

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 com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetRowIndex (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.
MoveDown (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
MoveFirst (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
MoveLast (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
MoveUp (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SaveRow Saves the data for columns other than the plumtree object select column on the row _nRowIndex.
SaveTreeID Helper method to save the Tree ID on repost.

See Also

PTMultiColumnListModel Class | com.plumtree.portaluiinfrastructure.ptmulticolumnlist Namespace