com.plumtree.portalpages.portlets.savedsearch.prefs
Class SavSrchDisplayFieldsListModel

java.lang.Object
  extended by com.plumtree.uiinfrastructure.editor.EditorHelperModel
      extended by com.plumtree.uiinfrastructure.expandablelist.ExpListModel
          extended by com.plumtree.portaluiinfrastructure.expandablelist.selectptobject.SelectPTObjectModel
              extended by com.plumtree.portalpages.portlets.savedsearch.prefs.SavSrchDisplayFieldsListModel
All Implemented Interfaces:
ISavSrchDisplayFieldsListModelRO, ISelectPTObjectModelRO, IManagedObject, IModel, IModelRO, IMVCObject, IExpListModelRO, IPaginationModel, IPaginationModelRO

public class SavSrchDisplayFieldsListModel
extends SelectPTObjectModel
implements ISavSrchDisplayFieldsListModelRO

Author:
joseq This explist expends the SelectPTObjectModel to include a 5th element to the data array which holds the orientation of the field (column or row).

Field Summary
static int EXPLIST_COL_MAX
          Number total of columns
static int EXPLIST_COL_ORIENTATION
          This is the column that holds the display orientation option (column/row) that we doisplay in the list.
static java.lang.String ORIENTATION_COL
           
static java.lang.String ORIENTATION_ROW
           
static java.lang.String STR_MVC_CLASS_NAME
          Class name for the activity space
 
Fields inherited from class com.plumtree.portaluiinfrastructure.expandablelist.selectptobject.SelectPTObjectModel
CREATE_NEW_COL_ASNAME, CREATE_NEW_COL_CLASSID, CREATE_NEW_COL_ICON, CREATE_NEW_COL_LABEL, CREATE_NEW_COL_MAX, CREATE_NEW_COL_MAXWITHPARAMS, CREATE_NEW_COL_PARAMS, EXPLIST_COL_CLASSID, EXPLIST_COL_OBJECTID, EXPLIST_COL_STRING, EXPLIST_DEFAULT_INITIAL_SIZE, HIDE_COL_CLASSID, HIDE_COL_MAX, HIDE_COL_OBJECTID, m_arrCreateNewInfo, m_arrObjectClassIDs, m_arrReadOnlyObjects, m_bNoRowIcons, m_bTreeMultiSelect, m_imgDefaultRowIcon, m_nAccessLevel, m_nCommunityFolderID, m_nCommunityMode, m_sDisplayObjects, m_sTreeSpaceID, m_sTreeSubTitle, m_sTreeTitle, m_strObjectsToHide, m_strTreeQueryFilter, m_treeLeafType, m_xphtRowIcons, PARAM_COL_PARAMNAME, PARAM_COL_PARAMVALUE, READ_ONLY_ROW_CLASSID, READ_ONLY_ROW_OBJECTID, SUBSPACE_KEY_SELECTTREE
 
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
SavSrchDisplayFieldsListModel()
           
 
Method Summary
 void AddRowsOnRepost(XPHashtable _htFormData)
          Clear the list and add all the values from the tree.
 java.lang.Object Create()
          This method is used by the ASManager to return new instances of managed objects.
 java.lang.String GetName()
          Returns the Class name.
 void InitializeReadOnlySelectPTObject(java.lang.String _sSectionTitle, java.lang.String _sSectionSubTitle, int[] _arrObjectClassIDs, int _nListKey)
          Initializes the read only expandable list.
 void InitializeSelectPTObject(java.lang.String _sSectionTitle, java.lang.String _sSectionSubTitle, PTImageType _imgAddIcon, java.lang.String _sAddLabel, int[] _arrObjectClassIDs, int _nListKey)
          Initializes the expandable list.
 void InitializeSortedArray(PTGrowableSortedArrayWrapper _saData)
          Initalizes the list (PTGrowableSortedArrayWrapper) with a column mapping and an array of sort.
 boolean IsOrientationRow(int _iRowIndex)
           
 void ModifyRow(XPHashtable _htFormData)
          Action for modifying a row
 
