com.jalios.jcms.policy
Interface WidgetPolicyFilter

All Superinterfaces:

Comparable, PluginComponent, PolicyFilter

All Known Implementing Classes:

BasicWidgetPolicyFilter

public interface WidgetPolicyFilter
extends PolicyFilter

This class allow users to customize behaviour of widgets by re-writing call-back methods.

Since:

jcms-5.5.0

Version:

$Revision: 33055 $

Author:

Jean-Philippe Encausse

Field Summary

static String

REVISION

Method Summary

String	getTreeCatNodeExtraContent(TreeCat treecat, String extraContent, Category cat, int level, int pubcount) This method is called by TreeCat to append some specific content for each category node or leaf.
String	updateCSS(String css, AbstractWidget widget) This method is called by all widget to update the css configuration.
String	updateHiddenActions(String hiddenActions, AbstractWidget widget) Deprecated.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.jalios.jcms.plugin.PluginComponent

init

Field Detail

REVISION

static final String REVISION

See Also:

Constant Field Values

Method Detail

updateHiddenActions

@Deprecated
String updateHiddenActions(String hiddenActions,
                                      AbstractWidget widget)

Deprecated.

This method is called by all widget to update the hidden actions configuration. This method is usefull to set a custom behavior for all given widget. Remove all: ABCDEFGHIKLMPQRSTUX C - Create S - Select (Pub Chooser) R - Remove T - Trash U - Up / Left D - Down / Right E - Edit A - Add L - Id (data link) K - Calendar I - Image Chooser (upload) X - Doc Chooser M - Media chooser F - Color chooser B - DBRecord chooser Q - Query chooser H - Member chooser G - Group chooser

Parameters:

hiddenActions - the action set to the widget

widget - the calling widget

Returns:

String null or hiddenActions to do nothing otherwise a custom String descripting the hiddenActions

See Also:

AbstractWidget.setHiddenActions(String)

updateCSS

String updateCSS(String css,
                 AbstractWidget widget)

This method is called by all widget to update the css configuration. This method is usefull to set a custom look for all given widget.

Parameters:

css - the current css

widget - the calling widget

Returns:

null or css otherwise a custom String descripting the css

getTreeCatNodeExtraContent

String getTreeCatNodeExtraContent(TreeCat treecat,
                                  String extraContent,
                                  Category cat,
                                  int level,
                                  int pubcount)

This method is called by TreeCat to append some specific content for each category node or leaf. First argument TreeCat is used to retrieve configuration. Otherwise channel.getCurrentServletRequest() may be called to read contextual information.

Parameters:

treecat - the TreeCat calling this method

extraContent - the previous extraContent

cat - the current category

level - the level asked to be displayed

pubcount - the count of publication if it has been calculated

Returns:

String HTML extra content to append to node

See Also:

Channel.getCurrentServletRequest(), TreeCat.getBranch(Category, int)