com.stratelia.webactiv.util.viewGenerator.html
Class JavascriptPluginInclusion

java.lang.Object
  com.stratelia.webactiv.util.viewGenerator.html.JavascriptPluginInclusion

public class JavascriptPluginInclusion
extends Object

This class embeds the process of the inclusion of some Javascript plugins used in Silverpeas.

It acts as a mixin for the tags that which to include a specific tag in order to use the functionalities of the underlying plugin.

Author:

mmoquillon

Constructor Summary

JavascriptPluginInclusion()

Method Summary

static String	getDynamicPopupJavascriptLoadContent(String jsCallback)
static String	getDynamicSubscriptionJavascriptLoadContent(String jsCallback) Includes a dynamic loading of Silverpeas subscription JQuery Plugin.
static org.apache.ecs.ElementContainer	includeAngular(org.apache.ecs.ElementContainer xhtml, String language)
static org.apache.ecs.ElementContainer	includeAudioPlayer(org.apache.ecs.ElementContainer xhtml)
static org.apache.ecs.ElementContainer	includeBreadCrumb(org.apache.ecs.ElementContainer xhtml)
static org.apache.ecs.ElementContainer	includeCalendar(org.apache.ecs.ElementContainer xhtml)
static org.apache.ecs.ElementContainer	includeChart(org.apache.ecs.ElementContainer xhtml, String language)
static org.apache.ecs.ElementContainer	includeCkeditorAddOns(org.apache.ecs.ElementContainer xhtml, String language)
static org.apache.ecs.ElementContainer	includeComment(org.apache.ecs.ElementContainer xhtml)
static org.apache.ecs.ElementContainer	includeDatePicker(org.apache.ecs.ElementContainer xhtml, String language)
static org.apache.ecs.ElementContainer	includeDragAndDropUpload(org.apache.ecs.ElementContainer xhtml, String language) Includes the Silverpeas drag and drop upload HTML5 Plugin.
static org.apache.ecs.ElementContainer	includeDynamicallySubscription(org.apache.ecs.ElementContainer xhtml, String jsCallback) Includes a dynamic loading of Silverpeas subscription JQuery Plugin.
static org.apache.ecs.ElementContainer	includeEmbedPlayer(org.apache.ecs.ElementContainer xhtml)
static org.apache.ecs.ElementContainer	includeGauge(org.apache.ecs.ElementContainer xhtml)
static org.apache.ecs.ElementContainer	includeHtml2CanvasAndDownload(org.apache.ecs.ElementContainer xhtml)
static org.apache.ecs.ElementContainer	includeIFrameAjaxTransport(org.apache.ecs.ElementContainer xhtml)
static org.apache.ecs.ElementContainer	includeInvitMe(org.apache.ecs.ElementContainer xhtml)
static org.apache.ecs.ElementContainer	includeJQuery(org.apache.ecs.ElementContainer xhtml)
static org.apache.ecs.ElementContainer	includeLang(org.apache.ecs.ElementContainer xhtml)
static org.apache.ecs.ElementContainer	includeLightweightSlideshow(org.apache.ecs.ElementContainer xhtml)
static org.apache.ecs.ElementContainer	includeListOfUsersAndGroups(org.apache.ecs.ElementContainer xhtml, String language) Includes the Silverpeas Plugin that handles list of users and groups.
static org.apache.ecs.ElementContainer	includeMessageMe(org.apache.ecs.ElementContainer xhtml)
static org.apache.ecs.ElementContainer	includeMylinks(org.apache.ecs.ElementContainer xhtml)
static org.apache.ecs.ElementContainer	includeNotifier(org.apache.ecs.ElementContainer xhtml)
static org.apache.ecs.ElementContainer	includePagination(org.apache.ecs.ElementContainer xhtml)
static org.apache.ecs.ElementContainer	includePassword(org.apache.ecs.ElementContainer xhtml)
static org.apache.ecs.ElementContainer	includePdc(org.apache.ecs.ElementContainer xhtml)
static org.apache.ecs.ElementContainer	includePopup(org.apache.ecs.ElementContainer xhtml)
static org.apache.ecs.ElementContainer	includePreview(org.apache.ecs.ElementContainer xhtml)
static org.apache.ecs.ElementContainer	includeQTip(org.apache.ecs.ElementContainer xhtml)
static org.apache.ecs.ElementContainer	includeRating(org.apache.ecs.ElementContainer xhtml)
static org.apache.ecs.ElementContainer	includeResponsibles(org.apache.ecs.ElementContainer xhtml, String language)
static org.apache.ecs.ElementContainer	includeSecurityTokenizing(org.apache.ecs.ElementContainer xhtml) Two javascript methods are provided to apply security based on tokens: applyTokenSecurity([optional jQuery selector]): all the DOM or the DOM under specified selector is set applyTokenSecurityOnMenu(): all the DOM that handles the menu is set.
static org.apache.ecs.ElementContainer	includeTags(org.apache.ecs.ElementContainer xhtml)
static org.apache.ecs.ElementContainer	includeTicker(org.apache.ecs.ElementContainer xhtml)
static org.apache.ecs.ElementContainer	includeToggle(org.apache.ecs.ElementContainer xhtml)
static org.apache.ecs.ElementContainer	includeUserZoom(org.apache.ecs.ElementContainer xhtml)
static org.apache.ecs.ElementContainer	includeVideoPlayer(org.apache.ecs.ElementContainer xhtml)
static org.apache.ecs.ElementContainer	includeWysiwygEditor(org.apache.ecs.ElementContainer xhtml)
static org.apache.ecs.Element	link(String href) Centralization of link instantiation.
static org.apache.ecs.Element	script(String src) Centralization of script instantiation.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavascriptPluginInclusion

