Class PlaceHolder.PlaceHolderBuilder

java.lang.Object

de.xima.fc.gui.common.placeholder.PlaceHolder.PlaceHolderBuilder

Enclosing class:

PlaceHolder

public static class PlaceHolder.PlaceHolderBuilder
extends Object

Utility class for creating a PlaceHolder.

Author:

XIMA MEDIA GmbH

Constructor Summary

Constructors

Constructor	Description
PlaceHolderBuilder(String placeholder, IPlaceholderType type)

Method Summary

Modifier and Type	Method	Description
PlaceHolder.PlaceHolderBuilder	alias(String alias)
PlaceHolder	build()
PlaceHolder.PlaceHolderBuilder	detailedDescription(ISerializableFunction<Locale,String> detailedDescription)
PlaceHolder.PlaceHolderBuilder	displayName(ISerializableFunction<Locale,String> displayName)
static PlaceHolder.PlaceHolderBuilder	forAppointment(String name)
static PlaceHolder.PlaceHolderBuilder	forAttachment(String name, String i18n, String... params)	Creates a placeholder of the following format: [%$name=param1,param2,...%], such as [%ATTACHMENT_ZIP=fileName%]
static PlaceHolder.PlaceHolderBuilder	forContext(String contextName, String name, IPlaceholderType type)	Creates a new context placeholder of the form <CONTEXT_NAME>.<NAME>.
static PlaceHolder.PlaceHolderBuilder	forSystem(String name)
static PlaceHolder.PlaceHolderBuilder	forUser(EPlaceholderType userPlaceholderType, String userType, String path)
static PlaceHolder.PlaceHolderBuilder	forWorkflowActionResult(String actionName, IGuiIcon icon, String property, String kind)
static PlaceHolder.PlaceHolderBuilder	forWorkflowNode(String nodeName, IGuiIcon icon, String property, String description)
static PlaceHolder.PlaceHolderBuilder	forWorkflowTrigger(IGuiIcon icon, String property, String description)
PlaceHolder.PlaceHolderBuilder	icon(IGuiIcon icon)
PlaceHolder.PlaceHolderBuilder	kind(String kind)
PlaceHolder.PlaceHolderBuilder	name(String name)
PlaceHolder.PlaceHolderBuilder	text(String text)

Methods inherited from class Object

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

Constructor Details

PlaceHolderBuilder

public PlaceHolderBuilder(String placeholder,
 IPlaceholderType type)

Parameters:

placeholder - The placeholder value without the bracket, eg. $$CLIENT_ID. This is the value that is inserted into the text field.

type - The type of placeholder, used for grouping etc.

Method Details

forAppointment

public static PlaceHolder.PlaceHolderBuilder forAppointment(String name)

forAttachment

public static PlaceHolder.PlaceHolderBuilder forAttachment(String name,
 String i18n,
 String... params)

Creates a placeholder of the following format: [%$name=param1,param2,...%], such as [%ATTACHMENT_ZIP=fileName%]

Parameters:

name - Name of the attachment placeholder, see CmnConst.SESSION_ATTACHMENT, CmnConst.SESSION_ATTACHMENT_LIST, CmnConst.SESSION_ATTACHMENT_ZIP.

i18n - I18N key of the placeholder name and description.

params - Parameters added to the placeholder name (see above)

Returns:

A placeholder builder for an attachment placeholder.

forContext

public static PlaceHolder.PlaceHolderBuilder forContext(String contextName,
 String name,
 IPlaceholderType type)

Creates a new context placeholder of the form <CONTEXT_NAME>.<NAME>. For example data.email or data.firstName.

Parameters:

contextName - Name of the context

name - Name of the placeholder

type - Type of the placeholder. Consider using ContextPlaceholderType.

Returns:

New builder for further customization.

forSystem

public static PlaceHolder.PlaceHolderBuilder forSystem(String name)

forUser

public static PlaceHolder.PlaceHolderBuilder forUser(EPlaceholderType userPlaceholderType,
 String userType,
 String path)

forWorkflowActionResult

public static PlaceHolder.PlaceHolderBuilder forWorkflowActionResult(String actionName,
 IGuiIcon icon,
 String property,
 String kind)

forWorkflowNode

public static PlaceHolder.PlaceHolderBuilder forWorkflowNode(String nodeName,
 IGuiIcon icon,
 String property,
 String description)

forWorkflowTrigger

public static PlaceHolder.PlaceHolderBuilder forWorkflowTrigger(IGuiIcon icon,
 String property,
 String description)

alias

public PlaceHolder.PlaceHolderBuilder alias(String alias)

Parameters:

alias - Only for form field placeholders: The alias of the form field

Returns:

this for chaining

build

public PlaceHolder build()

icon

public PlaceHolder.PlaceHolderBuilder icon(IGuiIcon icon)

Parameters:

icon - Icon for this placeholder. Depending on the placeholder type, may overwrite the default icon of that type.

Returns:

this for chaining

kind

public PlaceHolder.PlaceHolderBuilder kind(String kind)

Parameters:

kind - The type or kind of the placeholder. May be used by certain IPlaceholderTypes for a more detailed description etc.

Returns:

this for chaining

name

public PlaceHolder.PlaceHolderBuilder name(String name)

Parameters:

name - Name of the placeholder, eg. CLIENT_ID. Usually shown in the list of available placeholders

Returns:

this for chaining

detailedDescription

public PlaceHolder.PlaceHolderBuilder detailedDescription(ISerializableFunction<Locale,String> detailedDescription)

Parameters:

detailedDescription - Detailed description of this placeholder, explaining what it does and how it works.

Returns:

this for chaining

displayName

public PlaceHolder.PlaceHolderBuilder displayName(ISerializableFunction<Locale,String> displayName)

Parameters:

displayName - Display name of the placeholder, e.g. Client ID. Usually shown in the list of available placeholders

Returns:

this for chaining

text

public PlaceHolder.PlaceHolderBuilder text(String text)

Parameters:

text - Content of this placeholder, eg. the HTML string for HTML template placeholders. May be empty for other placeholders types.

Returns:

this for chaining