net.sf.genuine.organizer
Interface VisualComponent

All Known Implementing Classes:

AbstractComponent

public interface VisualComponent

This interface must be implemented by all graphical components so that they can be managed by Genuine. A component must be a sub class of javax.swing.JComponent. Although this is not enforced by a mandatory super class, all components are checked at runtime for this property. You may use AbstractComponent as base class.

To show or hide a visual component, use the ComponentManager.

Author:

Tim Wellhausen

See Also:

ComponentManager, AbstractComponent

Method Summary

java.lang.String	getComponentId() Returns the component's identifier.
java.lang.String	getInstanceId() Returns the instance id of this component.
java.lang.String	getModuleId() Returns the id of the module this component belongs to.

Method Detail

getModuleId

public java.lang.String getModuleId()

Returns the id of the module this component belongs to. The identifier is not set by the framework. Instead, it must be set by the module that initializes the component.

getComponentId

public java.lang.String getComponentId()

Returns the component's identifier. This identifier must be unique among all components of a module. The identifier is not set by the framework. Instead, it must be set by the module that initializes the component. The identifier must be the same as given in the XML configuration data for this component.

getInstanceId

public java.lang.String getInstanceId()

Returns the instance id of this component. This identifier is created by the framework and passed to Module.createVisualComponent(String, String).