Package de.xima.fc.gui.designer.form.utils

Class WidgetPluginHelper

java.lang.Object

de.xima.fc.gui.designer.form.utils.WidgetPluginHelper

public final class WidgetPluginHelper
extends Object

Utilities for handling widget plugins in the form designer, see FormDesignerPluginBean.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
static org.primefaces.model.StreamedContent	createPluginCssFontFaceInfoStreamedContent(long clientId, String pluginName)
static org.primefaces.model.StreamedContent	createPluginCssForDesignerUiStreamedContent(long clientId, String pluginName)
static List<String>	createPluginCssForDesignerUiUrls(javax.faces.context.FacesContext context, Mandant client, String conversationId)
static org.primefaces.model.StreamedContent	createPluginCssStreamedContent(long clientId, String pluginName)
static List<CssWithFontFacesInfo>	createPluginCssUrls(javax.faces.context.FacesContext context, Mandant client, String conversationId)
static com.alibaba.fastjson.JSONObject	createPluginData(IPluginFormElementWidgetGetRuntimeDataParams params)
static org.primefaces.model.StreamedContent	createPluginJavaScriptStreamedContent(long clientId, String pluginName)
static List<String>	createPluginJavaScriptUrls(javax.faces.context.FacesContext context, Mandant client, String conversationId)

Methods inherited from class java.lang.Object

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

Method Detail

createPluginCssFontFaceInfoStreamedContent

public static org.primefaces.model.StreamedContent createPluginCssFontFaceInfoStreamedContent(long clientId,
                                                                                              String pluginName)

Parameters:

clientId - ID of the client who owns the form currently opened in the designer.

pluginName - Name of the widget plugin.

Returns:

The font face info for the CSS of the given plugin, used by the designer to extract those styles outside the shadow DOM.

createPluginCssForDesignerUiStreamedContent

public static org.primefaces.model.StreamedContent createPluginCssForDesignerUiStreamedContent(long clientId,
                                                                                               String pluginName)

Parameters:

clientId - ID of the client who owns the form currently opened in the designer.

pluginName - Name of the widget plugin.

Returns:

The CSS for the designer UI required by widget plugin for the given client.

createPluginCssForDesignerUiUrls

public static List<String> createPluginCssForDesignerUiUrls(javax.faces.context.FacesContext context,
                                                            Mandant client,
                                                            String conversationId)

Parameters:

context - Current faces context.

client - Client who owns the form currently opened in the designer.

conversationId - Current designer conversation ID.

Returns:

The URL for the resource that serves the CSS for the designer UI required by widget plugins.

createPluginCssStreamedContent

public static org.primefaces.model.StreamedContent createPluginCssStreamedContent(long clientId,
                                                                                  String pluginName)

Parameters:

clientId - ID of the client who owns the form currently opened in the designer.

pluginName - Name of the widget plugin.

Returns:

The CSS for the form within the designer required by widget plugin for the given client.

createPluginCssUrls

public static List<CssWithFontFacesInfo> createPluginCssUrls(javax.faces.context.FacesContext context,
                                                             Mandant client,
                                                             String conversationId)

Parameters:

context - Current faces context.

client - Client who owns the form currently opened in the designer.

conversationId - Current designer conversation ID.

Returns:

The URL for the resource that serves the CSS for the form within the designer required by widget plugins.

createPluginData

public static com.alibaba.fastjson.JSONObject createPluginData(IPluginFormElementWidgetGetRuntimeDataParams params)

Parameters:

params - Params with the current client etc.

Returns:

The JSON object with the runtime data of all form element widgets for the given client from the params.

createPluginJavaScriptStreamedContent

public static org.primefaces.model.StreamedContent createPluginJavaScriptStreamedContent(long clientId,
                                                                                         String pluginName)

Parameters:

clientId - ID of the client who owns the form currently opened in the designer.

pluginName - Name of the widget plugin.

Returns:

The JavaScript required by widget plugin for the given client.

createPluginJavaScriptUrls

public static List<String> createPluginJavaScriptUrls(javax.faces.context.FacesContext context,
                                                      Mandant client,
                                                      String conversationId)

Parameters:

context - Current faces context.

client - Client who owns the form currently opened in the designer.

conversationId - Current designer conversation ID.

Returns:

The URL for the resource that serves the JavaScript required by widget plugins.