psdi.webclient.controls

Class Table

java.lang.Object

psdi.webclient.system.controller.BaseInstance

psdi.webclient.system.controller.ControlInstance

psdi.webclient.system.controller.DatasrcInstance

psdi.webclient.controls.Table

All Implemented Interfaces:

java.lang.Cloneable, DataBeanListener

public class Table
extends DatasrcInstance
implements DataBeanListener

This is driving class behind the set of table controls. It uses databean and a set of flags to keep state of any table.

Author:

Brian Ragusa

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	focusedCellId

Fields inherited from class psdi.webclient.system.controller.ControlInstance

amIinitialize, DATASOURCE, INPUTMODE, labelOverride, ONDATACAHNGE, PARAM_APP, PARAM_APPTABTYPE, PARAM_DESIGNMODE, PARAM_MOBILE, PARAM_MODULE, PARAM_PAGE, PARAM_PARENTCOMPONENT, PARAM_PARENTCONTROL, PARAM_PRESENTATION, PARAM_SCREENREADER, PARAM_SKINNAME, PARAM_TAB, PARAM_TABGROUP, PARAM_TABGROUP_MAIN, PARAM_TABLE, PARAM_USERINFO, PARAM_VERTICALLABEL, RERENDER_PROPERTY

Fields inherited from class psdi.webclient.system.controller.BaseInstance

EXCEPTION_ERROR, EXCEPTION_INFO, EXCEPTION_NONE, EXCEPTION_REQUIREDFIELD, EXCEPTION_SMARTFILL, EXCEPTION_WARNING, EXCEPTION_YESNOCANCEL, FORCE_WARNING_HANDLING, NO_PROMPT_WITH_WARNING, presentationTags, PROMPT_WHEN_WARNING_EXIST

Constructor Summary

Constructors

Constructor and Description
Table()

Method Summary

Methods

Modifier and Type	Method and Description
int	addrow()
void	addSelectAllRowControl(ControlInstance selectRow)
void	addSelectRowControl(ControlInstance selectRow)
java.lang.Object	canDownload()
void	childHasError(BoundComponentInstance childWithError, SetValueError newError)
void	clearErrors()
int	clearfilter() Clear the table filter
void	columnFocus()
java.lang.String	createRenderId(java.lang.String id, PageInstance page)
void	dataChangedEvent(DataBean bean)
void	defaultDetailFocus()
void	defaultRowFocus(int row)
boolean	errorLevelChanged()
int	filtertable() Makes the table filterable
void	forceFocusRow(int row)
void	forceFocusRow(java.lang.String row)
TableBody	getBody()
java.lang.String	getColumnId(int colNum)
int	getCurrentRow()
ControlInstance	getDetails()
int	getErrorLevel() Returns the current error level for the table
int	getErrorLevelForRow(int row) Returns the error level for the passed in row.
int	getExpandedRow()
int	getFilterCount()
TableFilterRow	getFilterRow()
boolean	getFlagValue(int flag)
boolean	getHideSelectRows()
boolean	getMultiple()
int	getNewRowNum()
int	getOldCurrentRow()
TableDataRow	getRowControl()
boolean	getRowSelectVis()
java.lang.String	getSortLevel(java.lang.String sortAttribute)
java.lang.String	getSortOrder(java.lang.String sortAttribute)
java.lang.String	getTableDownloadSheetName() Returns the string which is used to name the worksheet tab in the tabledownload functionality.
void	increaseFilters()
void	initialize() should be extended to do any setup required by the instance.
java.lang.String	isDetailsExpanded()
java.lang.Object	isExpanded()
java.lang.Object	isFilterable()
java.lang.String	isFiltered()
java.lang.Object	isFilterOpen()
boolean	isLastColumn(java.lang.String colId)
boolean	isListTabRetain() Check if it is resultsbean in a list and the Retain List Table functionality is enabled via system configuration.
boolean	isOnTable()
java.lang.String	isTableAllSelected()
java.lang.String	isTableSelectRowsOpen()
java.lang.String	isTableStartEmpty()
boolean	maintainControlId()
java.lang.String	morePagesAfter()
java.lang.String	morePagesBefore()
java.lang.String	moreRowsAfter()
java.lang.String	moreRowsBefore()
java.lang.Object	needsRefresh()
int	nextpage() Changes databean offset to move the set to the next page
int	nextrow() Move to the next row
void	noRowFocus()
boolean	preRender() This is needed to allow the sigoption property changes on tablecols to affect the refresh of the table and force it to rerender when necessary
int	previouspage() Changes databean offset to move the set to the previous page
int	previousrow() Move to the previous row
int	render() Render this control's components
int	reset() This is called when a table is refreshed.
void	resetNewRowNum()
void	resetPreRender() This block removes the skipPreRender setting from all columns when we prerender a table, we setup state during prerender of the table by preRendering from the table down to all of it's cells when they get prerendered, they are marked to not preRender again.
boolean	rowChanged()
void	selectmockedrecord() Allows selection of record when in select records mode to allow user to edit set.
void	setBody(TableBody body)
int	setCurrentRow(int row)
void	setDefaultFocus()
void	setDefaultFocus(int row)
int	setExpandedRow(int row)
void	setFilterRow(TableFilterRow tableFilterRow)
void	setFocusedCellId(java.lang.String id)
void	setHasDetails(boolean hasDetails)
void	setHideSelectRows(boolean hide)
void	setOldCurrentRow(int row)
boolean	shouldTableShowHelp()
void	showMXException(MXException mxe)
void	showRemoteException(java.rmi.RemoteException rme)
void	sortColumn()
void	structureChangedEvent(DataBean bean)
int	tablehelp() Sets a state so that the tablebody component can check and create a help url
int	togglecollapse() Changes databean collapse flag
int	toggledetails(boolean expanded)
int	toggledetails(boolean expanded, boolean setFocus) Toggles the state of a table details
int	togglefilter() Toggles the state of a table filter
int	toggleselectallrows()
int	toggleselectrecords()
boolean	useNPMbo()
boolean	wasTableCollapseStateChanged()
boolean	wasTableDetailStateChanged()
boolean	wasTableFilterCleared()
boolean	wasTableFilterStateChanged()
boolean	wasTablePageChanged()
boolean	wasTableRowChanged()
boolean	wasTableSelectRowStateChanged()

