|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.uiinfrastructure.editor.EditorHelperModel com.plumtree.uiinfrastructure.expandablelist.ExpListModel com.plumtree.portalpages.admin.editors.doctypemap.GbDocTypeListModel
public class GbDocTypeListModel
This is the implementation of the Expandable List framework for the Growable Array. The Growable Array is a list of input texts. On add, a new input text populated with the default value will be added at the bottom of the list.
Field Summary | |
---|---|
static java.lang.String |
CURRENTGBDOCTYPEMODEL_ID
|
static java.lang.String |
CURRENTSECTION_ID
|
static java.lang.String |
DOCTYPE_ID
This is the String that we doisplay in the list. |
static java.lang.String |
DOCTYPE_NAME
|
static int |
EXPLIST_COL_DOCTYPE
This column contains the Object Class IDs. |
static int |
EXPLIST_COL_IDENTIFIER
This column contains the Object IDs. |
static int |
EXPLIST_COL_MAX
Number total of columns |
static int |
EXPLIST_SORTEDARRAY_PROPID_INPUTTEXT
Second column: the value of the input text. |
protected PTImageType |
m_imgRowIcon
Icon to display on each row, just before the input text. |
protected java.lang.String |
m_sDefaultValue
This is used on add to populate the input text of the newly added row. |
protected java.lang.String |
m_strSecondAddLabel
|
static java.lang.String |
ROW_INDEX
|
static java.lang.String |
STR_MVC_CLASS_NAME
Class name for the activity space |
Fields inherited from class com.plumtree.uiinfrastructure.editor.EditorHelperModel |
---|
m_asOwner |
Constructor Summary | |
---|---|
GbDocTypeListModel()
|
Method Summary | |
---|---|
void |
AddRowsOnRepost(XPHashtable _htFormData)
Adds one row at the bottom of the list and sets the following values: First column: m_nNextIndex Second column: m_sDefaultValue |
void |
AddRowsToList(java.lang.String[] _aData)
Adds an array of new rows to the list. |
java.lang.Object |
Create()
This method is used by the ASManager to return new instances of managed objects. |
void |
DoTaskOnComeBackFromSubEditor(int _nDPID)
This method will be called when you come back to the main Editor from a sub Editor. |
void |
Finish()
This method contains the code to store the Document Type Map. |
ASURL |
GetASURLToProperty(java.lang.String _sSubSpaceKey,
java.lang.String _strDefaultSpace)
Return the ASURL object going to the Property Editor as a sub Editor. |
XPHashtable |
GetDocTypeMappings(int _nIndex)
|
java.lang.String |
GetDocTypeStringFromID(int _nDocTypeID,
int _nIndex)
|
ASURL |
GetEditObjectURL(int _nDocTypeID,
java.lang.String _strDocTypeIdentifier,
int _nRowIndex)
Returns the URL to edit the object. |
int |
GetFolderID()
|
java.lang.String[] |
GetListValues()
This method should ge used by the client to get back the array of values at the end of the Editor and store them. |
int |
GetModelID()
|
java.lang.String |
GetName()
Returns the Class name. |
PTImageType |
GetRowIcon()
Returns the icon to display on each row before the input text. |
PTImageType |
GetSecondAddImageIcon()
|
java.lang.String |
GetSecondAddLabel()
|
int |
GetSectionID(int _nIndex)
|
IASQueryResult |
GetSections()
|
IASQueryResult |
GetValidDocumentTypes(int _nSectionID)
Returns the valid document types for that section. |
void |
InitializeGbDocTypeList(IPTDocumentTypeMap _ptDocTypeMap,
int _nListKey,
java.lang.String _strSectionName)
Initializes the expandable list. |
void |
InitializeSortedArray(PTGrowableSortedArrayWrapper _saData)
Initalizes the list (PTGrowableSortedArrayWrapper) with a column mapping and an array of sort. |
void |
RemoveAllRows(int[] iRowIDs)
|
protected int |
SaveRow(PTGrowableSortedArrayWrapper _saData,
int _nRowIndex,
XPHashtable _htFormData)
Saves the data on the row _nRowIndex. |
void |
SetDefaultObjects(java.lang.Object[][] _arrRows)
Add the array passed in argument to the list. |
void |
SetDefaultValue(java.lang.String _sDefaultValue)
Sets a new default value. |
void |
SetDocTypesIDToNameMap(IASQueryResult _ptasqrValidDocTypes,
int _nIndex)
|
void |
SetFolderID(int _nFolderID)
|
void |
SetModelID(int _nGbDocTypeModelID)
|
void |
SetRowIcon(PTImageType _imgRowIcon)
Sets the icon to display on each row before the input text. |
void |
SetSecondAddImageIcon(PTImageType _imgAddSecondIcon)
|
void |
SetSecondAddLabel(java.lang.String _strSecondAddLabel)
|
void |
SetSingleDocTypeIDToNameMapping(java.lang.String _strDocTypeName,
int _nDocTypeID,
int _nIndex)
|
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 |
---|
public static final java.lang.String STR_MVC_CLASS_NAME
public static final int EXPLIST_COL_MAX
public static final int EXPLIST_COL_DOCTYPE
public static final int EXPLIST_COL_IDENTIFIER
public static final java.lang.String CURRENTSECTION_ID
public static final java.lang.String CURRENTGBDOCTYPEMODEL_ID
public static final java.lang.String DOCTYPE_ID
public static final java.lang.String DOCTYPE_NAME
public static final java.lang.String ROW_INDEX
public static final int EXPLIST_SORTEDARRAY_PROPID_INPUTTEXT
protected PTImageType m_imgRowIcon
protected java.lang.String m_sDefaultValue
protected java.lang.String m_strSecondAddLabel
Constructor Detail |
---|
public GbDocTypeListModel()
Method Detail |
---|
public void AddRowsOnRepost(XPHashtable _htFormData)
AddRowsOnRepost
in class ExpListModel
_htFormData
- Form datapublic void AddRowsToList(java.lang.String[] _aData)
_aData
- public java.lang.Object Create()
EditorHelperModel
Create
in interface IManagedObject
Create
in class EditorHelperModel
IManagedObject.Create()
public void DoTaskOnComeBackFromSubEditor(int _nDPID)
public void Finish()
public ASURL GetASURLToProperty(java.lang.String _sSubSpaceKey, java.lang.String _strDefaultSpace)
GetASURLToProperty
in interface IGbDocTypeListModelRO
_sSubSpaceKey
- Key for the sub Editor.
If we are going to a new sub Editor, the key can be null and
we will just pass in the default key. If we are going back to an
existing sub Editor, it should be the sub Editor key.
com.plumtree.portalpagessample.editor.template4#GetASURLToProperty
public int GetFolderID()
GetFolderID
in interface IGbDocTypeListModelRO
public void SetFolderID(int _nFolderID)
public XPHashtable GetDocTypeMappings(int _nIndex)
_nIndex
-
public java.lang.String GetDocTypeStringFromID(int _nDocTypeID, int _nIndex)
GetDocTypeStringFromID
in interface IGbDocTypeListModelRO
_nDocTypeID
- _nIndex
-
public ASURL GetEditObjectURL(int _nDocTypeID, java.lang.String _strDocTypeIdentifier, int _nRowIndex)
GetEditObjectURL
in interface IGbDocTypeListModelRO
_nClassID
- _nObjectID
- _sEditorASName
-
public java.lang.String[] GetListValues()
public int GetModelID()
GetModelID
in interface IGbDocTypeListModelRO
public java.lang.String GetName()
GetName
in interface IMVCObject
GetName
in class EditorHelperModel
public PTImageType GetRowIcon()
GetRowIcon
in interface IGbDocTypeListModelRO
com.plumtree.uiinfrastructure.expandablelist.GrowableListModel#GetRowIcon()
public java.lang.String GetSecondAddLabel()
GetSecondAddLabel
in interface IGbDocTypeListModelRO
public int GetSectionID(int _nIndex)
_nIndex
-
java.lang.Exception
public IASQueryResult GetSections()
java.lang.Exception
XPException
public IASQueryResult GetValidDocumentTypes(int _nSectionID) throws java.lang.Exception
_nSectionID
-
java.lang.Exception
public void InitializeGbDocTypeList(IPTDocumentTypeMap _ptDocTypeMap, int _nListKey, java.lang.String _strSectionName)
_sSectionTitle
- Main title._sSectionSubTitle
- Sub title_imgAddIcon
- Icon for the add action._sAddLabel
- Text to display next to the add icon._nListKey
- In case you have multiple Expandable Lists on
the same DP, they should have a different key (otherwise, just set it to 1).public void SetSecondAddImageIcon(PTImageType _imgAddSecondIcon)
public PTImageType GetSecondAddImageIcon()
GetSecondAddImageIcon
in interface IGbDocTypeListModelRO
public void InitializeSortedArray(PTGrowableSortedArrayWrapper _saData)
InitializeSortedArray
in class ExpListModel
_saData
- public void RemoveAllRows(int[] iRowIDs)
iRowIDs
- public void SetDefaultObjects(java.lang.Object[][] _arrRows)
_arrRows
- Array of rows to add.public void SetDefaultValue(java.lang.String _sDefaultValue)
_sDefaultValue
- New valuepublic void SetDocTypesIDToNameMap(IASQueryResult _ptasqrValidDocTypes, int _nIndex)
_ptasqrValidDocTypes
- _nIndex
- public void SetModelID(int _nGbDocTypeModelID)
_nGbDocTypeModelID
- public void SetRowIcon(PTImageType _imgRowIcon)
_imgRowIcon
- public void SetSecondAddLabel(java.lang.String _strSecondAddLabel)
_strSecondAddLabel
- public void SetSingleDocTypeIDToNameMapping(java.lang.String _strDocTypeName, int _nDocTypeID, int _nIndex)
_strDocTypeName
- _nDocTypeID
- _nIndex
- protected int SaveRow(PTGrowableSortedArrayWrapper _saData, int _nRowIndex, XPHashtable _htFormData)
SaveRow
in class ExpListModel
_saData
- List to update the data on row _nRowIndex_nRowIndex
- Index of the row to save._htFormData
- Data posted by the form.
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |