de.xima.fc.gui.bean.application

Class PlaceholderBean

java.lang.Object

de.xima.fc.gui.common.utils.msg.I18nUtils

de.xima.fc.gui.common.utils.msg.MessageUtils

de.xima.fc.gui.common.utils.msg.AMessaging

de.xima.fc.gui.common.utils.msg.AJSFContext

de.xima.fc.gui.bean.ABackendJSFContext

de.xima.fc.gui.bean.FCContextBean

de.xima.fc.gui.bean.application.PlaceholderBean

All Implemented Interfaces:

Serializable

public class PlaceholderBean
extends FCContextBean

This bean provides a list of available placeholders for an input field. Different placeholders may be available, depending on the current context. For example, when the user is editing a project, placeholders for form elements of that project are available.

Each placeholder belongs to a IPlaceholderType. In the dialog, placeholders are grouped according to this type.

To control which placeholders are available, there exists

1. a IPlaceholderLibrary that contains the registered placeholders. It contains several groups and a set of placeholders for that group. A group is just any Object, eg. SYSTEM placeholders, FORM placeholders or custom placeholders. This lets you change the placeholders for a certain group without affecting other gropus.
2. a set of groups which are currently active. Only the placeholders for those groups are shown in the dialog. This makes it possible to deactivate a group of placeholders and activate it again later without having to recreate the placeholders.

There are also a few events available that can be triggered from another bean to update the placeholders:

• PlaceholderModifyLibraryEvent may be triggered to register or deregister placeholders from the IPlaceholderLibrary
• PlaceholderModifyActiveGroupsEvent may be triggered to add or remove currently active groups

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.xima.fc.gui.common.utils.msg.AJSFContext

AJSFContext.RedirectOptions, AJSFContext.RedirectOptionsBuilder

Field Summary

Fields inherited from class de.xima.fc.gui.bean.FCContextBean

systemUC

Constructor Summary

Constructors

Constructor and Description
PlaceholderBean()

Method Summary

Modifier and Type	Method and Description
int	comparePlaceholderType(IPlaceholderType lhs, IPlaceholderType rhs) Compares two given placeholder types.
List<PlaceHolder>	createPlaceholdersForCurrentContext() All available placeholders, depending on the current context (ie. whether the user is editing a project etc.).
Set<IPlaceholderGroup>	getActiveGroups()
IPlaceholderLibrary	getLibrary()
Collection<Projekt>	getProjects()
PlaceHolder	getSelectedPlaceholder()
Projekt	getSelectedProject()
ViewEventBusBean	getViewEventBusBean()
boolean	isShowProjectSelection() Whether the user can select a project in the placeholder dialog.
void	load()
void	setSelectedPlaceholder(PlaceHolder selectedPlaceholder)
void	setSelectedProject(Projekt selectedProject)
void	setViewEventBusBean(ViewEventBusBean viewEventBusBean)
void	updateDialog() Triggers an update of the placeholder dialog.

Methods inherited from class de.xima.fc.gui.bean.FCContextBean

getNavigationBean, getSessionBean, isSetupUser, redirectToDashboard, setNavigationBean, setSessionBean, switchMainView, switchMainView, switchSubView, switchSubView

Methods inherited from class de.xima.fc.gui.bean.ABackendJSFContext

ec, isDetached, isHasDB

Methods inherited from class de.xima.fc.gui.common.utils.msg.AJSFContext

destroySessionBean, encodeURL, findBean, findBean, findBean, findBean, findBean, findBean, findBean, findCurrentView, getBeanName, getBeanName, getContext, getCurrentViewBean, getLocaleBean, getRequest, getResponse, getSession, getSession, getSessionAttribute, isMasterServerContext, loadLazy, redirect, redirect, redirect, redirect, redirectToDashboard, redirectToDashboard, setLocaleBean, setSessionAttribute, uc

Methods inherited from class de.xima.fc.gui.common.utils.msg.MessageUtils

addErrorMsg, addErrorMsg, addErrorMsg, addErrorMsg, addErrorMsg, addErrorMsg, addErrorMsgFromString, addErrorMsgFromString, addErrorMsgToComponent, addErrorMsgToComponent, addErrorMsgToComponent, addErrorMsgToComponent, addErrorMsgToComponent, addErrorMsgToComponent, addInfoMsg, addInfoMsg, addInfoMsg, addInfoMsg, addInfoMsgFromString, addInfoMsgFromString, addInfoMsgToComponent, addInfoMsgToComponent, addInfoMsgToComponent, addInfoMsgToComponent, addMsg, addMsg, addMsg, addMsg, addMsgs, addMsgToComponent, addMsgToComponent, addWarnMsg, addWarnMsg, addWarnMsg, addWarnMsg, addWarnMsgFromString, addWarnMsgFromString, addWarnMsgToComponent, addWarnMsgToComponent, addWarnMsgToComponent, addWarnMsgToComponent, cleanErrorMsg, getErrorMessage

Methods inherited from class de.xima.fc.gui.common.utils.msg.I18nUtils

getFacesContext, getLocale, rbValue, rbValue, rbValue

Methods inherited from class java.lang.Object

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

Constructor Detail

PlaceholderBean

public PlaceholderBean()

Method Detail

comparePlaceholderType

public int comparePlaceholderType(IPlaceholderType lhs,
                                  IPlaceholderType rhs)

Compares two given placeholder types.

Parameters:

lhs - First placeholder type

rhs - Second placeholder type

Returns:

-1 if lhs < rhs, 1 if lhs > rhs, 0 if lhs == rhs.

getActiveGroups

public Set<IPlaceholderGroup> getActiveGroups()

Returns:

The set of groups of placeholder which are currently shown in the dialog.

getLibrary

public IPlaceholderLibrary getLibrary()

Returns:

The library with the registered placeholders.

getSelectedPlaceholder

public PlaceHolder getSelectedPlaceholder()

Returns:

The currently selected placeholder in the placeholder list.

getViewEventBusBean

public ViewEventBusBean getViewEventBusBean()

isShowProjectSelection

public boolean isShowProjectSelection()

Whether the user can select a project in the placeholder dialog. If the user is editing the workflow of a project, they cannot use placeholders of other projects. When they are editing a template, they can.

Returns:

Whether the current context allows selecting the project for which form placeholders are displayed.

load

public void load()

setSelectedPlaceholder

public void setSelectedPlaceholder(PlaceHolder selectedPlaceholder)

Parameters:

selectedPlaceholder - The currently selected placeholder in the placeholder list.

setViewEventBusBean

public void setViewEventBusBean(ViewEventBusBean viewEventBusBean)

updateDialog

public void updateDialog()

Triggers an update of the placeholder dialog. Usually invoked when the list of displayed placeholders has changed.

createPlaceholdersForCurrentContext

public List<PlaceHolder> createPlaceholdersForCurrentContext()

All available placeholders, depending on the current context (ie. whether the user is editing a project etc.). This includes, but is not limited to:

• System placeholders
• Template placeholders (HTML, TEXT, URL, MAIL)
• Form element placeholders for a certain project

Returns:

All placeholders applicable for the current context

getProjects

public Collection<Projekt> getProjects()

Returns:

A list of projects that the user may select to change which form placeholders are displayed.

getSelectedProject

public Projekt getSelectedProject()

Returns:

The project for which form placeholders are shown.

setSelectedProject

public void setSelectedProject(Projekt selectedProject)

Parameters:

selectedProject - The project for which form placeholders are shown.