Methods inherited from class psdi.webclient.system.controller.DatasrcInstance

broadcastEvent, cleanup, getDataBean, instantiatedatasrc, instantiatedatasrcdesign

Methods inherited from class psdi.webclient.system.controller.ControlInstance

addChild, addComponent, canInsert, canInsert, canRemove, childHasErrorFocus, clearComponent, copy, eventCheck, findComponentByDescriptorId, findDesignerProperty, findProperty, findUseForLablledByComponent, getAdaptorInstance, getBoundComponent, getComponent, getComponents, getDataSource, getDescriptorControl, getDesignerProperty, getDesignerSelected, getDesignerSelectedControl, getElement, getGeneratedControl, getOriginalControl, getOriginalProperty, getProperties, getProperty, getProperty, getPropertyIgnoreFlags, getPropertyOriginator, getPropertyUncle, getRecordHover, getSkipPreRender, getTableControl, getTakesValueComponent, handleEvent, hasChanged, hasChangedConditionally, hasChildElements, hasMaskedChanged, hasRecordHover, hasVisibleChildren, isDesignerEditedProperty, isDisabled, isFocusable, isGenerated, isHiddenByLicense, isIncluded, isLastChild, isMainrecActionMenu, isMasked, isOnTableFilterRow, isOnTableTitleRow, isPersistentProperty, isReInitialize, isSelected, isToBeDisplayedOnCurrentTab, isToBeDisplayedOnTab, isVisible, launchexternal, moveChild, needsRender, parseParamvalues, preRenderChecks, quickinsert, registerDesignerEditedProperty, reInitialize, removeChild, renderChildren, resetDataSource, resolveParam, resolveParams, setAttributeError, setBoundComponent, setChangedFlag, setChangedFlag, setDesignerSelected, setDisabled, setElement, setErrorFocusOnControl, setFocus, setFocus, setFocusable, setFocusTable, setGenerated, setGeneratedControl, setIncluded, setIncluded, setNeedsRender, setOnTableFilterRow, setOnTableRow, setOnTableTitleRow, setOriginalControl, setPropertyOriginator, setPropertyUncle, setReInitialize, setReRenderFlags, setSelected, setSkipPreRender, setTableControl, setVisibility, stopRender, walkForId, walkForId

Methods inherited from class psdi.webclient.system.controller.BaseInstance

