A B C D E F G H I L M N O P R S T U V W X Y

A

APPEARANCE - Static variable in class net.sf.genuine.resources.DefaultResources

APPLY - Static variable in class net.sf.genuine.resources.DefaultResources

AbstractComponent - class net.sf.genuine.organizer.AbstractComponent.

This class may be used as super class for all visual components.

AbstractComponent(String, String, String, ModuleManager) - Constructor for class net.sf.genuine.organizer.AbstractComponent

Panel is initialized with its id and a reference to the module this panel belongs to.

AbstractModule - class net.sf.genuine.organizer.AbstractModule.

This class is a default implementation of the Module interface that does nothing by itself but provides convenience methods.

AbstractModule() - Constructor for class net.sf.genuine.organizer.AbstractModule

AppearancePreferencesPage - class net.sf.genuine.preferences.general.AppearancePreferencesPage.

A default preference panel provided by Genuine that lets the user set several GUI related appearance options.

AppearancePreferencesPage() - Constructor for class net.sf.genuine.preferences.general.AppearancePreferencesPage

Initializes this panel

actionPerformed(ActionEvent) - Method in class net.sf.genuine.actions.CloseAction

actionPerformed(ActionEvent) - Method in class net.sf.genuine.actions.CopyAction

actionPerformed(ActionEvent) - Method in class net.sf.genuine.actions.CutAction

actionPerformed(ActionEvent) - Method in class net.sf.genuine.actions.ExitAction

actionPerformed(ActionEvent) - Method in class net.sf.genuine.actions.HideComponentAction

actionPerformed(ActionEvent) - Method in class net.sf.genuine.actions.NewAction

actionPerformed(ActionEvent) - Method in class net.sf.genuine.actions.OpenAction

actionPerformed(ActionEvent) - Method in class net.sf.genuine.actions.PasteAction

actionPerformed(ActionEvent) - Method in class net.sf.genuine.actions.SaveAction

actionPerformed(ActionEvent) - Method in class net.sf.genuine.actions.ShowComponentAction

addButtonEntries(Module, List) - Method in class net.sf.genuine.organizer.internal.ToolBar

Adds a list of button definition for the given module.

addButtons(Module, Element) - Method in class net.sf.genuine.organizer.internal.ToolBarBuilder

Adds the definition of a module by passing both the module and its "toolbar" element.

addComponentListener(ComponentListener) - Method in class net.sf.genuine.organizer.AbstractComponent

Adds a component listener for this component by calling the component manager.

addComponentListener(String, String, String, ComponentListener) - Method in interface net.sf.genuine.organizer.ComponentManager

Adds a listener for the component that is identified by the given module id, component id, and instance id so that the listener is notified when the component is shown, hidden, activated, or deactivated.

addComponentListener(String, ComponentListener) - Method in class net.sf.genuine.organizer.internal.ComponentInstanceManager

Adds a listener for a component so that the listener is notified when the component is shown/hidden, activated/deactivated.

addComponentListener(ComponentListener) - Method in class net.sf.genuine.organizer.internal.ComponentStatusManager

Adds a ComponentListener to the component.

addComponentListener(String, String, String, ComponentListener) - Method in class net.sf.genuine.organizer.internal.DefaultComponentManager

Adds a listener for a component so that the listener is notified when the component is shown/hidden, activated/deactivated.

addMenuEntries(Module, List) - Method in class net.sf.genuine.organizer.internal.Menu

Adds all menu entries from the given list of menu entry elements to this menu.

addMenus(Module, Element) - Method in class net.sf.genuine.organizer.internal.MenuBarBuilder

Adds the definition of a module by passing both the module and its "menubar" element.

addProperty(String, String) - Method in class net.sf.genuine.resources.ResourceItem

Sets a property for this resource item.

addResources(String) - Method in class net.sf.genuine.resources.ResourceManager

Takes the name of resources to be loaded and available during runtime.

applySize(JInternalFrame) - Method in class net.sf.genuine.organizer.internal.Size

Applies the size values to the given internal frame.

applySize(Window) - Method in class net.sf.genuine.organizer.internal.Size

Applies the size values to the given window.

B

buildMenuBar() - Method in class net.sf.genuine.organizer.internal.DefaultModuleManager

Delegates to menu bar builder

buildMenuBar() - Method in interface net.sf.genuine.organizer.internal.InternalModuleManager

Has to build a menu bar based on the initialization of the modules.

buildMenuBar() - Method in class net.sf.genuine.organizer.internal.MenuBarBuilder

Creates a new JMenuBar instance and adds all menu entries recursively.

buildToolBar() - Method in class net.sf.genuine.organizer.internal.DefaultModuleManager

Delegates to tool bar builder

buildToolBar() - Method in interface net.sf.genuine.organizer.internal.InternalModuleManager

Has to build a tool bar based on the initialization of the modules.

buildToolBar(ServiceBroker) - Method in class net.sf.genuine.organizer.internal.ToolBarBuilder

Creates a new JToolBar instance and adds all buttons.

C

CANCEL - Static variable in class net.sf.genuine.resources.DefaultResources

CLOSE - Static variable in class net.sf.genuine.resources.DefaultResources

CLOSE_ALL - Static variable in class net.sf.genuine.resources.DefaultResources

COPY - Static variable in class net.sf.genuine.resources.DefaultResources

CUT - Static variable in class net.sf.genuine.resources.DefaultResources

Channel - interface net.sf.genuine.organizer.Channel.

A channel is part of the framework's messaging system.

ClipboardService - interface net.sf.genuine.services.ClipboardService.

Defines the functionality of a clipboard service that is called by the clipboard actions.

CloseAction - class net.sf.genuine.actions.CloseAction.

Convenience action class that can be used for closing files or documents.

CloseAction(ServiceBroker) - Constructor for class net.sf.genuine.actions.CloseAction

ComponentAdapter - class net.sf.genuine.organizer.ComponentAdapter.

Default implementation of ComponentListener that does nothing.

ComponentAdapter() - Constructor for class net.sf.genuine.organizer.ComponentAdapter

ComponentInstanceManager - class net.sf.genuine.organizer.internal.ComponentInstanceManager.

For each component declared in a configuration file, there is an object of this class that handles the creation of the component instance(s).

ComponentInstanceManager(JFrame, JDesktopPane, FrameLocator, Module, Element) - Constructor for class net.sf.genuine.organizer.internal.ComponentInstanceManager

Takes references to helper objects that are passed later on to status manager objects and a reference to the XML element that defines the component.

ComponentListener - interface net.sf.genuine.organizer.ComponentListener.

Callback listener for modules to be notified when a component is shown/hidden, activated/deactivated.

ComponentManager - interface net.sf.genuine.organizer.ComponentManager.

The component manager is responsible for all graphical components that can be shown, for example, in internal frames.

ComponentStatusManager - class net.sf.genuine.organizer.internal.ComponentStatusManager.

Manages the status of a visual component instance and provides operations to manipulate that status.

ComponentStatusManager(JFrame, JDesktopPane, FrameLocator, Module, String, String, Size) - Constructor for class net.sf.genuine.organizer.internal.ComponentStatusManager

Initialization with module and component id before the module has been initialized.

ComponentStatusManagerInternalFrame - class net.sf.genuine.organizer.internal.ComponentStatusManagerInternalFrame.

Manages the status of a visual component instance that is shown in an internal frame.

ComponentStatusManagerInternalFrame(JFrame, JDesktopPane, FrameLocator, Module, String, String, Size) - Constructor for class net.sf.genuine.organizer.internal.ComponentStatusManagerInternalFrame

ComponentStatusManagerModalFrame - class net.sf.genuine.organizer.internal.ComponentStatusManagerModalFrame.

Manages the status of a visual component instance that is shown in a modal JDialog instance.

ComponentStatusManagerModalFrame(JFrame, JDesktopPane, FrameLocator, Module, String, String, Size) - Constructor for class net.sf.genuine.organizer.internal.ComponentStatusManagerModalFrame

ConfigurationEntityResolver - class net.sf.genuine.tools.ConfigurationEntityResolver.

Implementation of org.xml.sax.EntityResolver that makes it possible to use DTDs in XML files that are not stored in files but processed on the fly.

ConfigurationEntityResolver() - Constructor for class net.sf.genuine.tools.ConfigurationEntityResolver

ConfigurationException - exception net.sf.genuine.exceptions.ConfigurationException.

