Class MergeStrings
- java.lang.Object
-
- ca.cgjennings.apps.arkham.project.TaskAction
-
- ca.cgjennings.apps.arkham.project.TaskActionTree
-
- ca.cgjennings.apps.arkham.project.MergeStrings
-
- All Implemented Interfaces:
IconProvider
,java.lang.Iterable<TaskAction>
public class MergeStrings extends TaskActionTree
A task action that loads strings from a string table into the game or UI language. Useful when developing plug-ins that use localized text.- Since:
- 3.0
- Author:
- Chris Jennings
-
-
Constructor Summary
Constructors Constructor Description MergeStrings()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
add(int index, TaskAction ta)
java.lang.String
getLabel()
Returns the human-readable name of this action.protected boolean
isAppliesToShortCircuited()
If this method returnstrue
, then the evaluation ofTaskActionTree.appliesToSelection(ca.cgjennings.apps.arkham.project.Member[])
andTaskActionTree.appliesTo(ca.cgjennings.apps.arkham.project.Project, ca.cgjennings.apps.arkham.project.Task, ca.cgjennings.apps.arkham.project.Member)
will assume that every child action performs the same test.-
Methods inherited from class ca.cgjennings.apps.arkham.project.TaskActionTree
add, appliesTo, appliesToSelection, findActionByName, get, getSectionIndex, indexOf, iterator, perform, remove, remove, size
-
Methods inherited from class ca.cgjennings.apps.arkham.project.TaskAction
applyToChildren, getActionName, getDescription, getIcon, performOnSelection, resolveTarget, toString
-
-
-
-
Method Detail
-
getLabel
public java.lang.String getLabel()
Description copied from class:TaskAction
Returns the human-readable name of this action.- Specified by:
getLabel
in classTaskAction
- Returns:
- the name used to create menu items for this action, localized if possible
-
add
public void add(int index, TaskAction ta)
- Overrides:
add
in classTaskActionTree
-
isAppliesToShortCircuited
protected boolean isAppliesToShortCircuited()
If this method returnstrue
, then the evaluation ofTaskActionTree.appliesToSelection(ca.cgjennings.apps.arkham.project.Member[])
andTaskActionTree.appliesTo(ca.cgjennings.apps.arkham.project.Project, ca.cgjennings.apps.arkham.project.Task, ca.cgjennings.apps.arkham.project.Member)
will assume that every child action performs the same test. Therefore, if the first child action tested does not apply, none of them can apply and the search ends immediately. Otherwise, every child action will be tested to see if it applies until at least one is found that does or they all fail.The base class returns
false
.This action tree returns true since all of its children apply only to .properties files.
- Overrides:
isAppliesToShortCircuited
in classTaskActionTree
- Returns:
true
-
-