com.liferay.portal.kernel.template

Class TemplateVariableGroup

java.lang.Object

com.liferay.portal.kernel.template.TemplateVariableGroup

public class TemplateVariableGroup
extends java.lang.Object

Author:

Jorge Ferrer

Constructor Summary

Constructors

Constructor and Description
TemplateVariableGroup(java.lang.String label)
TemplateVariableGroup(java.lang.String label, java.lang.String[] restrictedVariables)

Method Summary

Modifier and Type	Method and Description
TemplateVariableDefinition	addCollectionVariable(java.lang.String collectionLabel, java.lang.Class<?> collectionClazz, java.lang.String collectionName, java.lang.String itemLabel, java.lang.Class<?> itemClazz, java.lang.String itemName, java.lang.String itemAccessor)
TemplateVariableDefinition	addFieldVariable(java.lang.String label, java.lang.Class<?> clazz, java.lang.String variableName, java.lang.String help, java.lang.String dataType, boolean repeatable, TemplateVariableCodeHandler templateVariableCodeHandler)
void	addServiceLocatorVariables(java.lang.Class<?>... serviceClasses)
TemplateVariableDefinition	addVariable(java.lang.String label, java.lang.Class<?> clazz, java.lang.String name)
TemplateVariableDefinition	addVariable(java.lang.String label, java.lang.Class<?> clazz, java.lang.String name, java.lang.String accessor)
TemplateVariableDefinition	addVariable(java.lang.String label, java.lang.Class<?> clazz, java.lang.String dataType, java.lang.String name, java.lang.String accessor, java.lang.String help)
void	empty()
java.lang.String	getLabel()
java.util.Collection<TemplateVariableDefinition>	getTemplateVariableDefinitions()
boolean	isAutocompleteEnabled()
boolean	isEmpty()
protected boolean	isRestrictedVariable(java.lang.String variableName)
void	setAutocompleteEnabled(boolean autocompleteEnabled)
void	setLabel(java.lang.String label)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TemplateVariableGroup

public TemplateVariableGroup(java.lang.String label)

TemplateVariableGroup

public TemplateVariableGroup(java.lang.String label,
                             java.lang.String[] restrictedVariables)

Method Detail

addCollectionVariable

public TemplateVariableDefinition addCollectionVariable(java.lang.String collectionLabel,
                                                        java.lang.Class<?> collectionClazz,
                                                        java.lang.String collectionName,
                                                        java.lang.String itemLabel,
                                                        java.lang.Class<?> itemClazz,
                                                        java.lang.String itemName,
                                                        java.lang.String itemAccessor)

addFieldVariable

public TemplateVariableDefinition addFieldVariable(java.lang.String label,
                                                   java.lang.Class<?> clazz,
                                                   java.lang.String variableName,
                                                   java.lang.String help,
                                                   java.lang.String dataType,
                                                   boolean repeatable,
                                                   TemplateVariableCodeHandler templateVariableCodeHandler)

addServiceLocatorVariables

public void addServiceLocatorVariables(java.lang.Class<?>... serviceClasses)

addVariable

public TemplateVariableDefinition addVariable(java.lang.String label,
                                              java.lang.Class<?> clazz,
                                              java.lang.String name)

addVariable

public TemplateVariableDefinition addVariable(java.lang.String label,
                                              java.lang.Class<?> clazz,
                                              java.lang.String name,
                                              java.lang.String accessor)

addVariable

public TemplateVariableDefinition addVariable(java.lang.String label,
                                              java.lang.Class<?> clazz,
                                              java.lang.String dataType,
                                              java.lang.String name,
                                              java.lang.String accessor,
                                              java.lang.String help)

empty

public void empty()

getLabel

public java.lang.String getLabel()

getTemplateVariableDefinitions

public java.util.Collection<TemplateVariableDefinition> getTemplateVariableDefinitions()

isAutocompleteEnabled

public boolean isAutocompleteEnabled()

isEmpty

public boolean isEmpty()

setAutocompleteEnabled

public void setAutocompleteEnabled(boolean autocompleteEnabled)

setLabel

public void setLabel(java.lang.String label)

isRestrictedVariable

protected boolean isRestrictedVariable(java.lang.String variableName)