Exception that is thrown when an error happend during Genuine's configuration phase.

ConfigurationException(String) - Constructor for class net.sf.genuine.exceptions.ConfigurationException

ConfigurationException(Throwable) - Constructor for class net.sf.genuine.exceptions.ConfigurationException

ConfigurationException(String, Throwable) - Constructor for class net.sf.genuine.exceptions.ConfigurationException

CopyAction - class net.sf.genuine.actions.CopyAction.

An action that delegates a user's request to copy something either to all active ClipboardService instances or to a specific ClipboardService instance that is passed in the constructor.

CopyAction(ServiceBroker) - Constructor for class net.sf.genuine.actions.CopyAction

Passes an instance of the service broker to fetch and call all active, registered clipboard services when the action is performed.

CopyAction(ClipboardService) - Constructor for class net.sf.genuine.actions.CopyAction

Passes an instance of the ClipboardService to be called when the action is performed.

CutAction - class net.sf.genuine.actions.CutAction.

An action that delegates a user's request to cut something either to all active ClipboardService instances or to a specific ClipboardService instance that is passed in the constructor.

CutAction(ServiceBroker) - Constructor for class net.sf.genuine.actions.CutAction

Passes an instance of the service broker and calls all active, registered clipboard services when the action is performed.

CutAction(ClipboardService) - Constructor for class net.sf.genuine.actions.CutAction

Passes an instance of the ClipboardService and calls it when the action is performed.

centerWindow(Window) - Static method in class net.sf.genuine.tools.GuiTools

Puts the given frame into the center of the screen.

changeComponentTitle(String) - Method in class net.sf.genuine.organizer.AbstractComponent

Changes the title of this component by calling the component manager.

changeComponentTitle(String, String, String, String) - Method in interface net.sf.genuine.organizer.ComponentManager

Changes the title of the component that is identified by the given module id, component id, and instance id.

changeComponentTitle(String, String) - Method in class net.sf.genuine.organizer.internal.ComponentInstanceManager

Changes the title of the component

changeComponentTitle(String) - Method in class net.sf.genuine.organizer.internal.ComponentStatusManager

Changes the title of the component

changeComponentTitle(String) - Method in class net.sf.genuine.organizer.internal.ComponentStatusManagerInternalFrame

changeComponentTitle(String) - Method in class net.sf.genuine.organizer.internal.ComponentStatusManagerModalFrame

changeComponentTitle(String, String, String, String) - Method in class net.sf.genuine.organizer.internal.DefaultComponentManager

Changes the title of the component

checkVetoableMessage(Message) - Method in interface net.sf.genuine.organizer.MessageListener

Called to let the listener check whether is would accept the given message.

clear() - Method in class net.sf.genuine.resources.ResourceManager

Removes all resources.

close() - Method in interface net.sf.genuine.services.DocumentService

Closes a document and performs appropriate operations.

componentActivated(String, String, String) - Method in class net.sf.genuine.organizer.AbstractComponent

Default call-back implementation that is called when this component is activated.

componentActivated(String, String, String) - Method in class net.sf.genuine.organizer.ComponentAdapter

componentActivated(String, String, String) - Method in interface net.sf.genuine.organizer.ComponentListener

Called when a component has been activated, i.e. has just received focus.

componentDeactivated(String, String, String) - Method in class net.sf.genuine.organizer.AbstractComponent

Default call-back implementation that is called when this component is deactivated.

componentDeactivated(String, String, String) - Method in class net.sf.genuine.organizer.ComponentAdapter

componentDeactivated(String, String, String) - Method in interface net.sf.genuine.organizer.ComponentListener

Called when a component has been deactivated, i.e. has just lost focus.

componentHidden(String, String, String) - Method in class net.sf.genuine.organizer.AbstractComponent

Default call-back implementation that is called when this component is hidden.

componentHidden(String, String, String) - Method in class net.sf.genuine.organizer.ComponentAdapter

componentHidden(String, String, String) - Method in interface net.sf.genuine.organizer.ComponentListener

Called when a component has just been hidden.

componentId - Variable in class net.sf.genuine.organizer.internal.ComponentStatusManager

componentShown(String, String, String) - Method in class net.sf.genuine.organizer.AbstractComponent

Default call-back implementation that is called when this component is shown.

componentShown(String, String, String) - Method in class net.sf.genuine.organizer.ComponentAdapter

componentShown(String, String, String) - Method in interface net.sf.genuine.organizer.ComponentListener

Called when a component has been made visible.

copy() - Method in interface net.sf.genuine.services.ClipboardService

A 'copy' operation should be performed.

createGui() - Method in class net.sf.genuine.preferences.PreferencesComponent

Creates the GUI.

createJButton() - Method in class net.sf.genuine.organizer.internal.ToolBarButton

Create a single toolbar button that is initialized by an action object that is requested from the module by its id.

createJMenuBar() - Method in class net.sf.genuine.organizer.internal.MenuBar

Creates the JMenuBar object

createJMenuItem() - Method in class net.sf.genuine.organizer.internal.Menu

Returns a JMenu instance filled with JMenuItem entries corresponding to the menu / menu items defined by all modules.

createJMenuItem() - Method in class net.sf.genuine.organizer.internal.MenuItem

Create a single menu item that is initialized by an action object that is requested from the module by its id.

createJToolBar() - Method in class net.sf.genuine.organizer.internal.ToolBar

Creates an instance of JToolBar and fills it with JButton instances according to the tool bar definitions from all modules.

createNew() - Method in interface net.sf.genuine.services.DocumentService

Creates a new document and performs appropriate operations.

createObject(String) - Static method in class net.sf.genuine.tools.Reflection

Creates an instance of the class whose name is passed.

createPropertiesMap(Element) - Static method in class net.sf.genuine.tools.XML

Creates a hash map containing properities (key/value pairs) and property sets (key/set of values pairs) from the given XML "properties" element.

createVisualComponent(String, String) - Method in class net.sf.genuine.organizer.AbstractModule

Default implementation does nothing.

createVisualComponent(String, String) - Method in interface net.sf.genuine.organizer.Module

If the XML configuration data for the module includes visual components, the component manager will call this method to fetch the components.

createVisualComponent() - Method in class net.sf.genuine.organizer.internal.ComponentStatusManager

Lets the module create the visual component and checks it.

createVisualComponent(String, String) - Method in class net.sf.genuine.preferences.PreferencesModule

Creates the preferences component.

cut() - Method in interface net.sf.genuine.services.ClipboardService

A 'cut' operation should be performed.

D

DELETE - Static variable in class net.sf.genuine.resources.DefaultResources

DefaultActionModule - class net.sf.genuine.actions.DefaultActionModule.

Module that creates all actions that are commonly used in most applications.

DefaultActionModule() - Constructor for class net.sf.genuine.actions.DefaultActionModule

DefaultChannel - class net.sf.genuine.organizer.internal.DefaultChannel.

Default implementation of a channel.

DefaultChannel(String) - Constructor for class net.sf.genuine.organizer.internal.DefaultChannel

DefaultComponentManager - class net.sf.genuine.organizer.internal.DefaultComponentManager.

Manager for the visual components of all modules.

DefaultComponentManager() - Constructor for class net.sf.genuine.organizer.internal.DefaultComponentManager

DefaultExitService - class net.sf.genuine.organizer.internal.DefaultExitService.

The default exit service just calls System.exit to close the application.

DefaultExitService(HelperService) - Constructor for class net.sf.genuine.organizer.internal.DefaultExitService

DefaultHelperService - class net.sf.genuine.organizer.internal.DefaultHelperService.

Default implementation of helper service.

DefaultHelperService() - Constructor for class net.sf.genuine.organizer.internal.DefaultHelperService

DefaultMessageBus - class net.sf.genuine.organizer.internal.DefaultMessageBus.

Default implementation of message bus

DefaultMessageBus() - Constructor for class net.sf.genuine.organizer.internal.DefaultMessageBus

DefaultModuleManager - class net.sf.genuine.organizer.internal.DefaultModuleManager.

Default implementation of Genuine's module manager.

DefaultModuleManager() - Constructor for class net.sf.genuine.organizer.internal.DefaultModuleManager

Initializes all components

DefaultPreferencesService - class net.sf.genuine.preferences.DefaultPreferencesService.

Default implementation of the preferences service.

