Package com.jalios.jcms.policy
Class BasicWizardPolicyFilter
- java.lang.Object
-
- com.jalios.jcms.policy.AbstractPolicyFilter
-
- com.jalios.jcms.policy.BasicWizardPolicyFilter
-
- All Implemented Interfaces:
PluginComponent
,PolicyFilter
,WizardPolicyFilter
,java.lang.Comparable
public class BasicWizardPolicyFilter extends AbstractPolicyFilter implements WizardPolicyFilter, PluginComponent
This class provides hooks for wizard actions:- Since:
- jcms-5.7.3
- Author:
- Jean-Philippe Encausse
-
-
Field Summary
-
Fields inherited from class com.jalios.jcms.policy.AbstractPolicyFilter
order
-
-
Constructor Summary
Constructors Constructor Description BasicWizardPolicyFilter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
afterWizard(WizardContext ctxt)
Performs actions after the Wizard process.boolean
beforeWizard(WizardContext ctxt)
Performs actions before the Wizard process.java.lang.String
handleCategoryName(java.lang.String computedName, Category cat, WizardContext ctxt)
Handle custom name for the given category.boolean
init(Plugin plugin)
Initialize the component with the given plugin configuration-
Methods inherited from class com.jalios.jcms.policy.AbstractPolicyFilter
compareTo, equals, getOrder, setOrder
-
-
-
-
Method Detail
-
init
public boolean init(Plugin plugin)
Description copied from interface:PluginComponent
Initialize the component with the given plugin configuration- Specified by:
init
in interfacePluginComponent
- Parameters:
plugin
- the calling plugin- Returns:
- true if the component has been correctly initialized.
- Since:
- jcms-5.7.3
- See Also:
PluginComponent.init(Plugin)
-
beforeWizard
public boolean beforeWizard(WizardContext ctxt)
Description copied from interface:WizardPolicyFilter
Performs actions before the Wizard process.- Specified by:
beforeWizard
in interfaceWizardPolicyFilter
- Parameters:
ctxt
- the WizardContext- Returns:
- boolean true to stop the Wizard process
- See Also:
WizardPolicyFilter.beforeWizard(WizardContext)
-
afterWizard
public void afterWizard(WizardContext ctxt)
Description copied from interface:WizardPolicyFilter
Performs actions after the Wizard process.- Specified by:
afterWizard
in interfaceWizardPolicyFilter
- Parameters:
ctxt
- the WizardContext- See Also:
WizardPolicyFilter.afterWizard(WizardContext)
-
handleCategoryName
public java.lang.String handleCategoryName(java.lang.String computedName, Category cat, WizardContext ctxt)
Description copied from interface:WizardPolicyFilter
Handle custom name for the given category. when it will be referenced If the Category.getName() is the same than computed category then the category will be referenced (not duplicated)- Specified by:
handleCategoryName
in interfaceWizardPolicyFilter
- Parameters:
computedName
- the target computed category namecat
- the working category to duplicatectxt
- the WizardContext- Returns:
- String the modified computed category name
- Since:
- jcms-5.7.5
- See Also:
WizardPolicyFilter.handleCategoryName(String, Category, WizardContext)
-
-