Class DefaultExportEditorAreaAction
- java.lang.Object
-
- de.hybris.platform.cockpit.components.listview.AbstractListViewAction
-
- de.hybris.platform.cockpit.components.editorarea.export.DefaultExportEditorAreaAction
-
- All Implemented Interfaces:
AdvancedListViewAction
,ListViewAction
- Direct Known Subclasses:
ExportEditorArea2PdfAction
,ExportEditorArea2XlsAction
public class DefaultExportEditorAreaAction extends AbstractListViewAction
Creates action which generates pdf (or any other) preview of underling item. Preview is defined by editor area configuration.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface de.hybris.platform.cockpit.components.listview.ListViewAction
ListViewAction.Context
-
-
Field Summary
-
Fields inherited from class de.hybris.platform.cockpit.components.listview.AbstractListViewAction
alwaysEnabled, IN_EDITOR_AREA_SECTION_PANEL
-
Fields inherited from interface de.hybris.platform.cockpit.components.listview.ListViewAction
AFFECTED_ITEMS_KEY
-
-
Constructor Summary
Constructors Constructor Description DefaultExportEditorAreaAction()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
doCreateContext(ListViewAction.Context context)
EditorConfiguration
getConfiguration(java.lang.String typecode)
org.zkoss.zul.Menupopup
getContextPopup(ListViewAction.Context context)
Gets the context popup of the action button.protected EditorAreaExporter
getEditorAreaExporter()
org.zkoss.zk.ui.event.EventListener
getEventListener(ListViewAction.Context context)
Gets theEventListener
which is to be registered for theEvents.ON_CLICK
event.protected java.lang.String
getFileName()
protected java.lang.String
getFileName(TypedObject item)
java.lang.String
getImageURI(ListViewAction.Context context)
Gets the image URI which represents the action button.org.zkoss.zul.Menupopup
getPopup(ListViewAction.Context context)
Gets the popup of the action button.java.lang.String
getTooltip(ListViewAction.Context context)
Gets the tooltip of the action button.void
setEditorAreaExporter(EditorAreaExporter editorAreaExporter)
void
setFileName(java.lang.String fileName)
void
setImageURI(java.lang.String imageURI)
void
setTooltip(java.lang.String tooltip)
void
setuIConfigurationService(UIConfigurationService uIConfigurationService)
-
Methods inherited from class de.hybris.platform.cockpit.components.listview.AbstractListViewAction
createContext, createContext, getItem, getMultiSelectEventListener, getMultiSelectImageURI, getMultiSelectPopup, getSelectedItems, getStatusCode, isAlwaysEnabled, sendEvent, sendUpdateItemsEvent, setAlwaysEnabled
-
-
-
-
Method Detail
-
doCreateContext
protected void doCreateContext(ListViewAction.Context context)
- Specified by:
doCreateContext
in classAbstractListViewAction
-
getContextPopup
public org.zkoss.zul.Menupopup getContextPopup(ListViewAction.Context context)
Description copied from interface:ListViewAction
Gets the context popup of the action button.- Returns:
- the popup which should appear when the user right-clicks the action button or
null
if no popup is available
-
getEventListener
public org.zkoss.zk.ui.event.EventListener getEventListener(ListViewAction.Context context)
Description copied from interface:ListViewAction
Gets theEventListener
which is to be registered for theEvents.ON_CLICK
event.- Returns:
- the event listener which should be called when user clicks the action button
-
getFileName
protected java.lang.String getFileName(TypedObject item)
- Returns:
- the desired file name
-
getImageURI
public java.lang.String getImageURI(ListViewAction.Context context)
Description copied from interface:ListViewAction
Gets the image URI which represents the action button.- Returns:
- URI of the image to represent the action button
-
setImageURI
public void setImageURI(java.lang.String imageURI)
-
getPopup
public org.zkoss.zul.Menupopup getPopup(ListViewAction.Context context)
Description copied from interface:ListViewAction
Gets the popup of the action button.- Returns:
- the popup which should appear when the user clicks the action button or
null
if no popup is available
-
getTooltip
public java.lang.String getTooltip(ListViewAction.Context context)
Description copied from interface:ListViewAction
Gets the tooltip of the action button.- Returns:
- the tooltip string which should appear when the user hovers over the action button
-
setEditorAreaExporter
public void setEditorAreaExporter(EditorAreaExporter editorAreaExporter)
-
getConfiguration
public EditorConfiguration getConfiguration(java.lang.String typecode)
-
setuIConfigurationService
public void setuIConfigurationService(UIConfigurationService uIConfigurationService)
-
getEditorAreaExporter
protected EditorAreaExporter getEditorAreaExporter()
-
getFileName
protected java.lang.String getFileName()
-
setFileName
public void setFileName(java.lang.String fileName)
-
setTooltip
public void setTooltip(java.lang.String tooltip)
- Parameters:
tooltip
- the tooltip to set
-
-