public JavascriptPluginInclusion()

Method Detail

script

public static org.apache.ecs.Element script(String src)

Centralization of script instantiation.

Parameters:

src -

Returns:

link

public static org.apache.ecs.Element link(String href)

Centralization of link instantiation.

Parameters:

href -

Returns:

includeCkeditorAddOns

public static org.apache.ecs.ElementContainer includeCkeditorAddOns(org.apache.ecs.ElementContainer xhtml,
                                                                    String language)

includeAngular

public static org.apache.ecs.ElementContainer includeAngular(org.apache.ecs.ElementContainer xhtml,
                                                             String language)

includeEmbedPlayer

public static org.apache.ecs.ElementContainer includeEmbedPlayer(org.apache.ecs.ElementContainer xhtml)

includeAudioPlayer

public static org.apache.ecs.ElementContainer includeAudioPlayer(org.apache.ecs.ElementContainer xhtml)

includeVideoPlayer

public static org.apache.ecs.ElementContainer includeVideoPlayer(org.apache.ecs.ElementContainer xhtml)

includeQTip

public static org.apache.ecs.ElementContainer includeQTip(org.apache.ecs.ElementContainer xhtml)

includePdc

public static org.apache.ecs.ElementContainer includePdc(org.apache.ecs.ElementContainer xhtml)

includeRating

public static org.apache.ecs.ElementContainer includeRating(org.apache.ecs.ElementContainer xhtml)

includeToggle

public static org.apache.ecs.ElementContainer includeToggle(org.apache.ecs.ElementContainer xhtml)

includeLightweightSlideshow

public static org.apache.ecs.ElementContainer includeLightweightSlideshow(org.apache.ecs.ElementContainer xhtml)

includeTicker

public static org.apache.ecs.ElementContainer includeTicker(org.apache.ecs.ElementContainer xhtml)

includeIFrameAjaxTransport

public static org.apache.ecs.ElementContainer includeIFrameAjaxTransport(org.apache.ecs.ElementContainer xhtml)

includeDatePicker

public static org.apache.ecs.ElementContainer includeDatePicker(org.apache.ecs.ElementContainer xhtml,
                                                                String language)

includePagination

public static org.apache.ecs.ElementContainer includePagination(org.apache.ecs.ElementContainer xhtml)

includeBreadCrumb

public static org.apache.ecs.ElementContainer includeBreadCrumb(org.apache.ecs.ElementContainer xhtml)

includeUserZoom

public static org.apache.ecs.ElementContainer includeUserZoom(org.apache.ecs.ElementContainer xhtml)

includeInvitMe

public static org.apache.ecs.ElementContainer includeInvitMe(org.apache.ecs.ElementContainer xhtml)