DefaultPreferencesService(String) - Constructor for class net.sf.genuine.preferences.DefaultPreferencesService

DefaultResources - class net.sf.genuine.resources.DefaultResources.

Contains declarations of all default resources.

DefaultResources() - Constructor for class net.sf.genuine.resources.DefaultResources

DefaultServiceBroker - class net.sf.genuine.organizer.internal.DefaultServiceBroker.

Default implementation of Genuine's service broker.

DefaultServiceBroker() - Constructor for class net.sf.genuine.organizer.internal.DefaultServiceBroker

DocumentService - interface net.sf.genuine.services.DocumentService.

This standard service handles opening, saving, and closing documents.

defaultButton - Variable in class net.sf.genuine.organizer.internal.ComponentStatusManager

deregisterMessageListener(MessageListener) - Method in interface net.sf.genuine.organizer.Channel

Deregisters the given message listener so that it won't receive any messages any more.

deregisterMessageListener(MessageListener) - Method in class net.sf.genuine.organizer.internal.DefaultChannel

desktopPane - Variable in class net.sf.genuine.organizer.internal.ComponentStatusManager

E

EDIT - Static variable in class net.sf.genuine.resources.DefaultResources

EMPTY - Static variable in class net.sf.genuine.resources.DefaultResources

ERRORMESSAGE - Static variable in class net.sf.genuine.resources.DefaultResources

EXIT - Static variable in class net.sf.genuine.resources.DefaultResources

EXIT_CONFIRM - Static variable in class net.sf.genuine.resources.DefaultResources

ExitAction - class net.sf.genuine.actions.ExitAction.

This action exits the application by invoking the exit service (@link net.sf.genuine.services.ExitService}.

ExitAction(ServiceBroker) - Constructor for class net.sf.genuine.actions.ExitAction

Initializes the action with 'exit' resources

ExitService - interface net.sf.genuine.services.ExitService.

Interface for a service that is responsible to shut down the application.

embeddComponent() - Method in class net.sf.genuine.organizer.internal.ComponentStatusManager

Creates a frame (internal or modal) and embeds the visual component in it.

embeddComponent() - Method in class net.sf.genuine.organizer.internal.ComponentStatusManagerInternalFrame

embeddComponent() - Method in class net.sf.genuine.organizer.internal.ComponentStatusManagerModalFrame

exitApplication() - Method in class net.sf.genuine.organizer.internal.DefaultExitService

exitApplication() - Method in interface net.sf.genuine.services.ExitService

When this method is called, the application will terminate.

F

FILE - Static variable in class net.sf.genuine.resources.DefaultResources

FORMAT - Static variable in class net.sf.genuine.resources.DefaultResources

FrameLocator - class net.sf.genuine.organizer.internal.FrameLocator.

A helper class that determines the best spot to locate a new frame on a desktop.

FrameLocator(JDesktopPane) - Constructor for class net.sf.genuine.organizer.internal.FrameLocator

Initialization by passing the desktop pane that contains all existing frames.

fetchServices(Module, Element) - Method in class net.sf.genuine.organizer.internal.DefaultServiceBroker

The service broker has to fetch all services defined by the given module and keep them internally for later access.

fetchServices(Module, Element) - Method in interface net.sf.genuine.organizer.internal.InternalServiceBroker

The service broker has to fetch all services defined by the given module and keep them internally for later access.

fireComponentActivated() - Method in class net.sf.genuine.organizer.internal.ComponentStatusManager

fireComponentDeactivated() - Method in class net.sf.genuine.organizer.internal.ComponentStatusManager

fireComponentHidden() - Method in class net.sf.genuine.organizer.internal.ComponentStatusManager

fireComponentShown() - Method in class net.sf.genuine.organizer.internal.ComponentStatusManager

format(LogRecord) - Method in class net.sf.genuine.logging.OneLineFormatter

Formats a log record.

frameLocator - Variable in class net.sf.genuine.organizer.internal.ComponentStatusManager

G

GENERAL - Static variable in class net.sf.genuine.resources.DefaultResources

GenuineAction - class net.sf.genuine.swing.GenuineAction.

Action class that is the super class for all action used by Genuine.

GenuineAction(String) - Constructor for class net.sf.genuine.swing.GenuineAction

Takes the name of a resource item that contains information about the action's text, image, and shortcut.

GenuineAction(ResourceItem) - Constructor for class net.sf.genuine.swing.GenuineAction

Takes a resource item and initializes itself from the item's properties.

GenuineButton - class net.sf.genuine.swing.GenuineButton.

Sub class of JButton that is connected to a GenuineAction.

GenuineButton(GenuineAction) - Constructor for class net.sf.genuine.swing.GenuineButton

GenuineException - exception net.sf.genuine.exceptions.GenuineException.

Super class for all exceptions thrown by Genuine.

GenuineException() - Constructor for class net.sf.genuine.exceptions.GenuineException

GenuineException(String) - Constructor for class net.sf.genuine.exceptions.GenuineException

GenuineException(String, Throwable) - Constructor for class net.sf.genuine.exceptions.GenuineException

GenuineException(Throwable) - Constructor for class net.sf.genuine.exceptions.GenuineException

GenuineMenu - class net.sf.genuine.swing.GenuineMenu.

Sub class of JMenu that contains extra logic for menu items that are connected to resource items.

GenuineMenu(String) - Constructor for class net.sf.genuine.swing.GenuineMenu

Takes an identifier that is used to look up a ResourceItem object.

GenuineMenu(String, boolean) - Constructor for class net.sf.genuine.swing.GenuineMenu

Takes an identifier that is used to look up a ResourceItem object.

GenuineMenuItem - class net.sf.genuine.swing.GenuineMenuItem.

Sub class of JMenuItem that contains extra logic for menu items that are based on GenuineAction objects.

GenuineMenuItem(GenuineAction) - Constructor for class net.sf.genuine.swing.GenuineMenuItem

Initialization only with a GenuineAction object.

GenuineRuntimeException - exception net.sf.genuine.exceptions.GenuineRuntimeException.

Super class for all runtime exceptions thrown by genuine.

GenuineRuntimeException() - Constructor for class net.sf.genuine.exceptions.GenuineRuntimeException

GenuineRuntimeException(String) - Constructor for class net.sf.genuine.exceptions.GenuineRuntimeException

GenuineRuntimeException(String, Throwable) - Constructor for class net.sf.genuine.exceptions.GenuineRuntimeException

GenuineRuntimeException(Throwable) - Constructor for class net.sf.genuine.exceptions.GenuineRuntimeException

GuiTools - class net.sf.genuine.tools.GuiTools.

Misc tools related to user interfaces

GuiTools() - Constructor for class net.sf.genuine.tools.GuiTools

getAction(String) - Method in class net.sf.genuine.organizer.AbstractModule

Implementation of the Module's getAction method that returns GenuineAction instances that have been registered by calling AbstractModule.registerAction(GenuineAction).

getAction(String) - Method in interface net.sf.genuine.organizer.Module

Must return an instance of GenuineAction for each action identifier that is refered to in the module's definition of the application's configuration file.

getAction(String) - Method in interface net.sf.genuine.organizer.ModuleManager

Returns the GenuineAction instance with the given identifier if such an action has been registered by any module.

getAction(String) - Method in class net.sf.genuine.organizer.internal.DefaultModuleManager

Returns the first action instance in any module with the given name.

getAction() - Method in class net.sf.genuine.organizer.internal.Item

Returns the action instance that is referred to by this objects id by retrieving it from the module.

getActiveServices(Class) - Method in interface net.sf.genuine.organizer.ServiceBroker

Returns all services of the given type that are currently active.

getActiveServices(Class) - Method in class net.sf.genuine.organizer.internal.DefaultServiceBroker

Returns a list of all active services of the given type.

getBehindOfItemId() - Method in class net.sf.genuine.organizer.internal.Item

This menu item may have declared to be put behind another menu item.

getButtonsResourceItems() - Method in class net.sf.genuine.resources.MessageResourceItem

Returns a list of ResourceItem objects that has to be used to add buttons to the message box.

getChannel(String) - Method in interface net.sf.genuine.organizer.MessageBus

Returns an existing channel with the given name if such a channel exists, null otherwise.

getChannel(String) - Method in class net.sf.genuine.organizer.internal.DefaultMessageBus

Returns an existing channel with the given name if such a channel exists, null otherwise.

