com.technia.tvc.core.gui.view

Interface View

All Known Implementing Classes:

AbstractView, ConfigurableView

public interface View

Represents a view.

Method Summary

Modifier and Type	Method and Description
void	addViewListener(ViewListener listener) Adds a view listener.
void	changeFilters(java.lang.String[] activeFilterNames) Sets the active filters.
void	changeTable(java.lang.String tableName) Changes the current active table
View	copy() Returns a copy of the object.
void	forceReloadActiveTable(Environment env)
java.lang.String[]	getActiveFilterNames() Returns the names of the filters currently in use.
Table	getActiveTable(Environment env) Returns the table.
java.lang.String	getActiveTableName() Returns the active table name.
java.lang.String[]	getAvailableFilterNames() Returns a list of available filters
Filters	getAvailableFilters() Returns the available filters from this view.
java.lang.String[]	getAvailableTableNames() Returns a list of available tables.
java.lang.String	getContextMenuName() Returns the name of the context menu.
java.lang.String	getDisplayMode() Returns the display mode for this view.
java.lang.String	getDisplayName(java.util.Locale forLocale) Returns the display name of the view.
Expander	getExpander() Returns the expander that is used to expand structures using this view.
Filters	getFilters() Returns the filters used by this view.
java.lang.String	getName() Returns the name of the view.
java.lang.String	getRoleName() Returns the role name on which the filters are defined.
TableFactory	getTableFactory() Returns the factory that is used to load tables.
java.lang.String	getToolBarName() Returns the name of the toolbar menu.
void	removeViewListener(ViewListener listener) Removes a view listener.
void	setExpander(Expander expander) Sets a custom expander.
void	setTableFactory(TableFactory tableFactory) Change the factory that will be used to load tables.

Method Detail

getName

java.lang.String getName()

Returns the name of the view.

getDisplayName

java.lang.String getDisplayName(java.util.Locale forLocale)

Returns the display name of the view.

Parameters:

forLocale - The desired locale of the display name.

getRoleName

java.lang.String getRoleName()

Returns the role name on which the filters are defined.

Returns:

Returns the role name on which the filters are defined.

changeFilters

void changeFilters(java.lang.String[] activeFilterNames)
            throws TVCException

Sets the active filters.

Parameters:

activeFilterNames - The new filters that should be active.

Throws:

TVCException

getAvailableFilterNames

java.lang.String[] getAvailableFilterNames()
                                    throws TVCException

Returns a list of available filters

Returns:

Returns a list of available filters.

Throws:

TVCException - If unable to get a list of available filters.

getFilters

Filters getFilters()

Returns the filters used by this view.

Returns:

Returns the filters used for this view.

Since:

6.0.0

getAvailableFilters

Filters getAvailableFilters()

Returns the available filters from this view.

Returns:

The available filters.

Since:

6.2.1

getActiveFilterNames

java.lang.String[] getActiveFilterNames()

Returns the names of the filters currently in use.

Returns:

Returns the names of the filters currently in use.

getAvailableTableNames

java.lang.String[] getAvailableTableNames()
                                   throws TVCException

Returns a list of available tables.

Returns:

Returns a list of available table names.

Throws:

TVCException - If unable to get a list of available table names.

changeTable

void changeTable(java.lang.String tableName)
          throws TVCException

Changes the current active table

Parameters:

tableName - The name of the new table.

Throws:

TVCException - If unable to change table.

getActiveTableName

java.lang.String getActiveTableName()

Returns the active table name.

Returns:

Returns the name of the active table.

getActiveTable

Table getActiveTable(Environment env)
              throws TVCException

Returns the table.

Parameters:

env - The current Environment. The environment affects how the table is loaded, if it has to be loaded.

Returns:

The active table.

Throws:

TVCException - If unable to load the table.

getContextMenuName

java.lang.String getContextMenuName()

Returns the name of the context menu.

Returns:

Returns the name of the context menu.

Since:

6.3.0

getToolBarName

java.lang.String getToolBarName()

Returns the name of the toolbar menu.

Returns:

Returns the name of the toolbar menu.

Since:

5.1

addViewListener

void addViewListener(ViewListener listener)

Adds a view listener.

Parameters:

listener - The new ViewListener.

removeViewListener

void removeViewListener(ViewListener listener)

Removes a view listener.

Parameters:

listener - The listener to remove.

copy

View copy()
   throws TVCException

Returns a copy of the object.

Throws:

TVCException

getTableFactory

TableFactory getTableFactory()

Returns the factory that is used to load tables.

Returns:

Returns the factory that is used to load tables.

Since:

6.1.5

setTableFactory

void setTableFactory(TableFactory tableFactory)

Change the factory that will be used to load tables.

Parameters:

tableFactory - The new TableFactory.

Since:

6.1.5

getExpander

Expander getExpander()

Returns the expander that is used to expand structures using this view.

Since:

2009.1.0

setExpander

void setExpander(Expander expander)

Sets a custom expander.

Parameters:

expander -

Since:

2009.1.0

getDisplayMode

java.lang.String getDisplayMode()

Returns the display mode for this view.

Returns:

The display mode for the current view. The return value can be null.

Since:

2010.2.0

forceReloadActiveTable

void forceReloadActiveTable(Environment env)
                     throws TVCException

Parameters:

env -

Throws:

TVCException

Since:

2020.3.0