com.liferay.portlet.wiki.lar
Class WikiDisplayPortletDataHandlerImpl

java.lang.Object
  com.liferay.portal.kernel.lar.BasePortletDataHandler
      com.liferay.portlet.wiki.lar.WikiDisplayPortletDataHandlerImpl

All Implemented Interfaces:

PortletDataHandler

public class WikiDisplayPortletDataHandlerImpl
extends BasePortletDataHandler

Constructor Summary

WikiDisplayPortletDataHandlerImpl()

Method Summary

protected PortletPreferences	doDeleteData(PortletDataContext portletDataContext, String portletId, PortletPreferences portletPreferences)
protected String	doExportData(PortletDataContext portletDataContext, String portletId, PortletPreferences portletPreferences)
protected PortletPreferences	doImportData(PortletDataContext portletDataContext, String portletId, PortletPreferences portletPreferences, String data)
String[]	getDataPortletPreferences() Returns an array of the portlet preferences that reference data.
PortletDataHandlerControl[]	getExportControls() Returns an array of the controls defined for this data handler.
PortletDataHandlerControl[]	getExportMetadataControls() Returns an array of the metadata controls defined for this data handler.
PortletDataHandlerControl[]	getImportControls() Returns an array of the controls defined for this data handler.
PortletDataHandlerControl[]	getImportMetadataControls() Returns an array of the metadata controls defined for this data handler.
PortletPreferences	importData(PortletDataContext portletDataContext, String portletId, PortletPreferences portletPreferences, String data) Handles any special processing of the data when the portlet is imported into a new layout.

Methods inherited from class com.liferay.portal.kernel.lar.BasePortletDataHandler

deleteData, exportData, isAlwaysExportable, isAlwaysStaged, isDataLocalized, isPublishToLiveByDefault

Methods inherited from class java.lang.Object

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

Constructor Detail

WikiDisplayPortletDataHandlerImpl

public WikiDisplayPortletDataHandlerImpl()

Method Detail

getDataPortletPreferences

public String[] getDataPortletPreferences()

Description copied from interface: PortletDataHandler

Returns an array of the portlet preferences that reference data. These preferences should only be updated if the referenced data is imported.

Specified by:

getDataPortletPreferences in interface PortletDataHandler

Overrides:

getDataPortletPreferences in class BasePortletDataHandler

Returns:

A String array

getExportControls

public PortletDataHandlerControl[] getExportControls()

Description copied from interface: PortletDataHandler

Returns an array of the controls defined for this data handler. These controls enable the developer to create fine grained controls over export behavior. The controls are rendered in the export UI.

Specified by:

getExportControls in interface PortletDataHandler

Overrides:

getExportControls in class BasePortletDataHandler

Returns:

an array of PortletDataHandlerControls

getExportMetadataControls

public PortletDataHandlerControl[] getExportMetadataControls()

Description copied from interface: PortletDataHandler

Returns an array of the metadata controls defined for this data handler. These controls enable the developer to create fine grained controls over export behavior of metadata such as tags, categories, ratings or comments. The controls are rendered in the export UI.

Specified by:

getExportMetadataControls in interface PortletDataHandler

Overrides:

getExportMetadataControls in class BasePortletDataHandler

Returns:

an array of PortletDataHandlerControls

getImportControls

public PortletDataHandlerControl[] getImportControls()

Description copied from interface: PortletDataHandler

Returns an array of the controls defined for this data handler. These controls enable the developer to create fine grained controls over import behavior. The controls are rendered in the import UI.

Specified by:

getImportControls in interface PortletDataHandler

Overrides:

getImportControls in class BasePortletDataHandler

Returns:

An array of PortletDataHandlerControls

getImportMetadataControls

public PortletDataHandlerControl[] getImportMetadataControls()

Description copied from interface: PortletDataHandler

Returns an array of the metadata controls defined for this data handler. These controls enable the developer to create fine grained controls over import behavior of metadata such as tags, categories, ratings or comments. The controls are rendered in the export UI.

Specified by:

getImportMetadataControls in interface PortletDataHandler

Overrides:

getImportMetadataControls in class BasePortletDataHandler

Returns:

an array of PortletDataHandlerControls

importData

public PortletPreferences importData(PortletDataContext portletDataContext,
                                     String portletId,
                                     PortletPreferences portletPreferences,
                                     String data)
                              throws PortletDataException

Description copied from interface: PortletDataHandler

Handles any special processing of the data when the portlet is imported into a new layout. Can optionally return a modified version of preferences to be saved in the new portlet.

Specified by:

importData in interface PortletDataHandler

Overrides:

importData in class BasePortletDataHandler

Parameters:

portletDataContext - the context of the data import

portletId - the portlet ID of the portlet

portletPreferences - the portlet preferences of the portlet

data - the string data that was returned by exportData()

Returns:

A modified version of portlet preferences that should be saved. Null if the portlet preferences were unmodified by this data handler.

Throws:

PortletDataException

doDeleteData

protected PortletPreferences doDeleteData(PortletDataContext portletDataContext,
                                          String portletId,
                                          PortletPreferences portletPreferences)
                                   throws Exception

Overrides:

doDeleteData in class BasePortletDataHandler

Throws:

Exception

doExportData

protected String doExportData(PortletDataContext portletDataContext,
                              String portletId,
                              PortletPreferences portletPreferences)
                       throws Exception

Overrides:

doExportData in class BasePortletDataHandler

Throws:

Exception

doImportData

protected PortletPreferences doImportData(PortletDataContext portletDataContext,
                                          String portletId,
                                          PortletPreferences portletPreferences,
                                          String data)
                                   throws Exception

Overrides:

doImportData in class BasePortletDataHandler

Throws:

Exception