addChild, addChild, addRefreshListener, clearChildren, clearProperties, clone, clone, getBoolean, getChildCount, getChildIndex, getChildren, getConsiderInDesigner, getDescriptor, getId, getIdExtension, getInt, getLocalizedType, getPage, getParent, getParentInstance, getPropertyNames, getRefreshListeners, getRenderId, getRowNum, getSafeId, getString, getType, getWebClientSession, handleEvent, hasAnyPropertyChanged, hasLocalProperty, hasPropertyChanged, initProperty, isDynamicContainer, isOnTableRow, removeProperty, setConsiderInDesigner, setDescriptor, setDynamicContainer, setOnTable, setParent, setProperty, setProperty, setRenderId, setType, setWebClientSession, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

focusedCellId

public java.lang.String focusedCellId

Constructor Detail

Table

public Table()

Method Detail

initialize

public void initialize()

Description copied from class: BaseInstance

should be extended to do any setup required by the instance. for example, the DatasrcInstance will call initialize to create data sources found in the bind list.

Overrides:

initialize in class ControlInstance

getHideSelectRows

public boolean getHideSelectRows()

setHideSelectRows

public void setHideSelectRows(boolean hide)

getMultiple

public boolean getMultiple()

addSelectAllRowControl

public void addSelectAllRowControl(ControlInstance selectRow)

addSelectRowControl

public void addSelectRowControl(ControlInstance selectRow)

setBody

public void setBody(TableBody body)

getBody

public TableBody getBody()

getFlagValue

public boolean getFlagValue(int flag)

needsRefresh

public java.lang.Object needsRefresh()

isExpanded

public java.lang.Object isExpanded()

isFilterOpen

public java.lang.Object isFilterOpen()

isFilterable

public java.lang.Object isFilterable()

canDownload

public java.lang.Object canDownload()

moreRowsBefore

public java.lang.String moreRowsBefore()

moreRowsAfter

public java.lang.String moreRowsAfter()

morePagesBefore

public java.lang.String morePagesBefore()

morePagesAfter

public java.lang.String morePagesAfter()

isFiltered

public java.lang.String isFiltered()

isDetailsExpanded

public java.lang.String isDetailsExpanded()

isTableStartEmpty

public java.lang.String isTableStartEmpty()

isTableAllSelected

public java.lang.String isTableAllSelected()

isTableSelectRowsOpen

public java.lang.String isTableSelectRowsOpen()

getCurrentRow

public int getCurrentRow()

setOldCurrentRow

public void setOldCurrentRow(int row)

getOldCurrentRow

public int getOldCurrentRow()

setCurrentRow

public int setCurrentRow(int row)
                  throws MXException

Throws:

MXException

togglefilter

public int togglefilter()

Toggles the state of a table filter

defaultRowFocus

public void defaultRowFocus(int row)

setDefaultFocus

public void setDefaultFocus()

setDefaultFocus

public void setDefaultFocus(int row)

defaultDetailFocus

public void defaultDetailFocus()

toggledetails

public int toggledetails(boolean expanded)

toggledetails

public int toggledetails(boolean expanded,
                boolean setFocus)

Toggles the state of a table details

getDetails

public ControlInstance getDetails()

getExpandedRow

public int getExpandedRow()

setExpandedRow

public int setExpandedRow(int row)

filtertable

public int filtertable()

Makes the table filterable

clearfilter

public int clearfilter()
                throws MXException

Clear the table filter

Throws:

MXException

columnFocus

public void columnFocus()

noRowFocus

public void noRowFocus()

setFocusedCellId

public void setFocusedCellId(java.lang.String id)

previousrow

public int previousrow()
                throws MXException

Move to the previous row

Throws:

MXException

nextrow

public int nextrow()
            throws MXException,
                   java.rmi.RemoteException

Move to the next row

Throws:

MXException

java.rmi.RemoteException

previouspage

public int previouspage()
                 throws MXException

Changes databean offset to move the set to the previous page

Throws:

MXException

nextpage

public int nextpage()
             throws MXException

Changes databean offset to move the set to the next page

Throws:

MXException

tablehelp

public int tablehelp()

Sets a state so that the tablebody component can check and create a help url

togglecollapse

public int togglecollapse()

Changes databean collapse flag

toggleselectallrows

public int toggleselectallrows()
                        throws MXException

Throws:

MXException

toggleselectrecords

public int toggleselectrecords()
                        throws MXException

Throws:

MXException

getRowSelectVis

public boolean getRowSelectVis()

wasTableFilterStateChanged

public boolean wasTableFilterStateChanged()

