ca.sqlpower.wabit.swingui
Interface WabitPanel

All Superinterfaces:
ca.sqlpower.swingui.DataEntryPanel
All Known Implementing Classes:
ChartPanel, GroupPanel, LayoutPanel, OlapQueryPanel, QueryPanel, ReportTaskPanel, UserPanel, WabitImagePanel, WorkspacePanel

public interface WabitPanel
extends ca.sqlpower.swingui.DataEntryPanel

All panels that are to be displayed in Wabit's main split pane to the left of the workspace tree should implement this interface. This interface defines basic behaviour required of all panels in Wabit including maximizing the editor.


Method Summary
 javax.swing.JComponent getSourceComponent()
          Returns the component (often a JTree or JList, but can be anything) that contains all the workspace items that can be dragged into this editor.
 java.lang.String getTitle()
          Returns a suitable string that can be used in the title of a containing window or frame.
 javax.swing.JToolBar getToolbar()
          Returns the toolbar.
 
Methods inherited from interface ca.sqlpower.swingui.DataEntryPanel
applyChanges, discardChanges, getPanel, hasUnsavedChanges
 

Method Detail

getTitle

java.lang.String getTitle()
Returns a suitable string that can be used in the title of a containing window or frame. Usually describes what the panel contains. (ex. "Query Editor" or "Report Editor")


getToolbar

@Nullable
javax.swing.JToolBar getToolbar()
Returns the toolbar. A null value means not to render the toolbar.


getSourceComponent

javax.swing.JComponent getSourceComponent()
Returns the component (often a JTree or JList, but can be anything) that contains all the workspace items that can be dragged into this editor. The component will not be wrapped in a scroll pane; you get to do this yourself if your component needs one.

Returns:
The component as described above, or null if nothing can be dropped on this panel.


Copyright © 2009. All Rights Reserved.