com.technia.tvc.core.gui.view.impl

Class AbstractView

java.lang.Object

com.technia.tvc.core.gui.view.impl.AbstractView

All Implemented Interfaces:

View

Direct Known Subclasses:

ConfigurableView

public abstract class AbstractView
extends java.lang.Object
implements View

Abstract implementation of ViewBean

Field Summary

Fields

Modifier and Type	Field and Description
protected Filters	filters The current filters
protected Table	table The current (active) table.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractView() Sets the view definition object and applies the default system table and visuals.

Method Summary

Modifier and Type	Method and Description
void	addViewListener(ViewListener listener) Adds a view listener.
void	changeFilters(java.lang.String[] filters) Change visuals.
void	changeTable(java.lang.String name) Change system table.
View	copy() Returns a deep clone of the object.
protected abstract AbstractView	createCopy() Creates a new instance to be used for the copy operation.
protected void	fireFiltersChangedEvent() Broadcasts a ViewListener.filtersChanged(ViewEvent) event.
protected void	fireTableChangedEvent() Broadcasts a ViewListener.tableChanged(ViewEvent) event.
void	forceReloadActiveTable(Environment env) clears off the table from the view so that the latest definition / extension can be looked upon for loading the table.
java.lang.String[]	getActiveFilterNames() Returns the active filters.
Table	getActiveTable(Environment env) Returns the system table.
java.lang.String	getActiveTableName() Returns the name of the current active table.
abstract java.lang.String[]	getAvailableFilterNames() Returns a list of available filters
Filters	getAvailableFilters() Returns the available filters from this view.
abstract java.lang.String[]	getAvailableTableNames() Returns a list of available tables.
abstract java.lang.String	getContextMenuName() The context menu
abstract 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.
abstract java.lang.String	getName() Returns the name of the view.
abstract 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.
abstract java.lang.String	getToolBarName() The toolbar
protected boolean	isTableAvailable(java.lang.String name)
protected void	onClone(AbstractView view) Invoked when this view is being copied.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.technia.tvc.core.gui.view.View

getDisplayMode

Field Detail

table

protected Table table

The current (active) table.

filters

protected Filters filters

The current filters

Constructor Detail

AbstractView

protected AbstractView()

Sets the view definition object and applies the default system table and visuals.

Method Detail

getActiveTableName

public java.lang.String getActiveTableName()

Returns the name of the current active table.

Specified by:

getActiveTableName in interface View

Returns:

Returns the name of the active table.

getActiveFilterNames

public java.lang.String[] getActiveFilterNames()

Returns the active filters.

Specified by:

getActiveFilterNames in interface View

Returns:

The names of the active filters

getName

public abstract java.lang.String getName()

Returns the name of the view.

Specified by:

getName in interface View

getDisplayName

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

Returns the display name of the view.

Specified by:

getDisplayName in interface View

Parameters:

forLocale - The desired locale of the display name.

getAvailableTableNames

public abstract java.lang.String[] getAvailableTableNames()

Description copied from interface: View

Returns a list of available tables.

Specified by:

getAvailableTableNames in interface View

Returns:

the available table names for this view.

getAvailableFilterNames

public abstract java.lang.String[] getAvailableFilterNames()

Description copied from interface: View

Returns a list of available filters

Specified by:

getAvailableFilterNames in interface View

Returns:

the available filters for this view.

getRoleName

public abstract java.lang.String getRoleName()

Description copied from interface: View

Returns the role name on which the filters are defined.

Specified by:

getRoleName in interface View

Returns:

the role holding the filters

getContextMenuName

public abstract java.lang.String getContextMenuName()

The context menu

Specified by:

getContextMenuName in interface View

Returns:

Returns the name of the context menu.

getToolBarName

public abstract java.lang.String getToolBarName()

The toolbar

Specified by:

getToolBarName in interface View

Returns:

Returns the name of the toolbar menu.

changeTable

public void changeTable(java.lang.String name)

Change system table.

Specified by:

changeTable in interface View

Parameters:

name - The name of the new table.

isTableAvailable

protected boolean isTableAvailable(java.lang.String name)

getActiveTable

public Table getActiveTable(Environment env)
                     throws TVCException

Returns the system table.

Specified by:

getActiveTable in interface View

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 get the table definition.

forceReloadActiveTable

public void forceReloadActiveTable(Environment env)
                            throws TVCException

clears off the table from the view so that the latest definition / extension can be looked upon for loading the table.

Specified by:

forceReloadActiveTable in interface View

Parameters:

env -

Throws:

TVCException

changeFilters

public void changeFilters(java.lang.String[] filters)

Change visuals.

Specified by:

changeFilters in interface View

Parameters:

filters - The new filters that should be active.

getFilters

public Filters getFilters()

Description copied from interface: View

Returns the filters used by this view.

Specified by:

getFilters in interface View

Returns:

Returns the filters used for this view.

getAvailableFilters

public Filters getAvailableFilters()

Description copied from interface: View

Returns the available filters from this view.

Specified by:

getAvailableFilters in interface View

Returns:

The available filters.

addViewListener

public void addViewListener(ViewListener listener)

Adds a view listener.

Specified by:

addViewListener in interface View

Parameters:

listener - The new ViewListener.

removeViewListener

public void removeViewListener(ViewListener listener)

Removes a view listener.

Specified by:

removeViewListener in interface View

Parameters:

listener - The listener to remove.

fireTableChangedEvent

protected void fireTableChangedEvent()

Broadcasts a ViewListener.tableChanged(ViewEvent) event.

fireFiltersChangedEvent

protected void fireFiltersChangedEvent()

Broadcasts a ViewListener.filtersChanged(ViewEvent) event.

createCopy

protected abstract AbstractView createCopy()
                                    throws TVCException

Creates a new instance to be used for the copy operation.

Throws:

TVCException

onClone

protected void onClone(AbstractView view)

Invoked when this view is being copied.

Parameters:

view -

copy

public final View copy()
                throws TVCException

Returns a deep clone of the object.

Specified by:

copy in interface View

Throws:

TVCException

Since:

3.6

getTableFactory

public TableFactory getTableFactory()

Description copied from interface: View

Returns the factory that is used to load tables.

Specified by:

getTableFactory in interface View

Returns:

Returns the factory that is used to load tables.

setTableFactory

public void setTableFactory(TableFactory tableFactory)

Description copied from interface: View

Change the factory that will be used to load tables.

Specified by:

setTableFactory in interface View

Parameters:

tableFactory - The new TableFactory.

setExpander

public void setExpander(Expander expander)

Description copied from interface: View

Sets a custom expander.

Specified by:

setExpander in interface View

getExpander

public Expander getExpander()

Description copied from interface: View

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

Specified by:

getExpander in interface View