|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A PortletDataHandler
is a special class capable of exporting and
importing portlet specific data to a Liferay Archive file (LAR) when a
community's layouts are exported or imported.
PortletDataHandler
s are defined by placing a
portlet-data-handler-class
element in the portlet
section of the liferay-portlet.xml file.
Method Summary | |
java.lang.String |
exportData(PortletDataContext context,
java.lang.String portletId,
javax.portlet.PortletPreferences prefs)
Returns a string of data to be placed in the <portlet-data> section of the LAR file. |
PortletDataHandlerControl[] |
getExportControls()
Returns an array of the controls defined for this data handler. |
PortletDataHandlerControl[] |
getImportControls()
Returns an array of the controls defined for this data handler. |
javax.portlet.PortletPreferences |
importData(PortletDataContext context,
java.lang.String portletId,
javax.portlet.PortletPreferences prefs,
java.lang.String data)
Handles any special processing of the data when the portlet is imported into a new layout. |
Method Detail |
public PortletDataHandlerControl[] getExportControls() throws PortletDataException
PortletDataException
public PortletDataHandlerControl[] getImportControls() throws PortletDataException
PortletDataException
public java.lang.String exportData(PortletDataContext context, java.lang.String portletId, javax.portlet.PortletPreferences prefs) throws PortletDataException
data
parameter of importData()
.
context
- the context of the data exportportletId
- the portlet id of the portletprefs
- the portlet preferences of the portlet
PortletDataException
public javax.portlet.PortletPreferences importData(PortletDataContext context, java.lang.String portletId, javax.portlet.PortletPreferences prefs, java.lang.String data) throws PortletDataException
prefs
to be saved in the new portlet.
context
- the context of the data importportletId
- the portlet id of the portletprefs
- the portlet preferences of the portletdata
- the string data that was returned by
exportData()
PortletDataException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |