Implement how to display subwidgets

You may want to include widgets within other widgets, this is what we call subwidgets.

This page discusses:

See Also
Widget architecture
Widget manifest
Implement how to display subwidgets
Update widgets with Mashup Ajax Client
Troubleshooting

You can choose between two modes to display subwidgets in widget containers:

  • List mode (default behavior), to display subwidgets in a list, one after the other.

  • Layout mode, to display subwidgets in rows and columns. For example, see the Tab and Table widgets.

Once the widget is packaged with the required code in the widget.xml and widget.jsp files, a new Edit Widget Layout entry is available in the widget menu, to let you customize the layout, exactly like a page.

Display subwidgets in List mode

widget.xml

<SupportWidgetsId arity="ZERO_OR_MANY" displayType="LIST" />

 <-- or -->

<SupportWidgetsId arity="ZERO_OR_MANY" />

widget.jsp

<%@ taglib prefix="render" uri="http://www.exalead.com/jspapi/render" %>
<%@ taglib prefix="widget" uri="http://www.exalead.com/jspapi/widget" %>

<%-- Iterate and render all subwidgets --%>
<render:subWidgets />

<%--Iterate and render all subwidgets for a specific entry --%>
<widget:forEachSubWidget  widgetContainer="${widget}" feed="${feed}" entry="${entry}">
     <render:widget />
</widget:forEachSubWidget>

Display subwidgets in Layout mode

widget.xml

<SupportWidgetsId arity="ZERO_OR_MANY" displayType="LAYOUT" />

widget.jsp

<%@ taglib prefix="render" uri="http://www.exalead.com/jspapi/render" %>
<%@ taglib prefix="widget" uri="http://www.exalead.com/jspapi/widget" %>

<render:import varWidget="widget" varParentEntry="parentEntry" varParentFeed="parentFeed" />

<render:definition name="tableLayout">
	<render:parameter name="prefix" value="${widget.wuid}" />
	<render:parameter name="layout" value="${widget.layout}" />
	<render:parameter name="parentFeed" value="${parentFeed}" />
	<render:parameter name="parentEntry" value="${parentEntry}" />
</render:definition>