Plumtree Portal UI  
 

SelectPTObjectModel Members

SelectPTObjectModel overview

Public Static Fields

CREATE_NEW_COL_ASNAME Create new array column: AS Name
CREATE_NEW_COL_CLASSID Create new array column: class ID
CREATE_NEW_COL_ICON Create new array column: icon to display for the create new link
CREATE_NEW_COL_LABEL Create new array column: text to display with the create new link
CREATE_NEW_COL_MAX Size of each m_arrCreateNewInfo row
CREATE_NEW_COL_MAXWITHPARAMS Size of each m_arrCreateNewInfo row with optional control parameters.
CREATE_NEW_COL_PARAMS Create new array column: extra control arguments for the create action. Use CREATE_NEW_COL_MAXWITHPARAMS to set the size of the array when using this element.
EXPLIST_COL_CLASSID This column contains the Object Class IDs.
EXPLIST_COL_MAX Number total of columns
EXPLIST_COL_OBJECTID This column contains the Object IDs.
EXPLIST_COL_STRING This is the String that we doisplay in the list. E.g.: Object name or folder path.
EXPLIST_DEFAULT_INITIAL_SIZE Default initial size for the sorted array.
HIDE_COL_CLASSID This column of the passed Objects to Hide contains the class IDs.
HIDE_COL_MAX Number total of columns for hide objects array.
HIDE_COL_OBJECTID This column of the passed Objects to Hide contains the object IDs.
PARAM_COL_PARAMNAME Optional control parameter index for the parameter name. Used in the create new array column: icon to display for the create new link
PARAM_COL_PARAMVALUE Optional control parameter index for the parameter value. Used in the create new array column: icon to display for the create new link
READ_ONLY_ROW_CLASSID JF- Array of read-only objects: column index for classID.
READ_ONLY_ROW_OBJECTID JF- Array of read-only objects: column index for objectID.
STR_MVC_CLASS_NAME Class name for the activity space
SUBSPACE_KEY_SELECTTREE Key name used by the Activity Space to store the tree.

Public Instance Constructors

SelectPTObjectModel Constructor Initializes a new instance of the SelectPTObjectModel class.

Public Instance Fields

