org.broadleafcommerce.presentation.dialect

Interface BroadleafVariableModifierProcessor

All Superinterfaces:

BroadleafProcessor

All Known Implementing Classes:

AbstractBroadleafVariableModifierProcessor

Deprecated.

instead of using this processor you should instead write a custom org.broadleafcommerce.common.web.expression.BraodleafVariableExpression in combination with th:with if using Thymeleaf

@Deprecated
public interface BroadleafVariableModifierProcessor
extends BroadleafProcessor

Tag processor that modifies the the global variable model if useGlobalScope() is false and local if it's true

Author:

Jay Aisenbrey (cja769)

Field Summary

Fields inherited from interface org.broadleafcommerce.presentation.dialect.BroadleafProcessor

DEFAULT_PRECEDENCE, DEFAULT_PREFIX

Method Summary

Modifier and Type	Method and Description
List<String>	getCollectionModelVariableNamesToAddTo() Deprecated.
Map<String,Object>	populateModelVariables(String tagName, Map<String,String> tagAttributes, BroadleafTemplateContext context) Deprecated.
boolean	useGlobalScope() Deprecated.

Methods inherited from interface org.broadleafcommerce.presentation.dialect.BroadleafProcessor

getName, getPrecedence, getPrefix

Method Detail

useGlobalScope

boolean useGlobalScope()

Deprecated.

Returns:

true if the newModelVars should be added to the global scope (not recommended) or false if they should be added to local scope for this tag

getCollectionModelVariableNamesToAddTo

List<String> getCollectionModelVariableNamesToAddTo()

Deprecated.

Returns:

The list of variables on the model that, if they exist, should have additional values added to the existing list instead of replacing their values

populateModelVariables

Map<String,Object> populateModelVariables(String tagName,
                                          Map<String,String> tagAttributes,
                                          BroadleafTemplateContext context)

Deprecated.

Parameters:

tagName - The name of the tag the event was triggered on

tagAttributes - A map of String to String of all of the attributes on the tag

context - The BroadleafTemplateContext that should be used to perform operations on the tag with

Returns:

the new mode variables that should be added from the tag. The variables are added to local or global scope based on the result of useGlobalScope()