getChoices() - Method in class net.sf.genuine.resources.ResourceItem

Returns a list of String objects that define other resource items to be used, for example, as buttons in a message box.

getChosenResourceItem() - Method in class net.sf.genuine.organizer.internal.MessageBox

Returns the resource item of the button the user has pressed.

getCommand() - Method in class net.sf.genuine.organizer.Message

Returns the message's command.

getComponentId() - Method in class net.sf.genuine.organizer.AbstractComponent

Returns the component id.

getComponentId() - Method in interface net.sf.genuine.organizer.VisualComponent

Returns the component's identifier.

getComponentManager() - Method in class net.sf.genuine.organizer.AbstractComponent

Convenience method for the component manager

getComponentManager() - Method in class net.sf.genuine.organizer.AbstractModule

Convenience method that returns the component manager

getComponentManager() - Method in interface net.sf.genuine.organizer.ModuleManager

Returns a reference to the component manager instance.

getComponentManager() - Method in class net.sf.genuine.organizer.internal.DefaultModuleManager

Returns a reference to the component manager instance.

getData() - Method in class net.sf.genuine.organizer.Message

Returns the optional data.

getExplanatoryResourceItem() - Method in class net.sf.genuine.organizer.MessageVetoException

Returns a resource item that contains explanatory text for the user if such an item has been passed.

getFrame() - Method in class net.sf.genuine.Organizer

Returns a reference to the main JFrame instance.

getHeight() - Method in class net.sf.genuine.organizer.internal.Size

Returns the height.

getHelperService() - Method in class net.sf.genuine.organizer.AbstractComponent

Convenience method for the helper service

getHelperService() - Method in class net.sf.genuine.organizer.AbstractModule

Convenience method that returns the helper service

getHelperService() - Method in interface net.sf.genuine.organizer.ModuleManager

Returns a reference to the helper service instance.

getHelperService() - Method in class net.sf.genuine.organizer.internal.DefaultModuleManager

Returns a reference to the helper service instance.

getIcon() - Method in class net.sf.genuine.resources.MessageResourceItem

Returns an icon to be shown in the message box.

getId() - Method in class net.sf.genuine.organizer.AbstractModule

Returns this module's id.

getId() - Method in interface net.sf.genuine.organizer.Module

Must return the id passed to the initialize method.

getId() - Method in class net.sf.genuine.organizer.internal.Item

Returns the menu item's id.

getId() - Method in class net.sf.genuine.swing.GenuineAction

Returns the resource-based id of this action.

getIdentificationPath() - Method in class net.sf.genuine.preferences.PreferencesPage

Has to return a path that identifies this preferences page.

getIdentificationPath() - Method in class net.sf.genuine.preferences.general.AppearancePreferencesPage

getImage() - Method in class net.sf.genuine.resources.ResourceItem

Returns an image if one is defined for this resource item, null otherwise.

getImageIcon(String) - Static method in class net.sf.genuine.tools.Images

Loads an icon that must be accessible on the class path.

getInFrontOfItemId() - Method in class net.sf.genuine.organizer.internal.Item

This menu item may have declared to be put in front of another menu item.

getInstance() - Static method in class net.sf.genuine.resources.ResourceManager

Returns an instance to the single object

getInstanceId() - Method in class net.sf.genuine.organizer.AbstractComponent

Returns the instance id of this component.

getInstanceId() - Method in interface net.sf.genuine.organizer.VisualComponent

Returns the instance id of this component.

getKeyStroke() - Method in class net.sf.genuine.resources.ResourceItem

Returns the KeyStroke instance to be used as accelerator for this resource item if one is defined, null otherwise.

getLargeImage() - Method in class net.sf.genuine.resources.ResourceItem

Returns a large image if one is defined for this resource item, null otherwise.

getLogger(Object) - Static method in class net.sf.genuine.logging.Logging

Returns a logger object that is initialized with the package name of the calling object's class.

getMessageBus() - Method in class net.sf.genuine.organizer.AbstractComponent

Convenience method for the message bus

getMessageBus() - Method in class net.sf.genuine.organizer.AbstractModule

Convenience method that returns the message bus

getMessageBus() - Method in interface net.sf.genuine.organizer.ModuleManager

Returns a reference to the message bus instance.

getMessageBus() - Method in class net.sf.genuine.organizer.internal.DefaultModuleManager

Returns a reference to the message bus instance.

getMnemonic() - Method in class net.sf.genuine.resources.ResourceItem

Returns a character that is used as mnemonic.

getModuleId() - Method in class net.sf.genuine.organizer.AbstractComponent

Returns the id of the module this component belongs to.

getModuleId() - Method in interface net.sf.genuine.organizer.VisualComponent

Returns the id of the module this component belongs to.

getModuleManager() - Method in class net.sf.genuine.Organizer

Returns a reference to the module manager

getModuleManager() - Method in class net.sf.genuine.organizer.AbstractComponent

Convenience method for the module manager

getModuleManager() - Method in class net.sf.genuine.organizer.AbstractModule

Convenience method that returns the module manager

getName() - Method in class net.sf.genuine.resources.ResourceItem

Returns the name of the resource item with which it can be fetched.

getPreferences(String) - Method in class net.sf.genuine.preferences.DefaultPreferencesService

getPreferences(String) - Method in interface net.sf.genuine.preferences.PreferencesService

Returns a Preferences object using which the preference settings for a PreferencesPage may be retrieved and stored.

getProperty(String) - Method in class net.sf.genuine.organizer.AbstractModule

Returns the value for a property that was passed to the initialize method.

getResourceItem() - Method in class net.sf.genuine.preferences.PreferencesPage

Returns the resource item that is associated with the last part of the identification path.

getResourceItem(String) - Method in class net.sf.genuine.resources.ResourceManager

Returns a ResourceItem if one has been initialized for the given name.

getResourceItems(String[]) - Method in class net.sf.genuine.resources.ResourceManager

Returns an array of ResourceItem objects that corresponds to the array of resource item names.

getService(Class) - Method in class net.sf.genuine.organizer.AbstractModule

Implementation of the Module's getService method that returns Service instances that were registered by using the method AbstractModule.registerService(Class, Service).

getService(Class) - Method in interface net.sf.genuine.organizer.Module

If the module has defined to provide services in its configuration file, the service broker will call this method with the defined classes as parameter to fetch the service instances.

getService(Class) - Method in interface net.sf.genuine.organizer.ServiceBroker

Returns a Service instance of the given type that is currently active.

getService(Class) - Method in class net.sf.genuine.organizer.internal.DefaultServiceBroker

Returns the first registered service of the given type.

getServiceBroker() - Method in class net.sf.genuine.organizer.AbstractComponent

Returns the reference to the service broker.

getServiceBroker() - Method in class net.sf.genuine.organizer.AbstractModule

Convenience method that returns the service broker.

getServiceBroker() - Method in interface net.sf.genuine.organizer.ModuleManager

Returns a reference to the service broker instance.

getServiceBroker() - Method in class net.sf.genuine.organizer.internal.DefaultModuleManager

Returns a reference to the service broker instance.

getServices(Class) - Method in interface net.sf.genuine.organizer.ServiceBroker

Returns all services of the given type that are registered.

getServices(Class) - Method in class net.sf.genuine.organizer.internal.DefaultServiceBroker

Returns a list of all services of the given type.

getStaticLogger() - Static method in class net.sf.genuine.logging.Logging

Returns a logger object that should only be used inside static content where there is no referring object available, as the returned logger object is initialized with the logger's package.

getText() - Method in class net.sf.genuine.resources.MessageResourceItem

Returns the message text into which given parameters are already inserted.

getText() - Method in class net.sf.genuine.resources.ResourceItem

Returns the text of this resource item if one is defined, an empty string otherwise.

getTitle() - Method in class net.sf.genuine.resources.MessageResourceItem

Returns the title of the message box.

getTitle() - Method in class net.sf.genuine.resources.ResourceItem

Returns the title of this resource item that is used as title for the application window or for message boxes.

getToolbarButtonsPreference(ServiceBroker) - Static method in class net.sf.genuine.preferences.general.AppearancePreferencesPage

Returns the currently set preference for toolbar buttons by querying the preferences service as long as that service has been created and registered by the preferences module.

getTooltip() - Method in class net.sf.genuine.resources.ResourceItem

Returns the tool tip for this resource item if one is defined, an empty string otherwise.