Methods inherited from class com.plumtree.portaluiinfrastructure.expandablelist.selectptobject.SelectPTObjectModel
AddControlParamsToURL, ClearHiddenObjects, ContainsObject, CreateIndexMapping, DoTaskOnComeBackFromSubEditor, GetAccessLevel, GetCommunityFolderID, GetCommunityMode, GetCreateNewInfo, GetCreateNewURL, GetDefaultRowIcon, GetDisplayObjects, GetEditObjectURL, GetHiddenObjects, GetIndex, GetNoRowIcons, GetObjectClassIDs, GetRowIconByClassID, GetSelectedItems, GetSelectedNamesAsHTML, GetTreeLeafType, GetTreeMultiSelect, GetTreeQueryFilter, GetTreeSpaceID, GetTreeSubTitle, GetTreeTitle, GetUniquePopUpName, InitializeListClassIDs, IsEditLinkEnabled, IsObjectReadOnly, ResetTreeID, SaveRow, SaveTreeID, SetAccessLevel, SetCommunityFolderID, SetCommunityMode, SetDefaultObjects, SetDefaultRowIcon, SetDisplayObjects, SetEnableCreateNew, SetEnableMoveRowActions, SetHiddenObjects, SetNoRowIcons, SetReadOnlyObjects, SetRowIconByClassID, SetTreeLeafType, SetTreeMultiSelect, SetTreeQueryFilter, SetTreeSubTitle, SetTreeTitle
 
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, MoveDown, MoveFirst, MoveLast, MoveRow, MoveUp, ReverseCurrentSort, SaveSection, SetAddIcon, SetAddIconAlt, SetDeleteIcon, SetDeleteIconAlt, SetDelRowConfirmMsg, SetEmptyListMessages, SetEnableEmptyListClientValidation, 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

EXPLIST_COL_MAX

public static final int EXPLIST_COL_MAX
Number total of columns

See Also:
Constant Field Values

EXPLIST_COL_ORIENTATION

public static final int EXPLIST_COL_ORIENTATION
This is the column that holds the display orientation option (column/row) that we doisplay in the list.

See Also:
Constant Field Values

ORIENTATION_ROW

public static final java.lang.String ORIENTATION_ROW
See Also:
Constant Field Values

ORIENTATION_COL

public static final java.lang.String ORIENTATION_COL
See Also:
Constant Field Values
Constructor Detail

SavSrchDisplayFieldsListModel

public SavSrchDisplayFieldsListModel()
Method Detail

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 SelectPTObjectModel
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 SelectPTObjectModel
Returns:
String

InitializeReadOnlySelectPTObject

public void InitializeReadOnlySelectPTObject(java.lang.String _sSectionTitle,
                                             java.lang.String _sSectionSubTitle,
                                             int[] _arrObjectClassIDs,
                                             int _nListKey)
Initializes the read only expandable list.

Overrides:
InitializeReadOnlySelectPTObject in class SelectPTObjectModel
Parameters:
_sSectionTitle - Main title.
_sSectionSubTitle - Sub title
_arrObjectClassIDs - Class ID of the Objects displayed on the list.
_nListKey - In case you have multiple Expandable Lists on the same DP, they should have a different key (otherwise, just set it to 1).

InitializeSelectPTObject

public void InitializeSelectPTObject(java.lang.String _sSectionTitle,
                                     java.lang.String _sSectionSubTitle,
                                     PTImageType _imgAddIcon,
                                     java.lang.String _sAddLabel,
                                     int[] _arrObjectClassIDs,
                                     int _nListKey)
Initializes the expandable list.

Overrides:
InitializeSelectPTObject in class SelectPTObjectModel
Parameters:
_sSectionTitle - Main title.
_sSectionSubTitle - Sub title
_imgAddIcon - Icon for the add action.
_sAddLabel - Text to display next to the add icon.
_arrObjectClassIDs - Class ID of the Objects displayed on the list.
_nListKey - In case you have multiple Expandable Lists on the same DP, they should have a different key (otherwise, just set it to 1).

InitializeSortedArray

public void InitializeSortedArray(PTGrowableSortedArrayWrapper _saData)
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.

Overrides:
InitializeSortedArray in class SelectPTObjectModel
Parameters:
_saData -

AddRowsOnRepost

public void AddRowsOnRepost(XPHashtable _htFormData)
Clear the list and add all the values from the tree.

Overrides:
AddRowsOnRepost in class SelectPTObjectModel
Parameters:
_htFormData - Form data

ModifyRow

public void ModifyRow(XPHashtable _htFormData)
Description copied from class: ExpListModel
Action for modifying a row

Overrides:
ModifyRow in class ExpListModel

IsOrientationRow

public boolean IsOrientationRow(int _iRowIndex)
Specified by:
IsOrientationRow in interface ISavSrchDisplayFieldsListModelRO



Copyright © 2002,2003,2004,2005 Plumtree Software, Inc., All Rights Reserved.