includeMessageMe

public static org.apache.ecs.ElementContainer includeMessageMe(org.apache.ecs.ElementContainer xhtml)

includeWysiwygEditor

public static org.apache.ecs.ElementContainer includeWysiwygEditor(org.apache.ecs.ElementContainer xhtml)

includeResponsibles

public static org.apache.ecs.ElementContainer includeResponsibles(org.apache.ecs.ElementContainer xhtml,
                                                                  String language)

includePopup

public static org.apache.ecs.ElementContainer includePopup(org.apache.ecs.ElementContainer xhtml)

getDynamicPopupJavascriptLoadContent

public static String getDynamicPopupJavascriptLoadContent(String jsCallback)

includePreview

public static org.apache.ecs.ElementContainer includePreview(org.apache.ecs.ElementContainer xhtml)

includeNotifier

public static org.apache.ecs.ElementContainer includeNotifier(org.apache.ecs.ElementContainer xhtml)

includePassword

public static org.apache.ecs.ElementContainer includePassword(org.apache.ecs.ElementContainer xhtml)

includeCalendar

public static org.apache.ecs.ElementContainer includeCalendar(org.apache.ecs.ElementContainer xhtml)

includeGauge

public static org.apache.ecs.ElementContainer includeGauge(org.apache.ecs.ElementContainer xhtml)

includeComment

public static org.apache.ecs.ElementContainer includeComment(org.apache.ecs.ElementContainer xhtml)

includeJQuery

public static org.apache.ecs.ElementContainer includeJQuery(org.apache.ecs.ElementContainer xhtml)

includeTags

public static org.apache.ecs.ElementContainer includeTags(org.apache.ecs.ElementContainer xhtml)

includeSecurityTokenizing

public static org.apache.ecs.ElementContainer includeSecurityTokenizing(org.apache.ecs.ElementContainer xhtml)

Two javascript methods are provided to apply security based on tokens:

• applyTokenSecurity([optional jQuery selector]): all the DOM or the DOM under specified selector is set
• applyTokenSecurityOnMenu(): all the DOM that handles the menu is set.

Parameters:

xhtml -

Returns:

includeMylinks

public static org.apache.ecs.ElementContainer includeMylinks(org.apache.ecs.ElementContainer xhtml)

includeLang

public static org.apache.ecs.ElementContainer includeLang(org.apache.ecs.ElementContainer xhtml)

includeHtml2CanvasAndDownload

public static org.apache.ecs.ElementContainer includeHtml2CanvasAndDownload(org.apache.ecs.ElementContainer xhtml)

includeChart

public static org.apache.ecs.ElementContainer includeChart(org.apache.ecs.ElementContainer xhtml,
                                                           String language)

includeDynamicallySubscription

public static org.apache.ecs.ElementContainer includeDynamicallySubscription(org.apache.ecs.ElementContainer xhtml,
                                                                             String jsCallback)

Includes a dynamic loading of Silverpeas subscription JQuery Plugin.

Parameters:

xhtml - the container into which the plugin loading code will be added.

jsCallback - javascript routine as string (without function declaration that wraps it) that is always performed after that the plugin existence is verified.

Returns:

the completed parent container.

getDynamicSubscriptionJavascriptLoadContent

public static String getDynamicSubscriptionJavascriptLoadContent(String jsCallback)

Includes a dynamic loading of Silverpeas subscription JQuery Plugin. This plugin depends on the 'popup' one and handles its loading.

Parameters:

jsCallback - javascript routine as string (without function declaration that wraps it) that is always performed after that the plugin existence is verified.

Returns:

the container that contains the script loading.

includeDragAndDropUpload

public static org.apache.ecs.ElementContainer includeDragAndDropUpload(org.apache.ecs.ElementContainer xhtml,
                                                                       String language)

Includes the Silverpeas drag and drop upload HTML5 Plugin. This plugin depends on the associated i18n javascript file.

Returns:

the completed parent container.

includeListOfUsersAndGroups

public static org.apache.ecs.ElementContainer includeListOfUsersAndGroups(org.apache.ecs.ElementContainer xhtml,
                                                                          String language)

Includes the Silverpeas Plugin that handles list of users and groups.

Returns:

the completed parent container.