com.caplin.view

Interface View

public interface View

Interface that must be implemented by Views shown in the Console, Views must also be derived from Swing JPanels.

Method Summary

Modifier and Type	Method and Description
java.util.List	getActions() Gets the list of Swing Actions that the view exposes for use as menu and toolbar items (these actions are added to menus/toolbar via their command names as configured in the view xml)
Console	getConsole() Gets the console object passed into the init() method, this is a helper method to allow access to the console from other classes without having to pass the console object around.
java.util.Properties	getProperties() Called by the console to retrieve the views configuration properties that the console will save in the configuration XML and pass back to the view the next time it is initialized in the init() method
void	init(Console console, java.util.Properties properties) Called by the connsole when view is first loaded to initialise the view and pass console and view properties
void	processMessage(java.lang.String messageId, java.util.Map messageData) Processes a message from another view, used for inter-view communication
void	save() Called by the Console if the view has marked itself as dirty, to allow the view to save its updated state to persistent storage

Method Detail

init

void init(Console console,
          java.util.Properties properties)

Called by the connsole when view is first loaded to initialise the view and pass console and view properties

Parameters:

console - the parent console

properties - a properties object to configure the view

save

void save()

Called by the Console if the view has marked itself as dirty, to allow the view to save its updated state to persistent storage

getProperties

java.util.Properties getProperties()

Called by the console to retrieve the views configuration properties that the console will save in the configuration XML and pass back to the view the next time it is initialized in the init() method

Returns:

the views properties object

getActions

java.util.List getActions()

Gets the list of Swing Actions that the view exposes for use as menu and toolbar items (these actions are added to menus/toolbar via their command names as configured in the view xml)

Returns:

the list of available actions

getConsole

Console getConsole()

Gets the console object passed into the init() method, this is a helper method to allow access to the console from other classes without having to pass the console object around.

Returns:

the parent console object

processMessage

void processMessage(java.lang.String messageId,
                    java.util.Map messageData)

Processes a message from another view, used for inter-view communication

Parameters:

messageId - a String identifying the message

messageData - a Map of name, value pairs representing messages data