info.magnolia.ui.dialog.setup

Class DialogMigrationTask

java.lang.Object

info.magnolia.module.delta.AbstractTask

info.magnolia.ui.dialog.setup.DialogMigrationTask

All Implemented Interfaces:

info.magnolia.module.delta.Task

public class DialogMigrationTask
extends info.magnolia.module.delta.AbstractTask

Dialog migration main task.
Migrate all dialogs defined within the specified module.

Field Summary

Fields inherited from class info.magnolia.module.delta.AbstractTask

DO_NOTHING

Constructor Summary

Constructors

Constructor and Description
DialogMigrationTask(String moduleName)
DialogMigrationTask(String taskName, String taskDescription, String moduleName)
DialogMigrationTask(String taskName, String taskDescription, String moduleName, HashMap<String,ControlMigrator> customControlsToMigrate, HashMap<String,List<ActionCreator>> customDialogActionsToMigrate)

Method Summary

Modifier and Type	Method and Description
protected void	addCustomControlsToMigrate(HashMap<String,ControlMigrator> controlsToMigrate) Override this method in order to register custom controls to migrate.
protected void	addCustomDialogActionToCreate(HashMap<String,List<ActionCreator>> dialogActionsToMigrate) Override this method in order to register custom actions to create on a specific dialog.
void	execute(info.magnolia.module.InstallContext installContext) Handle all Dialogs registered and migrate them.

Methods inherited from class info.magnolia.module.delta.AbstractTask

getDescription, getName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DialogMigrationTask

public DialogMigrationTask(String taskName,
                           String taskDescription,
                           String moduleName,
                           HashMap<String,ControlMigrator> customControlsToMigrate,
                           HashMap<String,List<ActionCreator>> customDialogActionsToMigrate)

Parameters:

taskName - name of the task

taskDescription - short decription of the task

moduleName - all dialog define under this module name will be migrated.

customControlsToMigrate - Custom controls to migrate.

customDialogActionsToMigrate - Custom actions to migrate

DialogMigrationTask

public DialogMigrationTask(String taskName,
                           String taskDescription,
                           String moduleName)

DialogMigrationTask

public DialogMigrationTask(String moduleName)

Method Detail

execute

public void execute(info.magnolia.module.InstallContext installContext)
             throws info.magnolia.module.delta.TaskExecutionException

Handle all Dialogs registered and migrate them.

Throws:

info.magnolia.module.delta.TaskExecutionException

addCustomControlsToMigrate

protected void addCustomControlsToMigrate(HashMap<String,ControlMigrator> controlsToMigrate)

Override this method in order to register custom controls to migrate.
In case a control name is already define in the default map, the old control migrator is replaced by the newly registered control migrator.

Parameters:

controlsToMigrate - key : controls name
value : ControlMigrator used to take actions in order to migrate the control into a field.

addCustomDialogActionToCreate

protected void addCustomDialogActionToCreate(HashMap<String,List<ActionCreator>> dialogActionsToMigrate)

Override this method in order to register custom actions to create on a specific dialog.

Parameters:

dialogActionsToMigrate - key: Dialog name
value: List of ActionCreator to create on the desired dialog.