getType() - Method in class net.sf.genuine.resources.ResourceItem

Returns the type of this resource item.

getWidth() - Method in class net.sf.genuine.organizer.internal.Size

Returns the width.

H

HELP - Static variable in class net.sf.genuine.resources.DefaultResources

HelperService - interface net.sf.genuine.organizer.HelperService.

The helper service provides various services to modules that are not implemented anywhere else.

HideComponentAction - class net.sf.genuine.actions.HideComponentAction.

Objects of this action class are initialized with a module id and a component id and request the component manager to hide the refered component whenever they are activated.

HideComponentAction(ComponentManager, String, String, String) - Constructor for class net.sf.genuine.actions.HideComponentAction

Initialization

helperService - Variable in class net.sf.genuine.preferences.PreferencesPage

hide() - Method in class net.sf.genuine.organizer.internal.ComponentStatusManager

Makes the window in which the component is embedded invisible.

hide() - Method in class net.sf.genuine.organizer.internal.ComponentStatusManagerInternalFrame

hide() - Method in class net.sf.genuine.organizer.internal.ComponentStatusManagerModalFrame

hideComponent() - Method in class net.sf.genuine.organizer.AbstractComponent

Hides this component by calling the component manager

hideComponent(String, String, String) - Method in interface net.sf.genuine.organizer.ComponentManager

Hides the component that is identified by the given module id, component id, and instance id.

hideComponent(String) - Method in class net.sf.genuine.organizer.internal.ComponentInstanceManager

Hides the visual component.

hideComponent(String, String, String) - Method in class net.sf.genuine.organizer.internal.DefaultComponentManager

Hides a visual component.

I

IDENTIFICATION_PATH - Static variable in class net.sf.genuine.preferences.general.AppearancePreferencesPage

The identification path for this preferences page.

INFO - Static variable in class net.sf.genuine.resources.DefaultResources

Images - class net.sf.genuine.tools.Images.

Helper methods to manage images.

Images() - Constructor for class net.sf.genuine.tools.Images

InternalComponentManager - interface net.sf.genuine.organizer.internal.InternalComponentManager.

Extension to ComponentManager interface that contains functionality for interal usage only.

InternalHelperService - interface net.sf.genuine.organizer.internal.InternalHelperService.

Extension to HelperService interface that contains functionality for interal usage only.

InternalMessageBus - interface net.sf.genuine.organizer.internal.InternalMessageBus.

Defines the functionality of the message bus that is used only inside Genuine and not meant for public usage by modules.

InternalModuleManager - interface net.sf.genuine.organizer.internal.InternalModuleManager.

As an extension to the public interface ModuleManager, this interface defines internal functionality of the module manager that is not visible to modules but is needed during the start-up phase.

InternalServiceBroker - interface net.sf.genuine.organizer.internal.InternalServiceBroker.

Defines the functionality of the service broker that is used only inside Genuine and not meant for public usage by modules.

Item - class net.sf.genuine.organizer.internal.Item.

Base class for all objects that are used by the MenuBarBuilder and the ToolBarBuilder.

Item() - Constructor for class net.sf.genuine.organizer.internal.Item

Empty

Item(Element) - Constructor for class net.sf.genuine.organizer.internal.Item

Reads all information from the given XML element

Item(Module, Element) - Constructor for class net.sf.genuine.organizer.internal.Item

Takes a item element and a reference to the module.

initialize(String, ModuleManager, Map) - Method in class net.sf.genuine.actions.DefaultActionModule

Creates and registers all action instances that are commonly used.

initialize(String, ModuleManager, Map) - Method in class net.sf.genuine.organizer.AbstractModule

The references to the passed parameters are stored locally.

initialize(String, ModuleManager, Map) - Method in interface net.sf.genuine.organizer.Module

Called by the ModuleManager to let the module initialize itself.

initialize(String, ModuleManager, Map) - Method in class net.sf.genuine.preferences.PreferencesModule

Initializes both the service and the dialog.

initializeChannels(Element) - Method in class net.sf.genuine.organizer.internal.DefaultMessageBus

initializeChannels(Element) - Method in interface net.sf.genuine.organizer.internal.InternalMessageBus

Takes an XML element that contains configuration data about the message channels.

initializeModules(Element, ProgressTracker) - Method in class net.sf.genuine.organizer.internal.DefaultModuleManager

Creates and initializes the modules.

initializeModules(Element, ProgressTracker) - Method in interface net.sf.genuine.organizer.internal.InternalModuleManager

Has to create and initializes all modules that are defined by the given XML element "modules".

instanceId - Variable in class net.sf.genuine.organizer.internal.ComponentStatusManager

isActive() - Method in interface net.sf.genuine.organizer.Service

Returns true if this service is currently active.

isActive() - Method in class net.sf.genuine.organizer.internal.DefaultExitService

This service is always active.

isActive() - Method in class net.sf.genuine.preferences.DefaultPreferencesService

The service is always active.

isCommand(String) - Method in class net.sf.genuine.organizer.Message

Compares this message's command string with the given command string and returns true only if they match.

isErrorMessage() - Method in class net.sf.genuine.resources.MessageResourceItem

Returns true if this message is an error message.

isInfoMessage() - Method in class net.sf.genuine.resources.MessageResourceItem

Returns true if this message is an information message.

isMaximized() - Method in class net.sf.genuine.organizer.internal.Size

Returns true if size is declared to take all available space.

isResourceItemAvailable(String) - Method in class net.sf.genuine.resources.ResourceManager

Returns true if there is a resource item with the given name.

isSeparatorBehind() - Method in class net.sf.genuine.organizer.internal.Item

Returns true if a separator should appear behind this menu item.

isSeparatorInFront() - Method in class net.sf.genuine.organizer.internal.Item

Returns true if a separator should appear in front of this menu item.

isStatusMessage() - Method in class net.sf.genuine.resources.MessageResourceItem

Returns true if this message is a status message.

isWarningMessage() - Method in class net.sf.genuine.resources.MessageResourceItem

Returns true if this message is a warning message.

L

Logging - class net.sf.genuine.logging.Logging.

Helper class for logging.

Logging() - Constructor for class net.sf.genuine.logging.Logging

loadDocumentFromClasspath(String) - Static method in class net.sf.genuine.tools.XML

Loads the XML document refered to by the given filename and returns a Document instance.

locateFrame(JInternalFrame) - Method in class net.sf.genuine.organizer.internal.FrameLocator

Positions the given frame on the desktop by setting appropriate coordinates.

M

MESSAGEBOX_ERROR - Static variable in class net.sf.genuine.resources.DefaultResources

MESSAGEBOX_INFO - Static variable in class net.sf.genuine.resources.DefaultResources

MESSAGEBOX_WARNING - Static variable in class net.sf.genuine.resources.DefaultResources

Menu - class net.sf.genuine.organizer.internal.Menu.

Implementation class that belongs to MenuBarBuilder.

Menu() - Constructor for class net.sf.genuine.organizer.internal.Menu

Empty

Menu(Module, Element, boolean) - Constructor for class net.sf.genuine.organizer.internal.Menu

Creates a new menu and adds all menu items that the given element contains.

MenuBar - class net.sf.genuine.organizer.internal.MenuBar.

Implementation class that belongs to MenuBarBuilder.

MenuBar() - Constructor for class net.sf.genuine.organizer.internal.MenuBar

Empty

MenuBarBuilder - class net.sf.genuine.organizer.internal.MenuBarBuilder.

Builder that takes the menu bar definitions of all modules one after the other and builds a menu bar incorporating the menu and menu item definitions from all modules.

MenuBarBuilder() - Constructor for class net.sf.genuine.organizer.internal.MenuBarBuilder

MenuItem - class net.sf.genuine.organizer.internal.MenuItem.

Implementation class that belongs to MenuBarBuilder.

MenuItem() - Constructor for class net.sf.genuine.organizer.internal.MenuItem

Empty

MenuItem(Element) - Constructor for class net.sf.genuine.organizer.internal.MenuItem

Reads all information from menu item

MenuItem(Module, Element) - Constructor for class net.sf.genuine.organizer.internal.MenuItem

Takes a menu item element and a reference to the module.

Message - class net.sf.genuine.organizer.Message.

A message is part of the framework's messaging system and are intended to be sent to message channels.

Message(String) - Constructor for class net.sf.genuine.organizer.Message

