nz.org.venice.main
Interface Module

All Known Implementing Classes:

AlertModule, ANNModule, ANNPageModule, ANNResultModule, ChartModule, ExportQuoteModule, GAModule, GAResultModule, GARulesPageModule, GPModule, GPPageInitialPopulationModule, GPResultModule, HelpModule, IDQuoteSyncModule, ImportQuoteModule, MacroModule, PaperTradeModule, PaperTradeResultModule, PortfolioModule, PortfolioTableModule, PreferencesModule, QuoteModule, TransactionModule, WatchScreenModule

public interface Module

Provides a common interface that all modules must adhere to. This interface is used to provide seamless intergration between the desktop and its sub-frames. A module is generally defined as a frame that provides a single function such as charting, showing a table of quotes or providing preference options to the user.

Method Summary

void	addModuleChangeListener(java.beans.PropertyChangeListener listener) Add a property change listener for module change events.
boolean	encloseInScrollPane() Return whether the module should be enclosed in a scroll pane.
javax.swing.JComponent	getComponent() Return displayed component for this module.
javax.swing.ImageIcon	getFrameIcon() Return frame icon for this module.
javax.swing.JMenuBar	getJMenuBar() Return menu bar for this module.
Settings	getSettings() Return the Settings for the module.
java.lang.String	getTitle() Return the window title.
void	removeModuleChangeListener(java.beans.PropertyChangeListener listener) Remove a property change listener for module change events.
void	save() Tell module to save any current state data / preferences data because the window is being closed.

Method Detail

getTitle

public java.lang.String getTitle()

Return the window title.

Returns:

the window title

addModuleChangeListener

public void addModuleChangeListener(java.beans.PropertyChangeListener listener)

Add a property change listener for module change events.

Parameters:

listener - listener

removeModuleChangeListener

public void removeModuleChangeListener(java.beans.PropertyChangeListener listener)

Remove a property change listener for module change events.

Parameters:

listener - listener

getFrameIcon

public javax.swing.ImageIcon getFrameIcon()

Return frame icon for this module.

Returns:

the frame icon

getComponent

public javax.swing.JComponent getComponent()

Return displayed component for this module.

Returns:

the component to display

getJMenuBar

public javax.swing.JMenuBar getJMenuBar()

Return menu bar for this module.

Returns:

the menu bar

encloseInScrollPane

public boolean encloseInScrollPane()

Return whether the module should be enclosed in a scroll pane.

Returns:

enclose module in scroll bar

save

public void save()

Tell module to save any current state data / preferences data because the window is being closed.

getSettings

public Settings getSettings()

Return the Settings for the module.