|
|
|||||
| Package com.dassault_systemes.pprnblcabase.model |
Class ENOVDataPPRTableModel
|
| Class Hierarchy |
java.lang.Object
|
+-com.dassault_systemes.catjdialog.CATCallbackSource
|
+-com.dassault_systemes.catjdialog.CATKeyTableModel
|
+-com.dassault_systemes.pprnblcabase.model.ENOVDataPPRTableModel
| Class Location |
| Class Description |
public class ENOVDataPPRTableModel
Table Model for list. This table model supports multiple means of indicating the source of the data. The data can be specified as an array of data object (in which case this table model will NOT be a transient data model), or you can specify a base object and a relationship name from which to retrieve the data, or you can specify a ENOVIQuery from which to retrieve the data, or you can specify a ENOVIClientCommand from which to retrieve the data.
All Implemented Interfaces: CATKeyTableModelCtxMenuEx CATIRecordDriverSupport CATKeyTableModelTypeExCollab
| Field Summary |
| protected boolean | _bsortColumnDone
|
| protected ENOVIClientCommand | _cmd
|
| protected ENOVIDataObject[] | _data
|
| protected boolean | _edit
|
| protected boolean | _firstColLink
|
| protected CATColumnSort | _lastSort
|
| protected String | _noun
|
| protected ENOVIDataObject | _object
|
| protected ENOVIQuery | _query
|
| protected String | _relName
|
| protected String | _resultParmName
|
| protected CATSession | _session
|
| protected CATTable | _table
|
| protected ENOVILogonToken | _token
|
| protected ENOVIType | _type
|
| protected Vector | _typeAttrs
|
| protected Vector | _viewAttrs
|
| Constructor Summary |
| ENOVDataPPRTableModel(CATTable iTable, String iNoun, ENOVIDataObject[] iData, ENOVILogonToken iToken)
Constructor for non-edit mode |
| ENOVDataPPRTableModel(CATTable iTable, String iNoun, ENOVIDataObject[] iData, ENOVILogonToken iToken, boolean iEditMode)
Constructor specifying edit mode (Edit Mask) |
| ENOVDataPPRTableModel(CATTable iTable, String iNoun, ENOVIDataObject iObject, String iRelName, boolean iEditMode)
Constructor specifying Edit mode (Edit Mask) without objects list |
| ENOVDataPPRTableModel(CATTable iTable, String iNoun, ENOVIDataObject[] iData, ENOVILogonToken iToken, ENOVIType iType)
Constructor for non-edit mode with object list and object type |
| ENOVDataPPRTableModel(CATTable iTable, String iNoun, ENOVIClientCommand iCommand, String iResultParmName)
Constructor for non-edit mode with object list resulting from a server command execution |
| ENOVDataPPRTableModel(CATTable iTable, String iNoun, ENOVIQuery iQuery)
Constructor for non-edit mode with object list resulting from a server query execution |
| Method Summary |
| protected void | generateDefaultView()
|
| protected void | generateFocalViewForHomelets()
|
| protected void | generatePrefView()
|
| public int | getAttrType(int iColumn)
Returns PPRAttribute for a table column |
| public String | getCell(String iKey, int iColumn)
Returns the text of a table cell |
| public Object | getCellObject(String iKey, int iColumn)
Returns Attribute object for a table cell. |
| public int | getColumnAlignment(int iColumn)
Returns the alignment type for a table cell (Right or Left) |
| public int | getColumnCount()
Returns number of table columns |
| public String | getColumnTitle(int iColumn)
Returns table column titles |
| public CATMenuModel | getContextualMenu(String iKey, int iCol)
Returns table contextual menu |
| protected ENOVIDataObject[] | getData()
Returns objects list for the table |
| public Hashtable | getDataHash()
Returns object for a table key. |
| public ENOVIDataObject | getDataObject(String iKey)
Returns object for a table key. |
| public PortalUID[] | getDataUIDs(int iOffset, int iLength)
Returns PortalUID list for a range of table entries |
| public boolean | getEnable(String iKey, int iColumn)
Returns true if cell is enabled (apply to check/radio/link) |
| public String | getImage(String key, int c)
Returns image name for table cell |
| public int | getKeyCount()
Returns total number of table keys |
| public void | getKeys(int iOffset, String[] oKeys)
Returns all table keys starting from an offset |
| public int | getLevel(String iKey, int iColumn)
Returns the style of a table cell. |
| public String | getRecordDriverName()
Returns which driver is supported by the key model. |
| public int | getRenderType(String iKey, int iColumn)
|
| public ENOVIDataObject[] | getSelectedObjects()
Returns selected(highligthed) objects. |
| public boolean | getState(String iKey, int iColumn)
Returns the check/radio state of a table cell. |
| public String | getTablePrefsRepository(CATTable iTable)
Returns the repository prefix for the table preferences A specific repository prefix ensure specific preferences for the table. |
| public String | getTooltip(String key, int c)
Returns image tooltip for a table cell |
| public ENOVIType | getType()
Returns object type for a table |
| public int | getType(String iKey, int iColumn)
To specify additional rendering for a table cell |
| public Vector | getTypeAttrs()
Returns the list of attributes that the table object type defines. |
| public Vector | getViewAttrs()
Returns the list of displayed attributes. |
| public String | getWebType()
Returns table webtype |
| public boolean | isALiveName(String iKey, int iColumn)
|
| public boolean | isColumnSortable(int iColumn)
Returns true if a table column is sortable |
| public boolean | isData()
Returns true if table is not empty |
| public boolean | isListExportable()
Returns true if list is exportable to Excel(Displays Export link) |
| public void | onCellActionLinkClicked(CATDialog iDialog, CATNotification iNotification, Object iData)
Callback to open the Properties panel for objects after clicking on the action link in the first column. |
| public void | onColumnSort(CATDialog iDialog, CATNotification iNotif, Object iData)
Callback on sort of a table column (Convenience method for panels to use). |
| public void | resetObjects(ENOVIDataObject[] iData)
Resets the objects list for the table |
| public void | setCell(String iKey, int iColumn, String iText)
Callback method for table cells of type tEDITABLE |
| public void | setFirstColLink(boolean iFlag)
Defines whether the first visible table column should be a link to the object. |
| public void | setPreferencePrefix(String iPreferencePrefix)
The preferences on the results (which attributes are displayed) are based by default on: - the current widget "SearchResults" - the type (adapter+env+type) If the preference prefix is set to: - null, the user cannot customize the results - empty String (default value), the user can customize the results based on the above parameters - otherwise, the new prefix is added to the list of above parameters |
| public ENOVIDataObject[] | sortColumn(CATColumnSort newSort, ENOVIDataObject[] iData)
Sorts the specified table column. |
| public boolean | sortColumnDone()
Returns true if table sort is done |
| Field Detail |
protected boolean _bsortColumnDone
protected ENOVIClientCommand _cmd
protected ENOVIDataObject[] _data
protected boolean _edit
protected boolean _firstColLink
protected CATColumnSort _lastSort
protected String _noun
protected ENOVIDataObject _object
protected ENOVIQuery _query
protected String _relName
protected String _resultParmName
protected CATSession _session
protected CATTable _table
protected ENOVILogonToken _token
protected ENOVIType _type
protected Vector _typeAttrs
protected Vector _viewAttrs
| Constructor Detail |
ENOVDataPPRTableModel(CATTable iTable, String iNoun, ENOVIDataObject[] iData, ENOVILogonToken iToken)
Constructor for non-edit mode
ENOVDataPPRTableModel(CATTable iTable, String iNoun, ENOVIDataObject[] iData, ENOVILogonToken iToken, boolean iEditMode)
Constructor specifying edit mode (Edit Mask)
ENOVDataPPRTableModel(CATTable iTable, String iNoun, ENOVIDataObject iObject, String iRelName, boolean iEditMode)
Constructor specifying Edit mode (Edit Mask) without objects list
ENOVDataPPRTableModel(CATTable iTable, String iNoun, ENOVIDataObject[] iData, ENOVILogonToken iToken, ENOVIType iType)
Constructor for non-edit mode with object list and object type
ENOVDataPPRTableModel(CATTable iTable, String iNoun, ENOVIClientCommand iCommand, String iResultParmName)
Constructor for non-edit mode with object list resulting from a server command execution
ENOVDataPPRTableModel(CATTable iTable, String iNoun, ENOVIQuery iQuery)
Constructor for non-edit mode with object list resulting from a server query execution
| Method Detail |
protected void generateDefaultView()
protected void generateFocalViewForHomelets()
protected void generatePrefView()
public int getAttrType(int iColumn)
Returns PPRAttribute for a table column
public String getCell(String iKey, int iColumn)
Returns the text of a table cell
public Object getCellObject(String iKey, int iColumn)
Returns Attribute object for a table cell.
public int getColumnAlignment(int iColumn)
Returns the alignment type for a table cell (Right or Left)
public int getColumnCount()
Returns number of table columns
public String getColumnTitle(int iColumn)
Returns table column titles
public CATMenuModel getContextualMenu(String iKey, int iCol)
Returns table contextual menu
protected ENOVIDataObject[] getData()
Returns objects list for the table
public Hashtable getDataHash()
Returns object for a table key.
public ENOVIDataObject getDataObject(String iKey)
Returns object for a table key.
public PortalUID[] getDataUIDs(int iOffset, int iLength)
Returns PortalUID list for a range of table entries
public boolean getEnable(String iKey, int iColumn)
Returns true if cell is enabled (apply to check/radio/link)
public String getImage(String key, int c)
Returns image name for table cell
public int getKeyCount()
Returns total number of table keys
public void getKeys(int iOffset, String[] oKeys)
Returns all table keys starting from an offset
public int getLevel(String iKey, int iColumn)
Returns the style of a table cell. The style is defined by an integer.
0 stands for default aspect.
1 for title level.
2 for subtitle level...
public String getRecordDriverName()
Returns which driver is supported by the key model.
The returned string may contain arguments. ex: "Query@1,3"
The name "Self" tells this object is also the RecordDriver to use.
public int getRenderType(String iKey, int iColumn)
public ENOVIDataObject[] getSelectedObjects()
Returns selected(highligthed) objects.
public boolean getState(String iKey, int iColumn)
Returns the check/radio state of a table cell.
public String getTablePrefsRepository(CATTable iTable)
Returns the repository prefix for the table preferences
A specific repository prefix ensure specific preferences
for the table.
public String getTooltip(String key, int c)
Returns image tooltip for a table cell
public ENOVIType getType()
Returns object type for a table
public int getType(String iKey, int iColumn)
To specify additional rendering for a table cell
public Vector getTypeAttrs()
Returns the list of attributes that the table object type defines.
The attribute order is determined by mask on the server.
public Vector getViewAttrs()
Returns the list of displayed attributes.
The attribute order is determined by view definition.
public String getWebType()
Returns table webtype
public boolean isALiveName(String iKey, int iColumn)
public boolean isColumnSortable(int iColumn)
Returns true if a table column is sortable
public boolean isData()
Returns true if table is not empty
public boolean isListExportable()
Returns true if list is exportable to Excel(Displays Export link)
public void onCellActionLinkClicked(CATDialog iDialog, CATNotification iNotification, Object iData)
Callback to open the Properties panel for objects after clicking on the
action link in the first column.
public void onColumnSort(CATDialog iDialog, CATNotification iNotif, Object iData)
Callback on sort of a table column (Convenience method for panels to use).
public void resetObjects(ENOVIDataObject[] iData)
Resets the objects list for the table
public void setCell(String iKey, int iColumn, String iText)
Callback method for table cells of type tEDITABLE
public void setFirstColLink(boolean iFlag)
Defines whether the first visible table column should be a link to the object.
public void setPreferencePrefix(String iPreferencePrefix)
The preferences on the results (which attributes are displayed) are based by default on:
- the current widget "SearchResults"
- the type (adapter+env+type)
If the preference prefix is set to:
- null, the user cannot customize the results
- empty String (default value), the user can customize the results based on the above parameters
- otherwise, the new prefix is added to the list of above parameters
iPreferencePrefix
public ENOVIDataObject[] sortColumn(CATColumnSort newSort, ENOVIDataObject[] iData)
Sorts the specified table column.
public boolean sortColumnDone()
Returns true if table sort is done