org.kepler.gui

Interface ViewPane

All Known Implementing Classes:

ClassicViewPane, DefaultViewPane, DualVerticalViewPane, SingleViewPane

public interface ViewPane

This interface is to be implemented by anyone wanting to add a view to the Kepler. The ViewPaneFactory generates instances of ViewPane.

Author:

Aaron Schultz

Method Summary

Modifier and Type	Method and Description
void	addTabPane(TabPane tabPane, ViewPaneLocation location) This method is used to add a TabPane to the ViewPane specifying the location in which the TabPane should be placed.
java.awt.Container	getLocationContainer(java.lang.String locationName) This method must return the Container that represents the specified ViewPaneLocation.
TableauFrame	getParentFrame() This method must return the TableauFrame this view is associated with.
java.util.List<TabPane>	getTabPanes(java.lang.String tabName) Look up the tab by the given name
java.lang.String	getViewName() This method should return the name of the view which is used to label the view in the View selection list.
boolean	hasLocation(java.lang.String locationName) This method must return true if the supplied location name matches the name of one of the supported ViewPaneLocations for this ViewPane.
void	initializeView() Initialization of the view should be done at some point after the constructor is called.
void	setParentFrame(TableauFrame parent) This method sets the TableauFrame this view is associated with.

Method Detail

initializeView

void initializeView()
             throws java.lang.Exception

Initialization of the view should be done at some point after the constructor is called. The setParentFrame() method is called by the factory before calling initializeView(). This also allows for more easily adding new functions to this interface later on.

Throws:

java.lang.Exception

getViewName

java.lang.String getViewName()

This method should return the name of the view which is used to label the view in the View selection list.

getParentFrame

TableauFrame getParentFrame()

This method must return the TableauFrame this view is associated with.

setParentFrame

void setParentFrame(TableauFrame parent)

This method sets the TableauFrame this view is associated with.

hasLocation

boolean hasLocation(java.lang.String locationName)

This method must return true if the supplied location name matches the name of one of the supported ViewPaneLocations for this ViewPane.

addTabPane

void addTabPane(TabPane tabPane,
                ViewPaneLocation location)
         throws java.lang.Exception

This method is used to add a TabPane to the ViewPane specifying the location in which the TabPane should be placed.

Throws:

java.lang.Exception

getLocationContainer

java.awt.Container getLocationContainer(java.lang.String locationName)
                                 throws java.lang.Exception

This method must return the Container that represents the specified ViewPaneLocation.

Parameters:

location -

Throws:

java.lang.Exception

getTabPanes

java.util.List<TabPane> getTabPanes(java.lang.String tabName)
                             throws java.lang.Exception

Look up the tab by the given name

Parameters:

tabName - * @throws Exception

Throws:

java.lang.Exception