Package ca.cgjennings.apps.arkham.project

Class ConvertSpellingDictionary.Converter

java.lang.Object

ca.cgjennings.apps.arkham.project.TaskAction

ca.cgjennings.apps.arkham.project.ConvertSpellingDictionary.Converter

All Implemented Interfaces:

IconProvider

Enclosing class:

ConvertSpellingDictionary

public static class ConvertSpellingDictionary.Converter
extends TaskAction

Constructor Summary

Constructors

Constructor	Description
Converter(java.lang.String description, java.lang.String extension)

Method Summary

Modifier and Type	Method	Description
boolean	appliesTo(Project project, Task task, Member member)	Returns true if this action can be performed on the specified member of a project, project or a task.
java.lang.String	getActionName()	Returns a unique internal name for this action.
java.lang.String	getLabel()	Returns the human-readable name of this action.
boolean	perform(Project project, Task task, Member member)	Perform this action on a member of a project, a project or a task.

Methods inherited from class ca.cgjennings.apps.arkham.project.TaskAction

appliesToSelection, applyToChildren, getDescription, getIcon, performOnSelection, resolveTarget, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Converter

public Converter(java.lang.String description,
                 java.lang.String extension)

Method Detail

appliesTo

public boolean appliesTo(Project project,
                         Task task,
                         Member member)

Description copied from class: TaskAction

Returns true if this action can be performed on the specified member of a project, project or a task. If the project itself is the target, task and member will be null. If a task is the target, then member will be null. If an error occurs while executing the task, then it is the action's responsibility to inform the user. This method can return false to indicate that if the action is being applied to multiple members, it should stop immediately rather than continue to the next member.

Specified by:

appliesTo in class TaskAction

Parameters:

project - the project that is being acted upon

task - the task within the project that is being acted upon; null if acting on a project

member - the specific member within the task to act upon; null if this is a project or task

getLabel

public java.lang.String getLabel()

Description copied from class: TaskAction

Returns the human-readable name of this action.

Specified by:

getLabel in class TaskAction

Returns:

the name used to create menu items for this action, localized if possible

getActionName

public java.lang.String getActionName()

Description copied from class: TaskAction

Returns a unique internal name for this action. Actions can be looked up by this name. The default implementation returns the class name, converted to lowercase.

Overrides:

getActionName in class TaskAction

Returns:

the internal name of this action

perform

public boolean perform(Project project,
                       Task task,
                       Member member)

Description copied from class: TaskAction

Perform this action on a member of a project, a project or a task. If the project itself is the target, task and member will be null. If a task is the target, then member will be null. If an error occurs while executing the task, then it is the action's responsibility to inform the user. This method can return false to indicate that if the action is being applied to multiple members, it should stop immediately rather than continue to the next member.

Specified by:

perform in class TaskAction

Parameters:

project - the project that is being acted upon

task - the task within the project that is being acted upon; null if acting on a project

member - the specific member within the task to act upon; null if this is a project or task