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. Eg. when the user is editing a project, placeholders for form elements of that project are available.

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlaceholderBean.PlaceHolder
static class	PlaceholderBean.PlaceHolderBuilder
static class	PlaceholderBean.PlaceholderProjectChangeHandler

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
void	clean()
CurrentProjectBean	getCurrentProjectBean()
List<PlaceholderBean.PlaceHolder>	getForCurrentContext() All available placeholders, depending on the current context (ie. whether the user is editing a project etc.).
List<PlaceholderBean.PlaceHolder>	getFormPlaceholder(FormVersion fv, boolean onlyUploads)
Collection<Projekt>	getProjects()
PlaceholderBean.PlaceHolder	getSelectedPlaceholder()
Projekt	getSelectedProject()
ViewEventBusBean	getViewEventBusBean()
void	init()
boolean	isShowProjectSelection() If the user is editing the workflow of a project, they cannot use placeholders of other projects.
void	setCurrentProjectBean(CurrentProjectBean currentProjectBean)
void	setSelectedPlaceholder(PlaceholderBean.PlaceHolder selectedPlaceholder)
void	setSelectedProject(Projekt selectedProject)
void	setViewEventBusBean(ViewEventBusBean viewEventBusBean)

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, 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

init

@PostConstruct
public void init()

clean

@PreDestroy
public void clean()

getViewEventBusBean

public ViewEventBusBean getViewEventBusBean()

setViewEventBusBean

public void setViewEventBusBean(ViewEventBusBean viewEventBusBean)

getSelectedPlaceholder

public PlaceholderBean.PlaceHolder getSelectedPlaceholder()

Returns:

The currently selected placeholder in the placeholder list.

setSelectedPlaceholder

public void setSelectedPlaceholder(PlaceholderBean.PlaceHolder selectedPlaceholder)

Parameters:

selectedPlaceholder - The currently selected placeholder in the placeholder list.

getCurrentProjectBean

public CurrentProjectBean getCurrentProjectBean()

setCurrentProjectBean

public void setCurrentProjectBean(CurrentProjectBean currentProjectBean)

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.

isShowProjectSelection

public boolean isShowProjectSelection()

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 whose form placeholders are displayed.

getProjects

public Collection<Projekt> getProjects()

Returns:

All projects that may be selected for getSelectedProject().

getForCurrentContext

public List<PlaceholderBean.PlaceHolder> getForCurrentContext()

All available placeholders, depending on the current context (ie. whether the user is editing a project etc.). This may include:

• System placeholders
• Template placeholders (HTML, TEXT, URL, MAIL)
• Form element placeholders, for the current or all forms.

Returns:

All placeholders applicable for the currently selected project.

getFormPlaceholder

public List<PlaceholderBean.PlaceHolder> getFormPlaceholder(FormVersion fv,
                                                            boolean onlyUploads)

Parameters:

fv - The form version for which to retrieve the form element placeholders.

onlyUploads - Iff true, only include upload elements.

Returns:

All placeholders for the form elements of the given form version.