m_asOwner (inherited from com.plumtree.uiinfrastructure.editor.EditorHelperModel) 
m_nNextIndex (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 

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 from the tree.
CleanupAllData (inherited from com.plumtree.uiinfrastructure.editor.EditorHelperModel) 
CleanupTempData (inherited from com.plumtree.uiinfrastructure.editor.EditorHelperModel) 
ClearHiddenObjects Clears the hidden objects for the tree.
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 nAccessLevel. 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) 
GetCommunityFolderID Returns the community id for the tree.
GetCommunityMode Returns the community mode for the tree.
GetCreateNewInfo Returns the create new action informations.
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) 
GetDefaultRowIcon Returns the icon to display on each row before the input text. If the value is null, no icon is displayed.
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.
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 hidden objects for the tree.
GetIsListReadOnly (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetItems (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetListKey (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
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.
GetNoRowIcons Returns the value of the m_bNoRowIcons member variable. True if no icons are to be displayed on each selected row.
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) 
GetReadOnlyItems (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
GetRowIconByClassID Returns the icon to display on each row before the input text, given a class id. If the value is null then we get the default row icon.
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.
GetSelectedNamesAsHTML Helper method to get a String with the selected Object names. E.g.: User1, User2, Group1 Will return an empty String if no Object was selected.
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) 
GetUniquePopUpName Returns a unique String for the name of the pop-up.
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) 
InitializeListClassIDs Partialally initializes the expandable list. InitializeExpandableList must also be called when this method is used.
InitializeReadOnlyExpandableList (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
InitializeReadOnlySelectPTObject Initializes the read only expandable list.
InitializeSelectPTObject Initializes the expandable list.
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.
IsObjectReadOnly Returns true if the object identified by the class id and the object id in argument is read only.
IsPaginationEnabled (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
ModifyRow (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
MoveRow (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
ResetTreeID Resets the tree ID, this way a new tree will be opened. This can be used to switch from a multi select tree to a single select tree for example.
ReverseCurrentSort (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SaveSection (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SetAccessLevel Sets the nAccessLevel. 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) 
SetCommunityFolderID Sets the community folder id for the tree. By default there is no community folder id.
SetCommunityMode Sets the community mode for the tree. By default there is no community mode.
SetDefaultObjects Add the array passed in argument to the list. The array should be created using the EXPLIST_COL constants defined in this class.
SetDefaultRowIcon Sets the icon to display on each row before the input text. By default, no icon is displayed.
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....
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 Sets the hidden objects for the tree. By default there are no hidden objects.
SetIsListReadOnly (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SetListKey (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SetNoRowIcons Sets the m_bNoRowIcons member variable. True if no icons are to be displayed on each selected row.
SetPagination (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
SetReadOnlyObjects Sets the read only objects. Those object won't appear in the tree and the user will not be able to delete them.
SetRowIconByClassID Sets the icon to display on each row before the input text, given a class id. By default, all class ids are associated with empty images. Call SetDefaultRowIcon to set a universal default icon.
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 Fields

m_arrCreateNewInfo Information about the create new links to display
m_arrExpListColInfo (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_arrObjectClassIDs Class ID of the Objects displayed on the list.
m_arrReadOnlyObjects JF- Array of classID/objectID that cannot be deleted from the list.
m_bAddButtonDisabled (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_bCheckBoxesDisabled (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_bEnableMoveRowActions (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_bIsReadOnly (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_bNoRowIcons JH: Set to true if no row icons are to be displayed. This will override m_xphtRowIcons, m_imgDefaultRowIcon, and the default ClassDescriptor icon retrieval mechanism.
m_bTreeMultiSelect Selection type for the object tree.
m_bWrapColumnHeaders (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_imgAddIcon (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_imgDefaultRowIcon Icon to display on each row, just before the input text. RWW: This will now be the "default". See m_xphtRowIcons for precedence in icon loading.
m_imgDeleteIcon (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_nAccessLevel This value determines the security access requirements for the objects to be added to the list... (a filter for the tree control).
m_nCommunityFolderID Community Folder ID to display objects from.
m_nCommunityMode Community Mode to display objects.
m_nListKey (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_saData (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_sAddIconAlt (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_sAddLabel (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_sDeleteIconAlt (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_sDelRowConfirmMsg (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_sDisplayObjects Class IDs and Object IDs of objects to display in the tree.
m_sEmptyListAlert (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_sInstructions (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_sMainMessage (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_sSectionTitle (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_sTableInstructions (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 
m_sTreeSpaceID Tree Space ID. The first time the ID is empty and a new AS is opened, but after that, we save the ID and the same tree AS is reopened each time.
m_sTreeSubTitle Tree sub title
m_sTreeTitle Tree title
m_strObjectsToHide Objects to hide for the object tree.
m_strTreeQueryFilter Query Filter for the object tree.
m_treeLeafType Leaf type for the object tree.
m_xphtRowIcons RWW: Stores multiple icons - allows us to store a different icon for each class id. When retrieving icons internally, this table will be checked first. If no icons appear here, then we will check the default row icon. If that is null, then we will show no image. Having an icon for a specific class id in this table will take precedence.
parent (inherited from com.plumtree.uiinfrastructure.expandablelist.ExpListModel) 

Protected Instance Methods

CreateIndexMapping Helper method to create a temporary array of index mapping. On each row we have the following info: class ID - Object ID - index This method is used to not loose the order when the move row actions are enabled.
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.
GetIndex Helper method to get the value of the index for the object identified by the object ID and class ID in argument. Returns -1 if the object was not in the array.
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 on the row _nRowIndex.
SaveTreeID Helper method to save the Tree ID on repost.

See Also

SelectPTObjectModel Class | com.plumtree.portaluiinfrastructure.expandablelist.selectptobject Namespace