freemind.extensions
Class HookDescriptorPluginAction

java.lang.Object
  extended by freemind.extensions.HookDescriptorBase
      extended by freemind.extensions.HookDescriptorPluginAction

public class HookDescriptorPluginAction
extends HookDescriptorBase

This is an information class that holds all outer properties of a hook, i.e. all contents of the XML description file. Don't use this class for anything except for the implementation of a HookFactory.

Author:
foltin

Field Summary
 java.util.Vector menuPositions
           
 
Fields inherited from class freemind.extensions.HookDescriptorBase
frame, FREEMIND_BASE_DIR_STRING, mXmlPluginFile, pluginBase
 
Constructor Summary
HookDescriptorPluginAction(FreeMindMain frame, java.lang.String xmlPluginFile, freemind.controller.actions.generated.instance.Plugin pluginBase, freemind.controller.actions.generated.instance.PluginAction pluginAction)
           
 
Method Summary
 java.lang.String getBaseClass()
           
 java.lang.String getClassName()
           
 java.lang.String getDocumentation()
           
 java.lang.String getIconPath()
           
 HookInstanciationMethod getInstanciationMethod()
           
 java.lang.String getKeyStroke()
           
 java.util.Vector getModes()
           
 java.lang.String getName()
           
 java.util.Properties getProperties()
           
 boolean isSelectable()
           
 java.lang.String toString()
           
 
Methods inherited from class freemind.extensions.HookDescriptorBase
getFromPropertiesIfNecessary, getFromResourceIfNecessary, getPluginBase, getPluginClassLoader, getPluginClasspath
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

menuPositions

public java.util.Vector menuPositions
Constructor Detail

HookDescriptorPluginAction

public HookDescriptorPluginAction(FreeMindMain frame,
                                  java.lang.String xmlPluginFile,
                                  freemind.controller.actions.generated.instance.Plugin pluginBase,
                                  freemind.controller.actions.generated.instance.PluginAction pluginAction)
Method Detail

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getInstanciationMethod

public HookInstanciationMethod getInstanciationMethod()

getModes

public java.util.Vector getModes()

getBaseClass

public java.lang.String getBaseClass()

getName

public java.lang.String getName()

getClassName

public java.lang.String getClassName()

getDocumentation

public java.lang.String getDocumentation()

getIconPath

public java.lang.String getIconPath()

getKeyStroke

public java.lang.String getKeyStroke()

getProperties

public java.util.Properties getProperties()

isSelectable

public boolean isSelectable()
Returns:
whether or not the plugin can be on/off and this should be displayed in the menus.