freemind.modes.browsemode
Class BrowseHookFactory

java.lang.Object
  extended by freemind.extensions.HookFactoryAdapter
      extended by freemind.modes.browsemode.BrowseHookFactory
All Implemented Interfaces:
HookFactory

public class BrowseHookFactory
extends HookFactoryAdapter

Author:
foltin

Nested Class Summary
 
Nested classes/interfaces inherited from interface freemind.extensions.HookFactory
HookFactory.RegistrationContainer
 
Field Summary
 
Fields inherited from class freemind.extensions.HookFactoryAdapter
allRegistrationInstances
 
Constructor Summary
BrowseHookFactory()
           
 
Method Summary
 ModeControllerHook createModeControllerHook(java.lang.String hookName)
           
 NodeHook createNodeHook(java.lang.String hookName)
          Do not call this method directly.
 java.util.List getHookMenuPositions(java.lang.String hookName)
           
 HookInstanciationMethod getInstanciationMethod(java.lang.String hookName)
           
 java.lang.Object getPluginBaseClass(java.lang.String hookName)
          A plugin base class is a common registration class of multiple plugins.
 java.util.Vector getPossibleModeControllerHooks()
           
 java.util.Vector getPossibleNodeHooks()
           
 java.util.List getRegistrations()
          Each Plugin can have a list of HookRegistrations that are called after the corresponding mode is enabled.
 
Methods inherited from class freemind.extensions.HookFactoryAdapter
deregisterAllRegistrationContainer, getHookInNode, registerRegistrationContainer
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BrowseHookFactory

public BrowseHookFactory()
Method Detail

getPossibleNodeHooks

public java.util.Vector getPossibleNodeHooks()
Returns:
a string vector with representatives for plugins.

getPossibleModeControllerHooks

public java.util.Vector getPossibleModeControllerHooks()
Returns:
a string vector with representatives for plugins.

createModeControllerHook

public ModeControllerHook createModeControllerHook(java.lang.String hookName)

createNodeHook

public NodeHook createNodeHook(java.lang.String hookName)
Description copied from interface: HookFactory
Do not call this method directly. Call ModeController.createNodeHook instead.


getHookMenuPositions

public java.util.List getHookMenuPositions(java.lang.String hookName)
Returns:
returns a list of menu position strings for the StructuredMenuHolder.

getInstanciationMethod

public HookInstanciationMethod getInstanciationMethod(java.lang.String hookName)

getRegistrations

public java.util.List getRegistrations()
Description copied from interface: HookFactory
Each Plugin can have a list of HookRegistrations that are called after the corresponding mode is enabled. (Like singletons.) One of these can operate as the pluginBase that is accessible to every normal plugin_action via the getPluginBaseClass method.

Returns:
A list of RegistrationContainer elements. The field hookRegistrationClass of RegistrationContainer is a class that is (probably) of HookRegistration type. You have to register every registration via the registerRegistrationContainer method when instanciated (this is typically done in the ModeController).

getPluginBaseClass

public java.lang.Object getPluginBaseClass(java.lang.String hookName)
Description copied from interface: HookFactory
A plugin base class is a common registration class of multiple plugins. It is useful to embrace several related plugins (example: EncryptedNote -> Registration).

Returns:
the base class if declared and successfully instanciated or NULL.