Package org.hippoecm.frontend.dialog
Interface IDialogService.Dialog
-
- All Superinterfaces:
org.apache.wicket.util.io.IClusterable
,Serializable
- All Known Implementing Classes:
AbstractDialog
,AbstractWizard
,AbstractWorkflowDialog
,CompatibilityWorkflowPlugin.WorkflowAction.ConfirmDialog
,CompatibilityWorkflowPlugin.WorkflowAction.DateDialog
,CompatibilityWorkflowPlugin.WorkflowAction.DestinationDialog
,CompatibilityWorkflowPlugin.WorkflowAction.NameDialog
,CompatibilityWorkflowPlugin.WorkflowAction.TextDialog
,CompatibilityWorkflowPlugin.WorkflowAction.WorkflowDialog
,Confirm
,ConfirmDialog
,DeleteDialog
,DestinationDialog
,Dialog
,DocumentMetadataDialog
,ExceptionDialog
,JQueryFileUploadDialog
,TextDialog
,WhereUsedDialog
,Wizard
,WorkflowDialog
- Enclosing interface:
- IDialogService
public static interface IDialogService.Dialog extends org.apache.wicket.util.io.IClusterable
Interface that must be implemented by clients of the dialog service.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description org.apache.wicket.Component
getComponent()
org.apache.wicket.util.value.IValueMap
getProperties()
Properties that determine how the dialog is rendered.org.apache.wicket.model.IModel<String>
getTitle()
The title of the dialog.default void
onCancelFromCloseButton()
Invoked when the built-in close button (X) is clicked.void
onClose()
Invoked when the dialog is closed.void
render(PluginRequestTarget target)
Part of the pre-rendering registration.void
setDialogService(IDialogService service)
When the dialog is shown (IDialogService.show(Dialog)
), the dialog service is injected into the dialog.
-
-
-
Method Detail
-
setDialogService
void setDialogService(IDialogService service)
When the dialog is shown (IDialogService.show(Dialog)
), the dialog service is injected into the dialog.
-
render
void render(PluginRequestTarget target)
Part of the pre-rendering registration. When the dialog has components that should be rendered, they can be registered with the target.Implementations must invoke
IRenderService.render(PluginRequestTarget)
on render services that contribute to the wicket component hierarchy.
-
getComponent
org.apache.wicket.Component getComponent()
- Returns:
- a component with wicket id "content"
-
getTitle
org.apache.wicket.model.IModel<String> getTitle()
The title of the dialog. Will be displayed in the dialog border.
-
onClose
void onClose()
Invoked when the dialog is closed. Since the dialog will be decorated with a close button (X), this method may be called even when the dialog is not explicitly closed viaIDialogService.close()
.
-
getProperties
org.apache.wicket.util.value.IValueMap getProperties()
Properties that determine how the dialog is rendered. In particular, the width and height properties are used for the size (in pixels).
-
onCancelFromCloseButton
default void onCancelFromCloseButton()
Invoked when the built-in close button (X) is clicked. In general, clicking the close button (X) is considered similar to cancelling a dialog. As such, to be able to invoke the correctScriptAction
inDialog.onClose()
we have to inform the dialog that it is actually cancelled, before closing it.A default implementation is provided to maintain backwards compatibility with custom dialogs that directly implement interface
IDialogService.Dialog
instead of extending classDialog
.- Since:
- 13.2
-
-