com.plumtree.portaluiinfrastructure.search
Interface IGroupedResultsViewHelper

All Known Implementing Classes:

CommSelGroupedResults508ViewHelper, CommSelGroupedResultsViewHelper, GroupedResults508ViewHelper, GroupedResultsViewHelper, PortletSelGroupedResults508ViewHelper, PortletSelGroupedResultsViewHelper

public interface IGroupedResultsViewHelper

Author:

CraigS

Method Summary

HTMLElement	DisplayCollection() Returns the element that all other elements will be added to, such as an HTMLElementCollection or HTMLTable.
HTMLElement	DisplayFooter() Returns an element that will appear after all results regardless of whether the results are grouped.
HTMLElement	DisplayFooterIfUngrouped() Returns an element that will appear after all results if the results are not grouped.
HTMLElement	DisplayGroupFooter(int groupNum) Returns an element that will appear after all results in a single group.
HTMLElement	DisplayGroupHeader(int groupNum) Returns the header element (e.g.
HTMLElement	DisplayHeader() Returns an element that will appear before all results, whether or not the results are grouped.
HTMLElement	DisplayHeaderIfUngrouped() Returns the header element (e.g.
HTMLScript	DisplayJavascript() Returns javascript for the view.
HTMLElement	DisplaySingleResult(int resultNum, boolean oddRow, int groupNum) Returns the element (e.g.
void	Init(AActivitySpace owner, ISearchResultModelRO model, GroupedResultsView view) Called to set the activityspace, model, and view being used
void	InitDisplayResults() Call this method before calling any of the other methods to do initialization.

Method Detail

Init

void Init(AActivitySpace owner,
          ISearchResultModelRO model,
          GroupedResultsView view)

Called to set the activityspace, model, and view being used

DisplayJavascript

HTMLScript DisplayJavascript()

Returns javascript for the view.

DisplayCollection

HTMLElement DisplayCollection()

Returns the element that all other elements will be added to, such as an HTMLElementCollection or HTMLTable. If null is returned, no other methods from this interface will be called, and the view will not be displayed.

DisplayHeader

HTMLElement DisplayHeader()

Returns an element that will appear before all results, whether or not the results are grouped.

DisplayFooter

HTMLElement DisplayFooter()

Returns an element that will appear after all results regardless of whether the results are grouped.

DisplayHeaderIfUngrouped

HTMLElement DisplayHeaderIfUngrouped()

Returns the header element (e.g. an HTMLTableRow containing column headings) that will be used if the results are not grouped. Not called if the results are grouped.

DisplayFooterIfUngrouped

HTMLElement DisplayFooterIfUngrouped()

Returns an element that will appear after all results if the results are not grouped. Not called if the results are grouped.

DisplayGroupHeader

HTMLElement DisplayGroupHeader(int groupNum)

Returns the header element (e.g. an HTMLTableRow containing column headings) that will be used if the results are grouped. Not called if the results are ungrouped.

DisplayGroupFooter

HTMLElement DisplayGroupFooter(int groupNum)

Returns an element that will appear after all results in a single group. Not called if the results are ungrouped.

DisplaySingleResult

HTMLElement DisplaySingleResult(int resultNum,
                                boolean oddRow,
                                int groupNum)

Returns the element (e.g. an HTMLTableRow) for a single search result. The "oddRow" argument helps in making tables where every other item is shaded, note that this is not the same as (resultNum % 2) for grouped results.

InitDisplayResults

void InitDisplayResults()

Call this method before calling any of the other methods to do initialization.