Creates a new message with the given command, without a data object.

Message(String, Object) - Constructor for class net.sf.genuine.organizer.Message

Creates a new message with the given command and a data object.

MessageBox - class net.sf.genuine.organizer.internal.MessageBox.

A message box is a modal dialog that shows a message to the user.

MessageBox(Frame, MessageResourceItem) - Constructor for class net.sf.genuine.organizer.internal.MessageBox

Initializes a message box with a message.

MessageBus - interface net.sf.genuine.organizer.MessageBus.

The message bus is Genuine's main means for communication between modules.

MessageListener - interface net.sf.genuine.organizer.MessageListener.

Every object that would like to receive messages sent to a channel has to implement this interface and register at the channel.

MessageResourceItem - class net.sf.genuine.resources.MessageResourceItem.

A MessageResourceItem is a wrapper for a ResourceItem object that performs checks on the values of the resource item: The resource item's type must be either "info", "warning", or "error".

MessageResourceItem(ResourceItem) - Constructor for class net.sf.genuine.resources.MessageResourceItem

Initializes a Message object with the values of a resource item.

MessageResourceItem(ResourceItem, Object[]) - Constructor for class net.sf.genuine.resources.MessageResourceItem

Initializes a Message object with the values of a resource item and an array of parameters that have to be inserted into the message text.

MessageVetoException - exception net.sf.genuine.organizer.MessageVetoException.

This exception is thrown if a message listener files a veto against a message.

MessageVetoException() - Constructor for class net.sf.genuine.organizer.MessageVetoException

Creates a new exception

MessageVetoException(ResourceItem) - Constructor for class net.sf.genuine.organizer.MessageVetoException

Creates a new exception that includes a resource item which contains explanatory text for the user.

MessageVetoException(String) - Constructor for class net.sf.genuine.organizer.MessageVetoException

Creates a new exception that includes a resource item which contains explanatory text for the user.

Module - interface net.sf.genuine.organizer.Module.

A module defines a self-contained part of a client application that runs inside the Organizer.

ModuleManager - interface net.sf.genuine.organizer.ModuleManager.

The module manager both creates, initializes, and destroys module instances and it provides access to all Organizer services to the modules.

main(String[]) - Static method in class net.sf.genuine.Organizer

Starts the organizer.

mainFrame - Variable in class net.sf.genuine.organizer.internal.ComponentStatusManager

maximizeWindow(Window) - Static method in class net.sf.genuine.tools.GuiTools

Sets the size of the given window to the desktop size.

module - Variable in class net.sf.genuine.organizer.internal.ComponentStatusManager

N

NEW - Static variable in class net.sf.genuine.resources.DefaultResources

NO - Static variable in class net.sf.genuine.resources.DefaultResources

NewAction - class net.sf.genuine.actions.NewAction.

Convenience action class that can be used for creating new files or documents.

NewAction(ServiceBroker) - Constructor for class net.sf.genuine.actions.NewAction

net.sf.genuine - package net.sf.genuine

The Organizer class is Genuine's central mechanism to start a client application.

net.sf.genuine.actions - package net.sf.genuine.actions

Genuine provides Action classes for functionality that is common to many client applications.

net.sf.genuine.exceptions - package net.sf.genuine.exceptions

Genuine internally uses two exception classes for all its exceptions: GenuineException for checked exceptions and GenuineRuntimeException for unchecked exceptions.

net.sf.genuine.logging - package net.sf.genuine.logging

Logging is done using the JDK's own logging facilities.

net.sf.genuine.organizer - package net.sf.genuine.organizer

This package contains all classes and interfaces a client application needs to use Genuine.

net.sf.genuine.organizer.internal - package net.sf.genuine.organizer.internal

Internal interfaces and the organizer's default implementation.

net.sf.genuine.preferences - package net.sf.genuine.preferences

Contains the infrastructure for storing preferences, including a preferences dialog.

net.sf.genuine.preferences.general - package net.sf.genuine.preferences.general

Contains general preferences pages that may be used by any application.

net.sf.genuine.resources - package net.sf.genuine.resources

Resources like texts, images, tooltips, etc., are first-level artefacts.

net.sf.genuine.services - package net.sf.genuine.services

Genuine defines default services that are common to many client applications each of which comes with default actions defined in the net.sf.genuine.actions package.

net.sf.genuine.swing - package net.sf.genuine.swing

Some of Swing's classes had to be enhanced to fit into the framework.

net.sf.genuine.tools - package net.sf.genuine.tools

This package contains helper classes and tools that don't fit anywhere else.

O

OK - Static variable in class net.sf.genuine.resources.DefaultResources

OPEN - Static variable in class net.sf.genuine.resources.DefaultResources

OneLineFormatter - class net.sf.genuine.logging.OneLineFormatter.

Formatter for Jdk 1.4's logging service that uses a single line for each log record.

OneLineFormatter() - Constructor for class net.sf.genuine.logging.OneLineFormatter

Constructor

OpenAction - class net.sf.genuine.actions.OpenAction.

Convenience action class that can be used for opening files or documents.

OpenAction(ServiceBroker) - Constructor for class net.sf.genuine.actions.OpenAction

OperationFailedException - exception net.sf.genuine.exceptions.OperationFailedException.

Exception that is thrown when the invoked operation has failed, and the reason for failure is not of particular concern.

OperationFailedException(String) - Constructor for class net.sf.genuine.exceptions.OperationFailedException

OperationFailedException(Throwable) - Constructor for class net.sf.genuine.exceptions.OperationFailedException

OperationFailedException(String, Throwable) - Constructor for class net.sf.genuine.exceptions.OperationFailedException

Organizer - class net.sf.genuine.Organizer.

The Organizer is the main class of the Genuine framework.

Organizer(String) - Constructor for class net.sf.genuine.Organizer

Takes the name of the XML configuration file.

Organizer(Document) - Constructor for class net.sf.genuine.Organizer

Takes a JDOM document instance.

open() - Method in interface net.sf.genuine.services.DocumentService

Opens a document and performs appropriate operations.

P

PASTE - Static variable in class net.sf.genuine.resources.DefaultResources

PREFERENCES - Static variable in class net.sf.genuine.resources.DefaultResources

PREFERENCES_COMPONENT - Static variable in class net.sf.genuine.resources.DefaultResources

PREFERENCES_RESET - Static variable in class net.sf.genuine.resources.DefaultResources

PREF_TOOLBAR_BUTTONS - Static variable in class net.sf.genuine.preferences.general.AppearancePreferencesPage

Key for the preference setting that controls whether text labels are shown in the tool bar.

PREF_TOOLBAR_BUTTONS_ICONS - Static variable in class net.sf.genuine.preferences.general.AppearancePreferencesPage

PREF_TOOLBAR_BUTTONS_ICONSTEXT - Static variable in class net.sf.genuine.preferences.general.AppearancePreferencesPage

PREF_TOOLBAR_BUTTONS_TEXT - Static variable in class net.sf.genuine.preferences.general.AppearancePreferencesPage

PRINT - Static variable in class net.sf.genuine.resources.DefaultResources

PasteAction - class net.sf.genuine.actions.PasteAction.

An action that delegates a user's request to paste something either to all active ClipboardService instances or to a specific ClipboardService instance that is passed in the constructor.

PasteAction(ServiceBroker) - Constructor for class net.sf.genuine.actions.PasteAction

Passes an instance of the service broker and calls all active, registered clipboard services when the action is performed.

PasteAction(ClipboardService) - Constructor for class net.sf.genuine.actions.PasteAction

Passes an instance of the ClipboardService and calls it when the action is performed.

PreferencesComponent - class net.sf.genuine.preferences.PreferencesComponent.

This visual component provides the component in which an arbitrary number of PreferencesPage instances may be embedded.

PreferencesComponent(String, String, String, ModuleManager, PreferencesService) - Constructor for class net.sf.genuine.preferences.PreferencesComponent

Initialization by passing all default parameters.

PreferencesModule - class net.sf.genuine.preferences.PreferencesModule.

The preferences module creates both the preferences service and the preferences dialog that may be used by all applications.

PreferencesModule() - Constructor for class net.sf.genuine.preferences.PreferencesModule

PreferencesPage - class net.sf.genuine.preferences.PreferencesPage.

A preferences page is a Swing panel that is meant to provide preferences options to the user.

PreferencesPage() - Constructor for class net.sf.genuine.preferences.PreferencesPage

PreferencesService - interface net.sf.genuine.preferences.PreferencesService.

The preference service provides the means to retrieve a Preferences object to store and query its preference values.

ProgressTracker - interface net.sf.genuine.organizer.internal.ProgressTracker.

A progress tracker is an interface for a progress bar that shows the progress of initializing an application.

paste() - Method in interface net.sf.genuine.services.ClipboardService

A 'paste' operation should be performed.

postInitialize() - Method in class net.sf.genuine.organizer.AbstractModule

Default implementation that does nothing.

postInitialize() - Method in interface net.sf.genuine.organizer.Module

Called by the module manager when all modules have been fully initialized but the organizer frame is not yet visible.

postInitialize() - Method in class net.sf.genuine.organizer.internal.ComponentInstanceManager

Post initilization.

postInitialize(Module) - Method in class net.sf.genuine.organizer.internal.DefaultComponentManager

After the module has been initialized, the visual component instances can be fetched from the modules.

postInitialize() - Method in class net.sf.genuine.organizer.internal.DefaultModuleManager

The modules may perform late initialization operations.

postInitialize(Module) - Method in interface net.sf.genuine.organizer.internal.InternalComponentManager

After the module has been initialized, the components themselves can be fetched from the modules.

postInitialize() - Method in interface net.sf.genuine.organizer.internal.InternalModuleManager

The modules may perform late initialization operations.

R

REDO - Static variable in class net.sf.genuine.resources.DefaultResources

REFRESH - Static variable in class net.sf.genuine.resources.DefaultResources

RESET - Static variable in class net.sf.genuine.resources.DefaultResources

Reflection - class net.sf.genuine.tools.Reflection.

Provides helper methods for reflection usage.

Reflection() - Constructor for class net.sf.genuine.tools.Reflection

ResourceItem - class net.sf.genuine.resources.ResourceItem.

A resource item encapsulates all available information about a resource, i.e. its name, description, icon, tool tip, etc.

ResourceItem(String) - Constructor for class net.sf.genuine.resources.ResourceItem

Creates a new instance with all attributes set to default values

ResourceManager - class net.sf.genuine.resources.ResourceManager.

This class manages all resources that are defined in property files.

receiveMessage(Message) - Method in interface net.sf.genuine.organizer.MessageListener

Callback method that is executed when a message has been sent to the listener.

registerAction(GenuineAction) - Method in class net.sf.genuine.organizer.AbstractModule

Helper method for modules to register actions so that the module manager may retrieve them by calling AbstractModule.getAction(String).

registerComponents(Module, String, Element) - Method in class net.sf.genuine.organizer.internal.DefaultComponentManager

Reads the declaration of visual components and creates a ComponentInstanceManager object for each component.

registerComponents(Module, String, Element) - Method in interface net.sf.genuine.organizer.internal.InternalComponentManager

Reads the declaration of visual components and creates a ComponentStatusManager object for each component.

registerMessageListener(MessageListener) - Method in interface net.sf.genuine.organizer.Channel

Registers the given message listener to retrieve all upcoming messages.

registerMessageListener(MessageListener) - Method in class net.sf.genuine.organizer.internal.DefaultChannel

registerPreferencesPages(PreferencesPage) - Method in class net.sf.genuine.preferences.PreferencesComponent

All panels are registered internally.

registerService(Class, Service) - Method in class net.sf.genuine.organizer.AbstractModule

Helper method for modules to register service instances so that the service broker may retrieve them by calling AbstractModule.getService(Class).

registerService(Class, Service) - Method in class net.sf.genuine.organizer.internal.DefaultServiceBroker

Adds the given service.

registerService(Class, Service) - Method in interface net.sf.genuine.organizer.internal.InternalServiceBroker

Manualy adds the given service.

removeComponentListener(String, String, String, ComponentListener) - Method in class net.sf.genuine.organizer.AbstractComponent

Removes a component listener for this component by calling the component manager.

removeComponentListener(String, String, String, ComponentListener) - Method in interface net.sf.genuine.organizer.ComponentManager

Removes a listener from the component that is identified by the given module id, component id, and instance id.

removeComponentListener(String, ComponentListener) - Method in class net.sf.genuine.organizer.internal.ComponentInstanceManager

Removes a listener from a component.

removeComponentListener(ComponentListener) - Method in class net.sf.genuine.organizer.internal.ComponentStatusManager

Removes a ComponentListener from the component.

removeComponentListener(String, String, String, ComponentListener) - Method in class net.sf.genuine.organizer.internal.DefaultComponentManager

Removes a listener from a component.

resetPreferences() - Method in class net.sf.genuine.preferences.PreferencesComponent

Causes the visible panel to reset its preferences.

resetPreferences() - Method in class net.sf.genuine.preferences.PreferencesPage

When this method is called, the page has to reset all preferences to their default settings.

resetPreferences() - Method in class net.sf.genuine.preferences.general.AppearancePreferencesPage

resolveEntity(String, String) - Method in class net.sf.genuine.tools.ConfigurationEntityResolver

Takes a system identifier and returns an input source that reads from the file denoted by the identifier.

restorePreferences() - Method in class net.sf.genuine.preferences.PreferencesComponent

Causes all panels to restore their settings.

restorePreferences(Preferences) - Method in class net.sf.genuine.preferences.PreferencesPage

When this method is called, the page has to update its graphical components so that their values match the preferences stored in the given Preferences object.

restorePreferences(Preferences) - Method in class net.sf.genuine.preferences.general.AppearancePreferencesPage

S

SAVE - Static variable in class net.sf.genuine.resources.DefaultResources

SAVE_AS - Static variable in class net.sf.genuine.resources.DefaultResources

SEARCH - Static variable in class net.sf.genuine.resources.DefaultResources

SaveAction - class net.sf.genuine.actions.SaveAction.

Convenience action class that can be used for saving files or documents.

SaveAction(ServiceBroker) - Constructor for class net.sf.genuine.actions.SaveAction

Service - interface net.sf.genuine.organizer.Service.

Services are used by modules to provide functionality to other modules without binding them to the module's class.

ServiceBroker - interface net.sf.genuine.organizer.ServiceBroker.

The service broker provides access to all services created by the modules.

ServiceNotFoundException - exception net.sf.genuine.services.ServiceNotFoundException.

Runtime exception that should be thrown by a module that relies on a specific service that should have been registered but could not been found.

ServiceNotFoundException(String) - Constructor for class net.sf.genuine.services.ServiceNotFoundException

ServiceNotFoundException(Throwable) - Constructor for class net.sf.genuine.services.ServiceNotFoundException

ServiceNotFoundException(String, Throwable) - Constructor for class net.sf.genuine.services.ServiceNotFoundException

ShowComponentAction - class net.sf.genuine.actions.ShowComponentAction.

Objects of this action class are initialized with a module id and a component id and request the component manager to hide the refered component whenever they are activated.

ShowComponentAction(String, ComponentManager, String, String) - Constructor for class net.sf.genuine.actions.ShowComponentAction

Initialization

Size - class net.sf.genuine.organizer.internal.Size.

Encapsulation of a size declaration in an configuration file.

Size(Element) - Constructor for class net.sf.genuine.organizer.internal.Size

Initialization by XML element.

SplashScreen - class net.sf.genuine.organizer.internal.SplashScreen.

A splash screen is a window that is shown during initialization of the client application.

SplashScreen(ResourceItem) - Constructor for class net.sf.genuine.organizer.internal.SplashScreen

Initializes the splash screen and locates it in the middle of the screen.

save() - Method in interface net.sf.genuine.services.DocumentService

Saves a document and performs appropriate operations.

sendMessage(Message) - Method in interface net.sf.genuine.organizer.Channel

Sends a fire-and-forget message that is forwarded to all message listener.

sendMessage(Message) - Method in class net.sf.genuine.organizer.internal.DefaultChannel

sendVetoableMessage(Message) - Method in interface net.sf.genuine.organizer.Channel

Sends a vetoable message.

sendVetoableMessage(Message) - Method in class net.sf.genuine.organizer.internal.DefaultChannel

setCurrentValue(int) - Method in interface net.sf.genuine.organizer.internal.ProgressTracker

Sets the current value that has to be in between 0 and max value.

setCurrentValue(int) - Method in class net.sf.genuine.organizer.internal.SplashScreen

