Package de.xima.fc.gui.model

Class PlaceholderLibrary

java.lang.Object

de.xima.fc.gui.model.PlaceholderLibrary

All Implemented Interfaces:

IPlaceholderLibrary, Serializable

public class PlaceholderLibrary
extends Object
implements IPlaceholderLibrary

Represents the set of placeholders available for selection in the placeholder dialog.

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Field Summary

Fields inherited from interface de.xima.fc.gui.interfaces.IPlaceholderLibrary

GROUP_APPOINTMENT, GROUP_ATTACHMENT, GROUP_COUNTER, GROUP_FORM, GROUP_SYSTEM, GROUP_TEMPLATE, GROUP_USER_CURRENT, GROUP_USER_INITIAL, GROUP_USER_LAST, GROUP_WORKFLOW_ACTION_RESULT, GROUP_WORKFLOW_TRIGGER_RESULT

Constructor Summary

Constructors

Constructor	Description
PlaceholderLibrary()	A new placeholder library with the default static placeholders.

Method Summary

Modifier and Type	Method	Description
void	add(IPlaceholderGroup group, PlaceHolder placeholder)
void	addAll(IPlaceholderGroup group, Iterable<PlaceHolder> placeholders)
void	addAll(Map<IPlaceholderGroup,Set<PlaceHolder>> placeholders)
void	clearAll()
void	clearAll(IPlaceholderGroup group)
void	clearAll(Collection<IPlaceholderGroup> groups)
Set<PlaceHolder>	createFormPlaceHoldersForItems(Mandant client, Locale locale, Iterable<XItem> xItems, Iterable<FormVariable> variables)
static Set<PlaceHolder>	createSystemPlaceholders(Locale clientLocale)
Iterable<org.apache.commons.lang3.tuple.Pair<IPlaceholderGroup,PlaceHolder>>	getAll()
Set<PlaceHolder>	getAll(IPlaceholderGroup group)
Iterable<IPlaceholderGroup>	getGroups()
void	remove(IPlaceholderGroup group, PlaceHolder placeholder)
void	removeAll(IPlaceholderGroup group, Iterable<PlaceHolder> placeholders)
void	replaceAll(IPlaceholderGroup group, Iterable<PlaceHolder> placeholders)
void	updateCounterPlaceholders(IEntityContext ec, Mandant client)
void	updateDesignerPlaceholders(Map<IPlaceholderGroup,Set<PlaceHolder>> designerPlaceholders)
void	updateFormPlaceholders(IEntityContext ec, Mandant client, Locale locale, PlaceholderContextModel model)
void	updateTemplatePlaceholders(IEntityContext ec, Mandant client)
void	updateWorkflowActionResultPlaceholders(IEntityContext ec, Aktion action)

Methods inherited from class java.lang.Object

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

Constructor Detail

PlaceholderLibrary

public PlaceholderLibrary()

A new placeholder library with the default static placeholders.

Method Detail

add

public void add(IPlaceholderGroup group,
                PlaceHolder placeholder)

Specified by:

add in interface IPlaceholderLibrary

addAll

public void addAll(IPlaceholderGroup group,
                   Iterable<PlaceHolder> placeholders)

Specified by:

addAll in interface IPlaceholderLibrary

addAll

public void addAll(Map<IPlaceholderGroup,Set<PlaceHolder>> placeholders)

Specified by:

addAll in interface IPlaceholderLibrary

clearAll

public void clearAll()

Specified by:

clearAll in interface IPlaceholderLibrary

clearAll

public void clearAll(Collection<IPlaceholderGroup> groups)

Specified by:

clearAll in interface IPlaceholderLibrary

clearAll

public void clearAll(IPlaceholderGroup group)

Specified by:

clearAll in interface IPlaceholderLibrary

createFormPlaceHoldersForItems

public Set<PlaceHolder> createFormPlaceHoldersForItems(Mandant client,
                                                       Locale locale,
                                                       Iterable<XItem> xItems,
                                                       Iterable<FormVariable> variables)

getAll

public Iterable<org.apache.commons.lang3.tuple.Pair<IPlaceholderGroup,PlaceHolder>> getAll()

Specified by:

getAll in interface IPlaceholderLibrary

getAll

public Set<PlaceHolder> getAll(IPlaceholderGroup group)

Specified by:

getAll in interface IPlaceholderLibrary

getGroups

public Iterable<IPlaceholderGroup> getGroups()

Specified by:

getGroups in interface IPlaceholderLibrary

remove

public void remove(IPlaceholderGroup group,
                   PlaceHolder placeholder)

Specified by:

remove in interface IPlaceholderLibrary

removeAll

public void removeAll(IPlaceholderGroup group,
                      Iterable<PlaceHolder> placeholders)

Specified by:

removeAll in interface IPlaceholderLibrary

replaceAll

public void replaceAll(IPlaceholderGroup group,
                       Iterable<PlaceHolder> placeholders)

Specified by:

replaceAll in interface IPlaceholderLibrary

updateCounterPlaceholders

public void updateCounterPlaceholders(IEntityContext ec,
                                      Mandant client)

Specified by:

updateCounterPlaceholders in interface IPlaceholderLibrary

updateDesignerPlaceholders

public void updateDesignerPlaceholders(Map<IPlaceholderGroup,Set<PlaceHolder>> designerPlaceholders)

updateFormPlaceholders

public void updateFormPlaceholders(IEntityContext ec,
                                   Mandant client,
                                   Locale locale,
                                   PlaceholderContextModel model)

Specified by:

updateFormPlaceholders in interface IPlaceholderLibrary

updateTemplatePlaceholders

public void updateTemplatePlaceholders(IEntityContext ec,
                                       Mandant client)

Specified by:

updateTemplatePlaceholders in interface IPlaceholderLibrary

updateWorkflowActionResultPlaceholders

public void updateWorkflowActionResultPlaceholders(IEntityContext ec,
                                                   Aktion action)

Specified by:

updateWorkflowActionResultPlaceholders in interface IPlaceholderLibrary

Parameters:

ec - Ignored parameter, can be null.

action - Ignored parameter, can be null.

createSystemPlaceholders

public static Set<PlaceHolder> createSystemPlaceholders(Locale clientLocale)