uk.ac.essex.common.action
Interface ActionService

All Superinterfaces:

Service

All Known Implementing Classes:

ActionServiceImpl

public interface ActionService
extends Service

Created Date: 01-Nov-2003

You should have received a copy of Lesser GNU public license with this code. If not please visit this site

Method Summary

void	add(java.io.File actionXMLFile, KeyMap keyMap) Adds all the XML files from the given directory
void	add(java.lang.String actionXMLFile, KeyMap keyMap) Adds all the XML files from the given directory
void	addAll(java.io.File actionXMLDir, KeyMap keyMap) Adds all the XML files from the given directory
javax.swing.Action	get(java.lang.String actionId, java.util.Locale currentLocale)
javax.swing.Action	getAction(java.lang.String actionId)
javax.swing.Action	getAction(java.lang.String actionId, java.util.Locale currentLocale)
ActionDescriptor	getAction(java.lang.String appId, java.lang.String actionId)
ActionDescriptor	getActionDescriptor(java.lang.String actionId)
ActionGroupDescriptor	getActionGroup(java.lang.String actionGroupId)
ActionGroupDescriptor[]	getActionGroups(java.lang.String appId)
ActionDescriptor[]	getToolbarActions(java.lang.String appId) Getts all the actions for the given application and toolbar

Methods inherited from interface uk.ac.essex.common.Service

destroy, initialise

Method Detail

add

void add(java.io.File actionXMLFile,
         KeyMap keyMap)
         throws XMLParseException,
                java.io.FileNotFoundException

Adds all the XML files from the given directory

Parameters:

actionXMLFile - - Must be a file

keyMap -

Throws:

XMLParseException - - If actionXMLFile is not a file or it cannot parse the file

java.io.FileNotFoundException

add

void add(java.lang.String actionXMLFile,
         KeyMap keyMap)
         throws XMLParseException

Adds all the XML files from the given directory

Parameters:

actionXMLFile - - Must be a file

keyMap -

Throws:

XMLParseException - - If actionXMLFile is not a file or it cannot parse the file

addAll

void addAll(java.io.File actionXMLDir,
            KeyMap keyMap)
            throws XMLParseException,
                   java.io.FileNotFoundException

Adds all the XML files from the given directory

Parameters:

actionXMLDir - - Must be a directory

keyMap -

Throws:

XMLParseException - - If actionXMLDir is not a directory or it cannot parse any of the files in that directory

java.io.FileNotFoundException

get

javax.swing.Action get(java.lang.String actionId,
                       java.util.Locale currentLocale)
                       throws ActionCreationException

Parameters:

actionId -

currentLocale -

Returns:

Throws:

ActionCreationException

getActionDescriptor

ActionDescriptor getActionDescriptor(java.lang.String actionId)

Parameters:

actionId -

Returns:

getAction

javax.swing.Action getAction(java.lang.String actionId)

Parameters:

actionId -

Returns:

getAction

javax.swing.Action getAction(java.lang.String actionId,
                             java.util.Locale currentLocale)

Parameters:

actionId -

currentLocale -

Returns:

getActionGroup

ActionGroupDescriptor getActionGroup(java.lang.String actionGroupId)

Parameters:

actionGroupId -

Returns:

getAction

ActionDescriptor getAction(java.lang.String appId,
                           java.lang.String actionId)

Parameters:

appId -

actionId -

Returns:

getToolbarActions

ActionDescriptor[] getToolbarActions(java.lang.String appId)

Getts all the actions for the given application and toolbar

Parameters:

appId -

Returns:

getActionGroups

ActionGroupDescriptor[] getActionGroups(java.lang.String appId)