setDefaultButton(GenuineButton) - Method in class net.sf.genuine.organizer.AbstractComponent

Sets the given button as default button

setDefaultButton(String, String, String, GenuineButton) - Method in interface net.sf.genuine.organizer.ComponentManager

Sets the given button as default button of the frame into which the component that is identified by the given module id, component id, and instance id is embedded.

setDefaultButton(String, GenuineButton) - Method in class net.sf.genuine.organizer.internal.ComponentInstanceManager

Sets the given button as default button of the frame into which the component is embedded

setDefaultButton(GenuineButton) - Method in class net.sf.genuine.organizer.internal.ComponentStatusManager

Sets the given button as default button of the frame into which the component is embedded

setDefaultButton(GenuineButton) - Method in class net.sf.genuine.organizer.internal.ComponentStatusManagerInternalFrame

setDefaultButton(GenuineButton) - Method in class net.sf.genuine.organizer.internal.ComponentStatusManagerModalFrame

setDefaultButton(String, String, String, GenuineButton) - Method in class net.sf.genuine.organizer.internal.DefaultComponentManager

Sets the given button as default button of the frame into which the component is embedded

setDesktopComponents(JFrame, JDesktopPane) - Method in class net.sf.genuine.organizer.internal.DefaultComponentManager

Reference to desktop components are stored for later usage.

setDesktopComponents(Frame, JLabel) - Method in class net.sf.genuine.organizer.internal.DefaultHelperService

Takes the info label

setDesktopComponents(JFrame, JDesktopPane, JLabel) - Method in class net.sf.genuine.organizer.internal.DefaultModuleManager

Component manager and helper service need reference to desktop pane.

setDesktopComponents(JFrame, JDesktopPane) - Method in interface net.sf.genuine.organizer.internal.InternalComponentManager

Reference to desktop components are stored for later usage.

setDesktopComponents(Frame, JLabel) - Method in interface net.sf.genuine.organizer.internal.InternalHelperService

Reference to desktop components are stored for later usage.

setDesktopComponents(JFrame, JDesktopPane, JLabel) - Method in interface net.sf.genuine.organizer.internal.InternalModuleManager

Passes references to desktop components.

setHelperService(HelperService) - Method in class net.sf.genuine.preferences.PreferencesPage

Set the helper service.

setIconAndText(boolean) - Method in class net.sf.genuine.swing.GenuineButton

After calling this method, the button shows both icon and text.

setIconOnly() - Method in class net.sf.genuine.swing.GenuineButton

After calling this method, the button shows only the icon.

setMaxValue(int) - Method in interface net.sf.genuine.organizer.internal.ProgressTracker

Sets the maximum value that equals 100%.

setMaxValue(int) - Method in class net.sf.genuine.organizer.internal.SplashScreen

setTextOnly() - Method in class net.sf.genuine.swing.GenuineButton

After calling this method, the button shows only text.

setVisible(boolean) - Method in class net.sf.genuine.organizer.internal.MessageBox

Puts the dialog in the middle of the screen.

shouldMenuEntriesShowIcons() - Method in class net.sf.genuine.organizer.internal.Menu

Returns whether the menu entris of this menu should show icons.

shouldMenuEntriesShowIcons() - Method in class net.sf.genuine.organizer.internal.MenuBar

The entries of the menu bar should not show icons.

show() - Method in class net.sf.genuine.organizer.internal.ComponentStatusManager

Makes the window in which the component is embedded visible.

show() - Method in class net.sf.genuine.organizer.internal.ComponentStatusManagerInternalFrame

show() - Method in class net.sf.genuine.organizer.internal.ComponentStatusManagerModalFrame

showComponent() - Method in class net.sf.genuine.organizer.AbstractComponent

Shows this component by calling the component manager

showComponent(String, String) - Method in interface net.sf.genuine.organizer.ComponentManager

Shows the visual component that is identified by the given module id and component id.

showComponent(String, String, String) - Method in interface net.sf.genuine.organizer.ComponentManager

Shows the visual component that is identified by the given module id, component id, and instance id.

showComponent() - Method in class net.sf.genuine.organizer.internal.ComponentInstanceManager

Shows a visual component.

showComponent(String) - Method in class net.sf.genuine.organizer.internal.ComponentInstanceManager

Shows the visual component.

showComponent(String, String) - Method in class net.sf.genuine.organizer.internal.DefaultComponentManager

Shows a visual component.

showComponent(String, String, String) - Method in class net.sf.genuine.organizer.internal.DefaultComponentManager

Shows a visual component.

showException(Exception) - Method in interface net.sf.genuine.organizer.HelperService

Shows the reason for an exception in a message box and prints the stack trace in the console.

showException(Exception) - Method in class net.sf.genuine.organizer.internal.DefaultHelperService

Shows the error message of an exception in a dialog.

showMessage(String) - Method in interface net.sf.genuine.organizer.HelperService

Shows an message that is defined by the given resource item.

showMessage(ResourceItem) - Method in interface net.sf.genuine.organizer.HelperService

Shows an message that is defined by the given resource item.

showMessage(String, Object[]) - Method in interface net.sf.genuine.organizer.HelperService

See HelperService.showMessage(ResourceItem) for general information about showing a message.

showMessage(ResourceItem, Object[]) - Method in interface net.sf.genuine.organizer.HelperService

See HelperService.showMessage(ResourceItem) for general information about showing a message.

showMessage(String) - Method in class net.sf.genuine.organizer.internal.DefaultHelperService

Fetches the resource item, creates a message and shows it.

showMessage(ResourceItem) - Method in class net.sf.genuine.organizer.internal.DefaultHelperService

Creates a message and shows it.

showMessage(String, Object[]) - Method in class net.sf.genuine.organizer.internal.DefaultHelperService

Fetches the resource item, creates a message including the given parameters and shows the message.

showMessage(ResourceItem, Object[]) - Method in class net.sf.genuine.organizer.internal.DefaultHelperService

Creates a message including the given parameters and shows the message.

showMessageRestartNeeded() - Method in class net.sf.genuine.preferences.PreferencesPage

Shows a message box that informs the user that the application has to be restarted in order the new preferences to have effect.

size - Variable in class net.sf.genuine.organizer.internal.ComponentStatusManager

storePreferences() - Method in class net.sf.genuine.preferences.PreferencesComponent

Causes all panels to store their settings.

storePreferences(Preferences) - Method in class net.sf.genuine.preferences.PreferencesPage

When this method is called, the page has to update the given Preferences object with the current values of the graphical components.

storePreferences(Preferences) - Method in class net.sf.genuine.preferences.general.AppearancePreferencesPage

T

ToolBar - class net.sf.genuine.organizer.internal.ToolBar.

Implementation class that belongs to ToolbarBuilder.

ToolBar() - Constructor for class net.sf.genuine.organizer.internal.ToolBar

Empty tool bar

ToolBarBuilder - class net.sf.genuine.organizer.internal.ToolBarBuilder.

Builder that takes the tool bar definitions of all modules one after the other and builds a tool bar incorporating the button definitions from all modules.

ToolBarBuilder() - Constructor for class net.sf.genuine.organizer.internal.ToolBarBuilder

ToolBarButton - class net.sf.genuine.organizer.internal.ToolBarButton.

Implementation class that belongs to ToolbarBuilder.

ToolBarButton(Module, Element) - Constructor for class net.sf.genuine.organizer.internal.ToolBarButton

Takes a toolbar button element and a reference to the module.

toString() - Method in class net.sf.genuine.organizer.internal.ComponentStatusManager

toString() - Method in class net.sf.genuine.organizer.internal.DefaultChannel

Prints the name of the channel

toString() - Method in class net.sf.genuine.resources.ResourceItem

Prints its text.

U

UNDO - Static variable in class net.sf.genuine.resources.DefaultResources

V

VIEW - Static variable in class net.sf.genuine.resources.DefaultResources

VisualComponent - interface net.sf.genuine.organizer.VisualComponent.

This interface must be implemented by all graphical components so that they can be managed by Genuine.

W

WINDOW - Static variable in class net.sf.genuine.resources.DefaultResources

X

XML - class net.sf.genuine.tools.XML.

Helper methods for XML processing with JDOM

XML() - Constructor for class net.sf.genuine.tools.XML

Y

YES - Static variable in class net.sf.genuine.resources.DefaultResources

A B C D E F G H I L M N O P R S T U V W X Y