public interface TableBean<T extends TableData> extends ViewSupport, MenuBarSupport, ContextMenuSupport, com.technia.tvc.core.db.inquiry.InquirySupport, com.technia.tvc.core.db.jpo.JPOSupport, EnvironmentSupport, AttributeSupport, PageConfigSupport, TableDataProvider<T>, java.lang.Cloneable
This interface extends the ViewSupport interface thus making it
possible to associate the table with a
view. It also extends the
MenuBarSupport interface to be able
to attach a menubar to the table.
The InquirySupport and
JPOSupport interfaces are extended to
allow the table to load it's content from an inquiry and/or JPO respectively.
The EnvironmentSupport interface is
extended to make it possible to associate the table with a
Environment containing environment
variables. The idea behind this is that the Application Exchange
Framework™ supplied by MatrixOne, inc. expects to have access to
parameters from an HTTP request (and other information related to the
request).
The AttributeSupport interface is extended
to make it possible for users of a table to associate atributes with the
table.
ViewSupport,
InquirySupport,
JPOSupport,
EnvironmentSupport,
AttributeSupport,
PageConfigSupport,
TableDataTableDataProvider.Displayed<T extends TableData>, TableDataProvider.Empty<T extends TableData>, TableDataProvider.Specific<T extends TableData>, TableDataProvider.Visible<T extends TableData>EMPTY| Modifier and Type | Method and Description |
|---|---|
void |
accept(TableDataVisitor visitor)
Accept a visitor for all TableData instances.
|
void |
addTableClonedListener(TableClonedListener listener)
Adds a
TableClonedListener to the table. |
void |
addTableContentListener(TableContentListener listener)
Add a
TableContentListener. |
void |
addTableGroupedListener(TableGroupedListener listener)
Adds a
TableGroupedListener to the table. |
void |
addTableListener(TableListener listener)
Adds a
TableListener to the table. |
void |
addTableNavigateListener(TableNavigateListener listener)
Adds a
TableNavigateListener to the table. |
void |
addVisibleTableDataFilter(VisibleTableDataFilter filter)
Add a
VisibleTableDataFilter to the filter stack that validates
whether a TableData instance should be visible or not. |
void |
clearVisibleTableDataFilter()
Removes all
VisibleTableDataFilter instances that filter which
TableData instances should be visible or not. |
java.lang.Object |
clone()
Returns a clone of this instance
|
TableCalculations |
getCalculations()
Returns the calculations on this table.
|
Cell |
getCellAt(int row,
int column)
Returns the
cell at the specified row and column. |
Column |
getColumnAt(int index)
Returns the
column at the specified index. |
Column |
getColumnByName(java.lang.String name) |
int |
getColumnCount()
Returns the column count.
|
int |
getColumnIndex(Column column)
Returns the index of the specified
column. |
java.util.List<Column> |
getColumnList() |
java.util.Iterator<Column> |
getColumns()
Returns the table
columns. |
java.util.Iterator<T> |
getDisplayedTableData()
Returns all
TableData instances that should be displayed. |
int |
getDisplayedTableDataCount()
Returns the count of all displayed
TableData instances. |
java.util.Iterator<T> |
getEvaluationRequiredTableData()
Returns all
TableData instances whose
isEvaluationRequired() method
returns true. |
int |
getEvaluationRequiredTableDataCount()
Returns the count of all
TableData instances that needs to be
evaluated. |
java.util.Iterator<T> |
getFilteredTableData(TableDataFilter filter)
Returns all
TableData instances that is accepted by the
filter. |
int |
getFilteredTableDataCount(TableDataFilter filter)
Returns the count of all
TableData instances accepted by the
filter. |
boolean |
getHasParent()
Tests if this
table bean instance has a parent
table bean set. |
java.lang.String |
getHeader()
Returns the header for this table.
|
NavigationHandler |
getNavigationHandler(Environment env,
java.lang.String objectId)
Deprecated.
As of 2014.3.0
|
NavigationHandler |
getNavigationHandler(Environment env,
java.lang.String objectId,
java.lang.String relationshipId) |
TableBean<? extends TableData> |
getParent()
Returns the parent
table bean instance from this
instance. |
java.util.Iterator<T> |
getSelectedTableData()
Returns all
TableData instances whose
isSelected() method returns true. |
int |
getSelectedTableDataCount()
|
java.lang.String |
getSubHeader()
Returns the subheader for this table.
|
java.util.Iterator<TableClonedListener> |
getTableClonedListeners()
Returns the
TableClonedListeners. |
java.util.Iterator<T> |
getTableData()
Returns all
TableData instances currently in the table. |
java.util.Iterator<T> |
getTableData(java.lang.String objectId)
|
java.util.Iterator<T> |
getTableData(java.lang.String relationshipId,
java.lang.String objectId)
|
TableData |
getTableDataAt(int index)
Returns the
TableData instance at the specified index. |
int |
getTableDataCount()
Returns the count of all
TableData instances in the table. |
TableData |
getTableDataWithId(long id)
|
java.util.Iterator<TableGroupedListener> |
getTableGroupedListeners()
Returns the
TableGroupedListeners. |
java.util.Iterator<TableListener> |
getTableListeners()
Returns all
TableListeners. |
java.util.Iterator<TableNavigateListener> |
getTableNavigateListeners()
Returns all
TableNavigateListeners. |
Column |
getVisibleColumnAt(int index) |
Column |
getVisibleColumnByName(java.lang.String name) |
int |
getVisibleColumnCount() |
java.util.Iterator<Column> |
getVisibleColumns() |
java.util.Iterator<T> |
getVisibleTableData()
|
int |
getVisibleTableDataCount()
|
java.util.Iterator<VisibleTableDataFilter> |
getVisibleTableDataFilters() |
java.util.Iterator<VisibleTableDataFilter> |
getVisibleTableDataFilters(java.lang.Class<? extends VisibleTableDataFilter> type) |
boolean |
hasCellAt(int row,
int column)
Returns true if the table has a cell at the specified row and
column.
|
boolean |
hasTableData()
Returns true if the table contains any
TableData
instances. |
boolean |
hasVisibleTableDataFilter(VisibleTableDataFilter filter)
Returns whether the
VisibleTableDataFilter is currently being
used to filter which TableData instances should be visible or
not. |
void |
invalidate()
This method can be used to invalidate the table.
|
boolean |
isHeaderHTML()
Returns true if the header is HTML.
|
boolean |
isNavigateSupported() |
boolean |
isOnlyEvaluateVisibleColumns() |
boolean |
isSubHeaderHTML()
Returns true if the subheader is HTML.
|
boolean |
isValid()
This method returns true if the table is valid.
|
boolean |
isVisible(TableData data)
|
boolean |
isVisibleColumn(Column column)
Checks whether a column is visible.
|
TableBean<? extends TableData> |
navigate(java.lang.String objectId)
Returns a
TableBean that has the specified objectId as
root object. |
TableBean<? extends TableData> |
navigate(TableData data)
Returns a
TableBean that has the specified TableData as
root node. |
void |
reload()
Call this method to make sure that all rows are reloaded the next time
they are validated/displayed.
|
TableBean<? extends TableData> |
removeParent()
Removes the current parent
table bean instance and
returns it. |
void |
removeTableClonedListener(TableClonedListener listener)
Removes the
TableClonedListener from the table. |
void |
removeTableContentListener(TableContentListener listener)
Remove a
TableContentListener. |
void |
removeTableData(java.lang.String objectId)
Removes all
TableData instances with the specified object ID. |
void |
removeTableData(java.lang.String relationshipId,
java.lang.String objectId)
Removes all
TableData instances with the specified object and
relationship ID. |
void |
removeTableData(TableData data)
Removed the specified
TableData from the table. |
void |
removeTableGroupedListener(TableGroupedListener listener)
Removes the
TableGroupedListener from the table. |
void |
removeTableListener(TableListener listener)
Removes the
TableListener from the table. |
void |
removeTableNavigateListener(TableNavigateListener listener)
Removes the
TableNavigateListener from the table. |
void |
removeVisibleTableDataFilter(VisibleTableDataFilter filter)
Remove a
VisibleTableDataFilter to the filter stack that
validates whether a TableData instance should be visible or not. |
void |
removeVisibleTableDataFilters(java.lang.Class<? extends VisibleTableDataFilter> type)
Removes all filters withe the specified type.
|
void |
setHeader(java.lang.String header)
Sets the header for this table.
|
void |
setHeader(java.lang.String header,
boolean isHTML)
Sets the header for this table.
|
void |
setOnlyEvaluateVisibleColumns(boolean onlyEvaluateVisibleColumns) |
TableBean<? extends TableData> |
setParent(TableBean<? extends TableData> parent)
Sets the parent
table bean instance. |
void |
setSubHeader(java.lang.String subHeader)
Sets the subheader for this table.
|
void |
setSubHeader(java.lang.String subHeader,
boolean isHTML)
Sets the subheader for this table.
|
void |
validate(Environment env)
This method should be called to validate the table when the
isValid() returns false. |
getChoosableViews, getView, getViewFactory, isTableChangeable, isViewChangeable, isVisualsChangeable, setChoosableViews, setView, setView, setViewFactorygetMenuBar, setMenuBargetContextMenu, setContextMenuisInquirySupported, loadFromInquiry, loadFromInquirygetEnv, getEnv, setEnvgetAttribute, getAttributeNames, removeAttribute, setAttributegetPageConfig, setPageConfigvoid addVisibleTableDataFilter(VisibleTableDataFilter filter)
VisibleTableDataFilter to the filter stack that validates
whether a TableData instance should be visible or not.filter - A VisibleTableDataFilter instance.void removeVisibleTableDataFilter(VisibleTableDataFilter filter)
VisibleTableDataFilter to the filter stack that
validates whether a TableData instance should be visible or not.filter - A VisibleTableDataFilter instance.boolean hasVisibleTableDataFilter(VisibleTableDataFilter filter)
VisibleTableDataFilter is currently being
used to filter which TableData instances should be visible or
not.filter - A VisibleTableDataFilter instance.void clearVisibleTableDataFilter()
VisibleTableDataFilter instances that filter which
TableData instances should be visible or not.java.util.Iterator<VisibleTableDataFilter> getVisibleTableDataFilters()
VisibleTableDataFilter instances that filter
which TableData instances should be visible or not.java.util.Iterator<VisibleTableDataFilter> getVisibleTableDataFilters(java.lang.Class<? extends VisibleTableDataFilter> type)
type - The type of the VisibleTableDataFilter instances that
should be returned. I.e., filters that aren't assignable to the
specified type will not be returned.VisibleTableDataFilter instances that filter
which TableData instances should be visible or not.boolean isVisible(TableData data)
TableData instance should be
visible according to the visible table data
filters.java.lang.Object clone()
boolean isValid()
validated before displayed.void invalidate()
isValid() method return
false, thereby forcing a validation.void validate(Environment env) throws TVCException
isValid() returns false. Exactly what is validated is
up to the implementing classes to decide.env - The environment to use when validating the table. This is
typically the environment that has been associated with the table.TVCException - if the validation was unsuccessful.java.util.Iterator<T> getTableData()
TableData instances currently in the table.getTableData in interface TableDataProvider<T extends TableData>TableData instances currently in the table.java.util.Iterator<T> getVisibleTableData()
java.util.Iterator<T> getSelectedTableData()
TableData instances whose
isSelected() method returns true.java.util.Iterator<T> getEvaluationRequiredTableData()
TableData instances whose
isEvaluationRequired() method
returns true.java.util.Iterator<T> getDisplayedTableData()
TableData instances that should be displayed. It is
up to to the implementing classes to decide which data that should be
displayed.TableData instances that should be displayed.java.util.Iterator<T> getFilteredTableData(TableDataFilter filter)
TableData instances that is accepted by the
filter.filter - a TableDataFilter that can be used to control which
TableData instances are returned.TableData instances that is accepted by the
filter.java.util.Iterator<T> getTableData(java.lang.String objectId)
java.util.Iterator<T> getTableData(java.lang.String relationshipId, java.lang.String objectId)
relationshipId - the relationship ID. If this parameter is null then
all TableData instances with a matching object ID are
returned.objectId - the object ID. If this parameter is null then all
TableData instances with a matching relationship ID are
returned.TableData instances with a matching
relationship ID and
object ID.void removeTableData(TableData data)
TableData from the table.data - the TableData that should be removed from the table.void removeTableData(java.lang.String objectId)
TableData instances with the specified object ID.objectId - The object ID, if this parameter is null the
ALL TableData instances are removed.void removeTableData(java.lang.String relationshipId,
java.lang.String objectId)
TableData instances with the specified object and
relationship ID.TableData getTableDataAt(int index)
TableData instance at the specified index.index - the index.TableData instance at the specified index.java.lang.IndexOutOfBoundsException - if the index is invalid.TableData getTableDataWithId(long id)
int getTableDataCount()
TableData instances in the table.TableData instances in the table.getTableData()int getVisibleTableDataCount()
visible
TableData instances in the table.getVisibleTableData()int getSelectedTableDataCount()
selected
TableData instances in the table.getSelectedTableData()int getEvaluationRequiredTableDataCount()
TableData instances that needs to be
evaluated.TableData instances that needs to be
evaluated.getEvaluationRequiredTableData()int getDisplayedTableDataCount()
TableData instances.TableData instances.getDisplayedTableData()int getFilteredTableDataCount(TableDataFilter filter)
TableData instances accepted by the
filter.filter - the TableDataFilter that decides whether a
TableData instance should be accepted or not.getFilteredTableDataCount(TableDataFilter)boolean hasTableData()
TableData
instances.TableData
instances.java.util.Iterator<Column> getColumns()
columns.columns.java.util.List<Column> getColumnList()
columns as a list.java.util.Iterator<Column> getVisibleColumns()
visible columns.boolean isVisibleColumn(Column column)
column - A column whose visibility we want to check.Column getVisibleColumnAt(int index)
index - The index of the visible column.java.lang.IndexOutOfBoundsException - if the index is invalid.int getVisibleColumnCount()
Column getVisibleColumnByName(java.lang.String name)
name - The name of the column, i.e., not label.Column getColumnAt(int index)
column at the specified index.index - the column index.column at the specified index.java.lang.IndexOutOfBoundsException - if the index is invalid.Column getColumnByName(java.lang.String name)
name - The name of the column, i.e., not label.int getColumnCount()
int getColumnIndex(Column column)
column.column - the column.Cell getCellAt(int row, int column)
cell at the specified row and column.row - the row index.column - the column index.cell at the specified row and column.java.lang.IndexOutOfBoundsException - if the row or column indices are
invalid.boolean hasCellAt(int row,
int column)
row - the row index.column - the column index.void addTableListener(TableListener listener)
TableListener to the table.listener - the TableListener to add.void removeTableListener(TableListener listener)
TableListener from the table.listener - the TableListener to remove.java.util.Iterator<TableListener> getTableListeners()
TableListeners.TableListeners.void addTableClonedListener(TableClonedListener listener)
TableClonedListener to the table.listener - the TableClonedListener to add.void removeTableClonedListener(TableClonedListener listener)
TableClonedListener from the table.listener - the TableClonedListener to remove.java.util.Iterator<TableClonedListener> getTableClonedListeners()
TableClonedListeners.TableClonedListeners.void addTableNavigateListener(TableNavigateListener listener)
TableNavigateListener to the table.listener - the TableNavigateListener to add.void removeTableNavigateListener(TableNavigateListener listener)
TableNavigateListener from the table.listener - the TableNavigateListener to remove.java.util.Iterator<TableNavigateListener> getTableNavigateListeners()
TableNavigateListeners.TableNavigateListeners.@Deprecated NavigationHandler getNavigationHandler(Environment env, java.lang.String objectId) throws TVCException
env - The environment variables as when the navigation handler were
requested. The implementation might use the variables from the env
to define certain behavior OR it might just ignore it.objectId - The business object idNavigationHandlerTVCExceptiongetNavigationHandler(Environment, String, String)NavigationHandler getNavigationHandler(Environment env, java.lang.String objectId, java.lang.String relationshipId) throws TVCException
env - The environment variables as when the navigation handler were
requested. The implementation might use the variables from the env
to define certain behavior OR it might just ignore it.objectId - The business object idrelationshipId - The relationship id (optional)navigation handlerTVCException - If unable to create a new instance.TableBean<? extends TableData> navigate(TableData data) throws TVCException
TableBean that has the specified TableData as
root node.data - The TableData that represents the root node in the
structure.TVCException - If unable to create a new instance.TableBean<? extends TableData> navigate(java.lang.String objectId) throws TVCException
TableBean that has the specified objectId as
root object.objectId - The root business object.TVCException - If unable to create a new instance.boolean isNavigateSupported()
navigate is
supported by this TableBean.void reload()
throws TVCException
TVCException - If some error occurs.boolean isOnlyEvaluateVisibleColumns()
void setOnlyEvaluateVisibleColumns(boolean onlyEvaluateVisibleColumns)
onlyEvaluateVisibleColumns - Whether the table should only validate
visible columns.void setHeader(java.lang.String header)
header - The new header.void setHeader(java.lang.String header,
boolean isHTML)
header - The new header.isHTML - Whether the header is HTML.java.lang.String getHeader()
boolean isHeaderHTML()
void setSubHeader(java.lang.String subHeader)
subHeader - The new subheader.void setSubHeader(java.lang.String subHeader,
boolean isHTML)
subHeader - The new subheader.isHTML - Whether the header is HTML.java.lang.String getSubHeader()
boolean isSubHeaderHTML()
TableCalculations getCalculations()
void accept(TableDataVisitor visitor)
visitor - The visitor that will visit all TableData instances.java.lang.NullPointerException - If visitor is null.void removeVisibleTableDataFilters(java.lang.Class<? extends VisibleTableDataFilter> type)
type - The type.void addTableContentListener(TableContentListener listener)
TableContentListener.listener - The listener.void removeTableContentListener(TableContentListener listener)
TableContentListener.listener - The listener.void addTableGroupedListener(TableGroupedListener listener)
TableGroupedListener to the table.listener - the TableGroupedListener to add.void removeTableGroupedListener(TableGroupedListener listener)
TableGroupedListener from the table.listener - the TableGroupedListener to remove.java.util.Iterator<TableGroupedListener> getTableGroupedListeners()
TableGroupedListeners.TableGroupedListeners.TableBean<? extends TableData> getParent()
table bean instance from this
instance. If there is no parent table bean set, this
method returns null.table bean, if set.TableBean<? extends TableData> setParent(TableBean<? extends TableData> parent)
table bean instance. Providing a null
value is the same as calling removeParent().parent - The parent table bean or null.table bean if set.TableBean<? extends TableData> removeParent()
table bean instance and
returns it.
This is the same as doing:
TableBean<?> parent = tableBean.getParent(); tableBean.setParent(null);
table bean, if set.boolean getHasParent()
table bean instance has a parent
table bean set.getParent() returns a non-null value.Copyright ? Technia AB. All Rights Reserved.