widget Taglib documentation

Version 1.0
Description Mashup Widget Helpers

Tag forEachSubWidget widget:forEachSubWidget(...)

Iterates over the sub-Widgets and changes the scope of the JSP to the widget we iterate on.
Body Content: scriptless
Attribute nameRequiredRuntime Expression EvaluationType
varStatusfalsefalsejava.lang.String
Name of the exported scoped variable for the status of the iteration. This scoped variable has nested visibility.
dataWidgetWrapperfalsetruecom.exalead.cv360.searchui.widgets.DataWidgetWrapper
The DataWidgetWrapper that contains the widgets to iterate over. Defaults to the widget in the current context.
widgetContainerfalsetruecom.exalead.cv360.searchui.configuration.v10.WidgetContainer
The widget container that contains the widgets to iterate over. If specified, you must set the feed and entry attributes.
feedfalsetruecom.exalead.access.feedapi.ResultFeed
The parent ResultFeed for the specified widget.
entryfalsetruecom.exalead.access.feedapi.Entry
The parent Entry for the specified widget.
evalTriggersfalsefalseboolean
Specifies whether the tag should evaluate or not the widget triggers. Defaults to 'true'.
beginfalsetrueint
The index on which to begin the iteration. Defaults to '0'.
iterationfalsetrueint
The number of iteration to perform, replace the 'end' attribute. 0 is interpreted as 'unbounded'. Defaults to '0'.

Tag widget widget:widget(...)

Renders the Widget HTML wrapper.
Body Content: scriptless
Attribute nameRequiredRuntime Expression EvaluationType
varCssIdfalsefalsejava.lang.String
Name of the exported variable for the widget ID. If the widget has no ID, a random one is generated.
varUcssIdfalsefalsejava.lang.String
Name of the exported variable for the widget Unique CSS ID.
htmlTagfalsetruejava.lang.String
The HTML tag to use for the widget wrapper. Defaults to 'div'.
extraCssfalsetruejava.lang.String
CSS class to adds to the widget wrapper.
extraStylesfalsetruejava.lang.String
Styles to adds to the widget wrapper.
disableWrapperfalsetrueboolean
Specifies whether the widget wrapper should be disabled or not.
disableStylesfalsetrueboolean
Specifies whether the default style of widgets should be disabled or not.
Renders the Widget header HTML wrapper.
Body Content: scriptless
Attribute nameRequiredRuntime Expression EvaluationType
cssIdfalsetruejava.lang.String
The ID to sets to the header wrapper.
htmlTagfalsetruejava.lang.String
The HTML tag to use for the header wrapper. Defaults to 'h2'.
extraCssfalsetruejava.lang.String
CSS class to adds to the header wrapper.
extraStylesfalsetruejava.lang.String
Styles to adds to the header wrapper.

Tag content widget:content(...)

Renders the Widget content HTML wrapper.
Body Content: scriptless
Attribute nameRequiredRuntime Expression EvaluationType
cssIdfalsetruejava.lang.String
The ID to sets to the content wrapper
htmlTagfalsetruejava.lang.String
The HTML tag to use for the content wrapper. Defaults to 'div'.
extraCssfalsetruejava.lang.String
CSS class to adds to the content wrapper.
extraStylesfalsetruejava.lang.String
Styles to adds to the content wrapper.

Tag getUcssId widget:getUcssId(...)

Returns the Widget Unique CSS ID.
Body Content: empty
Attribute nameRequiredRuntime Expression EvaluationType
varfalsefalsejava.lang.String
Name of the exported variable for the retrieved Unique CSS ID.
dataWidgetWrapperfalsetruecom.exalead.cv360.searchui.widgets.DataWidgetWrapper
The DataWidgetWrapper that contains the widget we want to retrieve the Unique CSS ID from. By defaults it takes the current widget.

Function hasSubWidgets widget:hasSubWidgets(...)

Returns whether the given Widget have sub-Widgets or not.
Function Class: com.exalead.cv360.searchui.view.jspapi.widget.Functions
Function Signature: boolean hasSubWidgets(com.exalead.cv360.searchui.configuration.v10.WidgetContainer)

Example

  1. < c:if test="${widget:hasSubWidgets(widget)}" >