com.jalios.jcms.policy
Class BasicWizardPolicyFilter

java.lang.Object
  extended by com.jalios.jcms.policy.AbstractPolicyFilter
      extended by com.jalios.jcms.policy.BasicWizardPolicyFilter
All Implemented Interfaces:
PluginComponent, PolicyFilter, WizardPolicyFilter, Comparable

public class BasicWizardPolicyFilter
extends AbstractPolicyFilter
implements WizardPolicyFilter, PluginComponent

This class provides hooks for wizard actions:

Since:
jcms-5.7.3
Version:
$Revision: 21265 $
Author:
Jean-Philippe Encausse

Field Summary
static String REVISION
           
 
Fields inherited from class com.jalios.jcms.policy.AbstractPolicyFilter
order
 
Constructor Summary
BasicWizardPolicyFilter()
           
 
Method Summary
 void afterWizard(WizardContext ctxt)
          Performs actions after the Wizard process.
 boolean beforeWizard(WizardContext ctxt)
          Performs actions before the Wizard process.
 String handleCategoryName(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
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Field Detail

REVISION

public static final String REVISION
See Also:
Constant Field Values
Constructor Detail

BasicWizardPolicyFilter

public BasicWizardPolicyFilter()
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 interface PluginComponent
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 interface WizardPolicyFilter
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 interface WizardPolicyFilter
Parameters:
ctxt - the WizardContext
See Also:
WizardPolicyFilter.afterWizard(WizardContext)

handleCategoryName

public String handleCategoryName(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 interface WizardPolicyFilter
Parameters:
computedName - the target computed category name
cat - the working category to duplicate
ctxt - the WizardContext
Returns:
String the modified computed category name
Since:
jcms-5.7.5
See Also:
WizardPolicyFilter.handleCategoryName(String, Category, WizardContext)


Copyright © 2001-2010 Jalios SA. All Rights Reserved.