org.broadleafcommerce.presentation.dialect

Interface BroadleafTagTextModifierProcessor

All Superinterfaces:

BroadleafProcessor

All Known Implementing Classes:

AbstractBroadleafTagTextModifierProcessor

public interface BroadleafTagTextModifierProcessor
extends BroadleafProcessor

An attribute processor that is used to modify (and replace) the text contents of the tag it's used on

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
String	getTagText(String tagName, Map<String,String> tagAttributes, String attributeName, String attributeValue, BroadleafTemplateContext context)
boolean	textShouldBeProcessed()

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

getName, getPrecedence, getPrefix

Method Detail

textShouldBeProcessed

boolean textShouldBeProcessed()

Returns:

true if the text needs to be processed by the templating framework else false

getTagText

String getTagText(String tagName,
                  Map<String,String> tagAttributes,
                  String attributeName,
                  String attributeValue,
                  BroadleafTemplateContext context)

Parameters:

tagName - The name of the tag that the attribute was triggered on

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

attributeName - The name of the attribute that triggered the event

attributeValue - The value of the attribute that triggered the event

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

Returns:

The text that should be inserted into the tag