net.sourceforge.mflow.api
Interface MFlowUI

public interface MFlowUI

Interface to specify what funcionality a MFlowUI must provide

Version:

$Revision: 1.3 $

Author:

David Carr

Method Summary

javax.swing.JFrame	getFrame() Returns the base JFrame of the UI
ContactMethod[]	getSelectedContactMethods() Gets the currently selected ContactMethods
Contact[]	getSelectedContacts() Gets the currently selected Contacts
MsgFolder	getSelectedFolder() Gets the currently selected MsgFolder
Msg	getSelectedMsg() Gets the currently selected Msg.
Msg[]	getSelectedMsgs() Gets the currently selected Msgs.
void	init() Initializes the user interface
boolean	isVisible() Returns whether or not the UI is currently visible
void	repaint() Repaints the UI
void	setVisible(boolean b) Sets the visibility of the UI

Method Detail

getSelectedContacts

Contact[] getSelectedContacts()

Gets the currently selected Contacts

Returns:

an array of selected Contacts

getSelectedContactMethods

ContactMethod[] getSelectedContactMethods()

Gets the currently selected ContactMethods

Returns:

an array of selected ContactMethods

getSelectedFolder

MsgFolder getSelectedFolder()

Gets the currently selected MsgFolder

Returns:

the selected MsgFolder, or null

getSelectedMsg

Msg getSelectedMsg()

Gets the currently selected Msg. If multiple Msgs are selected, returns only the first one.

Returns:

the selected Msg, or null

getSelectedMsgs

Msg[] getSelectedMsgs()

Gets the currently selected Msgs.

Returns:

an array of selected Msgs

setVisible

void setVisible(boolean b)

Sets the visibility of the UI

Parameters:

b - whether or not to display the UI

isVisible

boolean isVisible()

Returns whether or not the UI is currently visible

Returns:

the visibility of the UI

repaint

void repaint()

Repaints the UI

getFrame

javax.swing.JFrame getFrame()

Returns the base JFrame of the UI

Returns:

the base JFrame

init

void init()

Initializes the user interface