com.jidesoft.dashboard
Interface GadgetComponent

All Superinterfaces:

PlaceHolder

public interface GadgetComponent
extends PlaceHolder

GadgetComponent is the Component that is added to the Dashboard. The Gadget is responsible for the creation of GadgetComponent.

GadgetComponent is an interface. So you implement your own GadgetComponent. However it must be a Component such as JPanel, JComponent or any other Swing or AWT components. Failed to do so will result in ClassCastException in the code.

Method Summary

Gadget	getGadget() Gets the Gadget that creates this GadgetComponent.
Map<String,String>	getSettings() Gets the settings.
void	setSettings(Map<String,String> settings) Sets the setting.

Method Detail

getGadget

Gadget getGadget()

Gets the Gadget that creates this GadgetComponent.

Returns:

the Gadget.

getSettings

Map<String,String> getSettings()

Gets the settings.

Returns:

a map of the settings. The key is the name of the setting and the value of the map is the value of the setting. The value must be a string in order to be persisted in the xml format. If your original data format is not string, you need to convert to string first. You could leverage ObjectConverterManager and ObjectConverter to do it.

setSettings

void setSettings(Map<String,String> settings)

Sets the setting.

Parameters:

settings - a map of the settings. The key is the name of the setting and the value of the map is the value of the setting. The value is a string in order to be persisted in the xml format. If your original data format is not string, you need to convert from string to the type you expect first. You could leverage ObjectConverterManager and ObjectConverter to do it.