com.plumtree.portalpages.admin.ptutilities.condition
Class RulesListModel

java.lang.Object
  com.plumtree.uiinfrastructure.editor.EditorHelperModel
      com.plumtree.uiinfrastructure.expandablelist.ExpListModel
          com.plumtree.portaluiinfrastructure.expandablelist.selectptobject.SelectPTObjectModel
              com.plumtree.portalpages.admin.ptutilities.condition.RulesListModel

All Implemented Interfaces:

IRulesListModelRO, ISelectPTObjectModelRO, IManagedObject, IModel, IModelRO, IMVCObject, IExpListModelRO, IPaginationModel, IPaginationModelRO

public class RulesListModel
extends SelectPTObjectModel
implements IRulesListModelRO

Author:

DustinA

Field Summary

static int	EXPLIST_ACTIONNAME Action of Row
static int	EXPLIST_ACTIONVALUE Action of Row
static int	EXPLIST_DESCRIPTION Name of Row
static int	EXPLIST_NAME Name of Row
static int	EXPLIST_OBJECTID Name of Row
static int	RULES_PAGINATION_SIZE
static java.lang.String	STR_MVC_CLASS_NAME Object Name

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_MAX, 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

RulesListModel()

Method Summary

java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
void	DoTaskOnComeBackFromSubEditor() This method will be called when you come back to the main Editor from a sub Editor.
ASURL	GetEditObjectURL(int _nClassID, int _nObjectID, java.lang.String sEditorASName) Returns the URL to edit the object.
java.lang.String	GetName() Returns the Class name.
int	GetPaginationSize() This is the number of objects displayed per page.
PTImageType	GetRowIcon() Returns the icon to display on each row before the input text.
void	InitializeRulesList(java.lang.String _sSectionTitle, PTImageType _imgAddIcon, java.lang.String _sAddLabel, int[] _arrObjectClassIDs, java.lang.Object[][] arrExpListColInfo, int _nListKey) Initializes the expandable list.
void	InitializeSortedArray(PTGrowableSortedArrayWrapper _saData) Initalizes the list (PTGrowableSortedArrayWrapper) with a column mapping and an array of sort.
void	SetEnableMoveRowActions(boolean _bEnableMoveRowActions) 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.

Methods inherited from class com.plumtree.portaluiinfrastructure.expandablelist.selectptobject.SelectPTObjectModel

AddControlParamsToURL, AddRowsOnRepost, ClearHiddenObjects, ContainsObject, CreateIndexMapping, GetAccessLevel, GetCommunityFolderID, GetCommunityMode, GetCreateNewInfo, GetCreateNewURL, GetDefaultRowIcon, GetDisplayObjects, GetEditObjectURL, GetHiddenObjects, GetIndex, GetNoRowIcons, GetObjectClassIDs, GetRowIconByClassID, GetSelectedItems, GetSelectedNamesAsHTML, GetTreeLeafType, GetTreeMultiSelect, GetTreeQueryFilter, GetTreeSpaceID, GetTreeSubTitle, GetTreeTitle, GetUniquePopUpName, InitializeListClassIDs, InitializeReadOnlySelectPTObject, InitializeSelectPTObject, IsEditLinkEnabled, IsObjectReadOnly, ResetTreeID, SaveRow, SaveTreeID, SetAccessLevel, SetCommunityFolderID, SetCommunityMode, SetDefaultObjects, SetDefaultRowIcon, SetDisplayObjects, SetEnableCreateNew, 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, 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, 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.portaluiinfrastructure.expandablelist.selectptobject.ISelectPTObjectModelRO

ClearHiddenObjects, GetAccessLevel, GetCommunityFolderID, GetCommunityMode, GetCreateNewInfo, GetCreateNewURL, GetDefaultRowIcon, GetDisplayObjects, GetEditObjectURL, GetHiddenObjects, GetNoRowIcons, GetObjectClassIDs, GetRowIconByClassID, GetSelectedItems, GetSelectedNamesAsHTML, GetTreeLeafType, GetTreeMultiSelect, GetTreeQueryFilter, GetTreeSpaceID, GetTreeSubTitle, GetTreeTitle, GetUniquePopUpName, IsEditLinkEnabled, IsObjectReadOnly

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

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

Object Name

See Also:

Constant Field Values

EXPLIST_OBJECTID

public static final int EXPLIST_OBJECTID

Name of Row

See Also:

Constant Field Values

EXPLIST_NAME

public static final int EXPLIST_NAME

Name of Row

See Also:

Constant Field Values

EXPLIST_DESCRIPTION

public static final int EXPLIST_DESCRIPTION

Name of Row

See Also:

Constant Field Values

EXPLIST_ACTIONNAME

public static final int EXPLIST_ACTIONNAME

Action of Row

See Also:

Constant Field Values

EXPLIST_ACTIONVALUE

public static final int EXPLIST_ACTIONVALUE

Action of Row

See Also:

Constant Field Values

RULES_PAGINATION_SIZE

public static final int RULES_PAGINATION_SIZE

See Also:

Constant Field Values

Constructor Detail

RulesListModel

public RulesListModel()

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

InitializeRulesList

public void InitializeRulesList(java.lang.String _sSectionTitle,
                                PTImageType _imgAddIcon,
                                java.lang.String _sAddLabel,
                                int[] _arrObjectClassIDs,
                                java.lang.Object[][] arrExpListColInfo,
                                int _nListKey)

Initializes the expandable list.

Parameters:

_sSectionTitle - Main 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 -

DoTaskOnComeBackFromSubEditor

public void DoTaskOnComeBackFromSubEditor()

This method will be called when you come back to the main Editor from a sub Editor.

Overrides:

DoTaskOnComeBackFromSubEditor in class SelectPTObjectModel

GetRowIcon

public PTImageType GetRowIcon()

Returns the icon to display on each row before the input text. If the value is null, no icon is displayed.

Specified by:

GetRowIcon in interface IRulesListModelRO

Returns:

PTImageType

See Also:

GetRowIcon()

SetEnableMoveRowActions

public void SetEnableMoveRowActions(boolean _bEnableMoveRowActions)

Description copied from class: SelectPTObjectModel

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.

Overrides:

SetEnableMoveRowActions in class SelectPTObjectModel

Parameters:

_bEnableMoveRowActions -

GetEditObjectURL

public ASURL GetEditObjectURL(int _nClassID,
                              int _nObjectID,
                              java.lang.String sEditorASName)

Returns the URL to edit the object.

Specified by:

GetEditObjectURL in interface IRulesListModelRO

Parameters:

_nClassID -

_nObjectID -

_sEditorASName -

Returns:

ASURL URL to the Editor

See Also:

com.plumtree.portalpages.admin.ptutilities.condition.RulesListModel#GetEditObjectURL()

GetPaginationSize

public int GetPaginationSize()

Description copied from interface: IPaginationModelRO

This is the number of objects displayed per page. This name is the value of (m - n)

Specified by:

GetPaginationSize in interface IPaginationModelRO

Overrides:

GetPaginationSize in class ExpListModel

Returns:

int the total number of objects available for display per page

See Also:

IPaginationModelRO.GetPaginationSize()