org.opencms.ui.dialogs.history.diff

Interface I_CmsDiffProvider

All Known Implementing Classes:

A_CmsAttributeDiff, CmsAttributeDiff, CmsImageDiff, CmsPropertyDiff, CmsShowVersionButtons, CmsTextDiff, CmsValueDiff

public interface I_CmsDiffProvider

Interface for classes which display a comparison widget in the comparison view of the history dialog.

Method Summary

Modifier and Type	Method and Description
com.google.common.base.Optional<com.vaadin.ui.Component>	diff(CmsObject cms, CmsHistoryResourceBean v1, CmsHistoryResourceBean v2) Optionally returns a comparison component to display for the given resource versions.

Method Detail

diff

com.google.common.base.Optional<com.vaadin.ui.Component> diff(CmsObject cms,
                                                              CmsHistoryResourceBean v1,
                                                              CmsHistoryResourceBean v2)
                                                       throws CmsException

Optionally returns a comparison component to display for the given resource versions.

If no value is returned, then no widget is displayed.

Parameters:

cms - the CMS context

v1 - bean representing the first version

v2 - bean representing the second version

Returns:

the optional component to display

Throws:

CmsException - if something goes wrong