Package de.xima.fc.gui.builder

Class AFormShareScriptBuilder

java.lang.Object

de.xima.fc.gui.builder.AFormShareScriptBuilder

Direct Known Subclasses:

FormAjaxScriptBuilder, FormApiScriptBuilder

public abstract class AFormShareScriptBuilder
extends Object

Abstract base class for generating form share scripts

Author:

XIMA MEDIA GmbH

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	ajaxAuto
protected String	containerId
static boolean	DEFAULT_AJAX_AUTO
static String	DEFAULT_CONTAINER_ID
static String	DEFAULT_INDENTATION
static boolean	DEFAULT_LOAD_JQUERY_FIRST
static String	DEFAULT_PP_ERROR_URL
static String	DEFAULT_PP_SUCCESS_URL
static boolean	DEFAULT_PP_USE_BASE_URL
static boolean	DEFAULT_RP_FORM_ONLY
static boolean	DEFAULT_RP_KEEP_ALIVE
static boolean	DEFAULT_RP_USE_JQ
static boolean	DEFAULT_RP_USE_UI
protected boolean	forceInline
protected boolean	loadJqueryFirst
protected String	ppErrorUrl
protected String	ppSuccessUrl
protected boolean	ppUseBaseUrl
protected Projekt	project
protected boolean	rpFormOnly
protected boolean	rpKeepAlive
protected FormThemeReference	rpTheme
protected boolean	rpUseJq
protected boolean	rpUseUi
protected ServerSelectionModel.Server	server

Constructor Summary

Constructors

Constructor	Description
AFormShareScriptBuilder(ServerSelectionModel.Server server, Projekt project)

Method Summary

Modifier and Type	Method	Description
abstract String	build()	Builds the for loading script based on the given properties
protected String	getIndentationSpaces(int indent)
protected String	getRequestData(int indent)
AFormShareScriptBuilder	withAjaxAuto(boolean ajaxAuto)
AFormShareScriptBuilder	withContainerId(String containerId)
protected AFormShareScriptBuilder	withForceInline(boolean forceInline)
AFormShareScriptBuilder	withLoadJqueryFirst(boolean loadJqueryFirst)
AFormShareScriptBuilder	withPpErrorUrl(String ppErrorUrl)
AFormShareScriptBuilder	withPpSuccessUrl(String ppSuccessUrl)
AFormShareScriptBuilder	withPpUseBaseUrl(boolean ppUseBaseUrl)
AFormShareScriptBuilder	withProject(Projekt project)
AFormShareScriptBuilder	withRpFormOnly(boolean rpFormOnly)
AFormShareScriptBuilder	withRpKeepAlive(boolean rpKeepAlive)
AFormShareScriptBuilder	withRpTheme(Textbaustein rpTheme)	Deprecated.
AFormShareScriptBuilder	withRpTheme(FormThemeReference formThemeReference)	Sets the form theme to use for the form.
AFormShareScriptBuilder	withRpUseJq(boolean rpUseJq)
AFormShareScriptBuilder	withRpUseUi(boolean rpUseUi)
AFormShareScriptBuilder	withServer(ServerSelectionModel.Server server)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LOAD_JQUERY_FIRST

public static final boolean DEFAULT_LOAD_JQUERY_FIRST

See Also:

Constant Field Values

DEFAULT_RP_FORM_ONLY

public static final boolean DEFAULT_RP_FORM_ONLY

See Also:

Constant Field Values

DEFAULT_RP_USE_JQ

public static final boolean DEFAULT_RP_USE_JQ

See Also:

Constant Field Values

DEFAULT_RP_KEEP_ALIVE

public static final boolean DEFAULT_RP_KEEP_ALIVE

See Also:

Constant Field Values

DEFAULT_RP_USE_UI

public static final boolean DEFAULT_RP_USE_UI

See Also:

Constant Field Values

DEFAULT_AJAX_AUTO

public static final boolean DEFAULT_AJAX_AUTO

See Also:

Constant Field Values

DEFAULT_PP_USE_BASE_URL

public static final boolean DEFAULT_PP_USE_BASE_URL

See Also:

Constant Field Values

DEFAULT_PP_SUCCESS_URL

public static final String DEFAULT_PP_SUCCESS_URL

See Also:

Constant Field Values

DEFAULT_PP_ERROR_URL

public static final String DEFAULT_PP_ERROR_URL

See Also:

Constant Field Values

DEFAULT_CONTAINER_ID

public static final String DEFAULT_CONTAINER_ID

See Also:

Constant Field Values

DEFAULT_INDENTATION

public static final String DEFAULT_INDENTATION

See Also:

Constant Field Values

server

protected ServerSelectionModel.Server server

project

protected Projekt project

loadJqueryFirst

protected boolean loadJqueryFirst

rpFormOnly

protected boolean rpFormOnly

rpKeepAlive

protected boolean rpKeepAlive

rpUseJq

protected boolean rpUseJq

rpUseUi

protected boolean rpUseUi

ajaxAuto

protected boolean ajaxAuto

ppUseBaseUrl

protected boolean ppUseBaseUrl

forceInline

protected boolean forceInline

rpTheme

protected FormThemeReference rpTheme

ppSuccessUrl

protected String ppSuccessUrl

ppErrorUrl

protected String ppErrorUrl

containerId

protected String containerId

Constructor Detail

AFormShareScriptBuilder

public AFormShareScriptBuilder(ServerSelectionModel.Server server,
                               Projekt project)

Method Detail

withRpTheme

@Deprecated
public AFormShareScriptBuilder withRpTheme(Textbaustein rpTheme)

Deprecated.

withRpTheme

public AFormShareScriptBuilder withRpTheme(FormThemeReference formThemeReference)

Sets the form theme to use for the form. This is an override, when not set, the theme that was configured for the form is used.

Parameters:

formThemeReference - The form theme to use instead of the theme configured for the form.

Returns:

The builder instance for chaining method calls.

withLoadJqueryFirst

public AFormShareScriptBuilder withLoadJqueryFirst(boolean loadJqueryFirst)

withRpFormOnly

public AFormShareScriptBuilder withRpFormOnly(boolean rpFormOnly)

withRpKeepAlive

public AFormShareScriptBuilder withRpKeepAlive(boolean rpKeepAlive)

withPpUseBaseUrl

public AFormShareScriptBuilder withPpUseBaseUrl(boolean ppUseBaseUrl)

withRpUseJq

public AFormShareScriptBuilder withRpUseJq(boolean rpUseJq)

withRpUseUi

public AFormShareScriptBuilder withRpUseUi(boolean rpUseUi)

withAjaxAuto

public AFormShareScriptBuilder withAjaxAuto(boolean ajaxAuto)

withPpSuccessUrl

public AFormShareScriptBuilder withPpSuccessUrl(String ppSuccessUrl)

withPpErrorUrl

public AFormShareScriptBuilder withPpErrorUrl(String ppErrorUrl)

withContainerId

public AFormShareScriptBuilder withContainerId(String containerId)

withServer

public AFormShareScriptBuilder withServer(ServerSelectionModel.Server server)

withProject

public AFormShareScriptBuilder withProject(Projekt project)

withForceInline

protected AFormShareScriptBuilder withForceInline(boolean forceInline)

build

public abstract String build()
                      throws Exception

Builds the for loading script based on the given properties

Returns:

String form loading script

Throws:

Exception - on errors during the build process

getRequestData

protected String getRequestData(int indent)

getIndentationSpaces

protected String getIndentationSpaces(int indent)