wasTableDetailStateChanged

public boolean wasTableDetailStateChanged()

wasTableCollapseStateChanged

public boolean wasTableCollapseStateChanged()

wasTableFilterCleared

public boolean wasTableFilterCleared()

wasTableRowChanged

public boolean wasTableRowChanged()

rowChanged

public boolean rowChanged()

wasTablePageChanged

public boolean wasTablePageChanged()

shouldTableShowHelp

public boolean shouldTableShowHelp()

wasTableSelectRowStateChanged

public boolean wasTableSelectRowStateChanged()

setHasDetails

public void setHasDetails(boolean hasDetails)

dataChangedEvent

public void dataChangedEvent(DataBean bean)

Specified by:

dataChangedEvent in interface DataBeanListener

structureChangedEvent

public void structureChangedEvent(DataBean bean)

Specified by:

structureChangedEvent in interface DataBeanListener

render

public int render()
           throws java.lang.NoSuchMethodException,
                  java.lang.IllegalAccessException,
                  java.lang.reflect.InvocationTargetException

Description copied from class: ControlInstance

Render this control's components

Overrides:

render in class DatasrcInstance

Throws:

java.lang.NoSuchMethodException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

preRender

public boolean preRender()

This is needed to allow the sigoption property changes on tablecols to affect the refresh of the table and force it to rerender when necessary

Overrides:

preRender in class ControlInstance

resetPreRender

public void resetPreRender()

This block removes the skipPreRender setting from all columns when we prerender a table, we setup state during prerender of the table by preRendering from the table down to all of it's cells when they get prerendered, they are marked to not preRender again. When each one renders, it removes the marker telling it to skip unfortunately, only certain rows are rendered during each table render and the markers are not removed from cells that are not rendered

isLastColumn

public boolean isLastColumn(java.lang.String colId)

getColumnId

public java.lang.String getColumnId(int colNum)

sortColumn

public void sortColumn()
                throws MXException

Throws:

MXException

getSortLevel

public java.lang.String getSortLevel(java.lang.String sortAttribute)

getSortOrder

public java.lang.String getSortOrder(java.lang.String sortAttribute)

getRowControl

public TableDataRow getRowControl()

increaseFilters

public void increaseFilters()

getFilterCount

public int getFilterCount()

getTableDownloadSheetName

public java.lang.String getTableDownloadSheetName()

Returns the string which is used to name the worksheet tab in the tabledownload functionality.

Returns:

name as String

addrow

public int addrow()
           throws MXException

Throws:

MXException

showMXException

public void showMXException(MXException mxe)

showRemoteException

public void showRemoteException(java.rmi.RemoteException rme)

forceFocusRow

public void forceFocusRow(java.lang.String row)

forceFocusRow

public void forceFocusRow(int row)

setFilterRow

public void setFilterRow(TableFilterRow tableFilterRow)

getFilterRow

public TableFilterRow getFilterRow()

useNPMbo

public boolean useNPMbo()

isListTabRetain

public boolean isListTabRetain()

Check if it is resultsbean in a list and the Retain List Table functionality is enabled via system configuration.

errorLevelChanged

public boolean errorLevelChanged()

Overrides:

errorLevelChanged in class ControlInstance

childHasError

public void childHasError(BoundComponentInstance childWithError,
                 SetValueError newError)

Overrides:

childHasError in class ControlInstance

getErrorLevelForRow

public int getErrorLevelForRow(int row)

Returns the error level for the passed in row.

Parameters:

row -

Returns:

getErrorLevel

public int getErrorLevel()

Returns the current error level for the table

Overrides:

getErrorLevel in class ControlInstance

Returns:

clearErrors

public void clearErrors()

Overrides:

clearErrors in class ControlInstance

resetNewRowNum

public void resetNewRowNum()

getNewRowNum

public int getNewRowNum()

reset

public int reset()

This is called when a table is refreshed.

selectmockedrecord

public void selectmockedrecord()
                        throws java.rmi.RemoteException,
                               MXException

Allows selection of record when in select records mode to allow user to edit set.

Throws:

java.rmi.RemoteException

MXException

maintainControlId

public boolean maintainControlId()

Overrides:

maintainControlId in class BaseInstance

createRenderId

public java.lang.String createRenderId(java.lang.String id,
                              PageInstance page)

Overrides:

createRenderId in class ControlInstance

isOnTable

public boolean isOnTable()

Overrides:

isOnTable in class BaseInstance