public interface OverlayLayer
Modifier and Type | Interface and Description |
---|---|
static class |
OverlayLayer.ModalityDomain
The available locations of modality for opening a modal.
|
static class |
OverlayLayer.ModalityLevel
The available levels of modality.
|
Modifier and Type | Method and Description |
---|---|
void |
openAlert(MessageStyleType type,
String title,
String body,
String okButton,
AlertCallback callback)
Opens an alert dialog of given
type , with given title and body. |
void |
openAlert(MessageStyleType type,
String title,
View body,
String okButton,
AlertCallback callback)
Opens an alert dialog of given
type , with given title and body. |
void |
openAlert(MessageStyleType type,
View body,
String okButton,
AlertCallback callback)
Deprecated.
since 5.3, you should probably pass the dialog title via
openAlert(MessageStyleType, String, View, String, AlertCallback) . |
void |
openConfirmation(MessageStyleType type,
String title,
String body,
String confirmButton,
String cancelButton,
boolean cancelIsDefault,
ConfirmationCallback callback)
Opens a confirmation dialog of given
type , with given title and body. |
void |
openConfirmation(MessageStyleType type,
String title,
View body,
String confirmButton,
String cancelButton,
boolean cancelIsDefault,
ConfirmationCallback callback)
Opens a confirmation dialog of given
type , with given title and body. |
void |
openConfirmation(MessageStyleType type,
View body,
String confirmButton,
String cancelButton,
boolean cancelIsDefault,
ConfirmationCallback callback)
Deprecated.
since 5.3, you should probably pass the dialog title via
openConfirmation(MessageStyleType, String, View, String, String, boolean, ConfirmationCallback) . |
void |
openNotification(MessageStyleType type,
boolean doesTimeout,
String title)
Notification indicator is a message banner that only shows a message to user.
|
void |
openNotification(MessageStyleType type,
boolean doesTimeout,
String title,
String linkText,
NotificationCallback cb)
Notification indicator is a message banner that only shows a message to user.
|
void |
openNotification(MessageStyleType type,
boolean doesTimeout,
View viewToShow)
Notification indicator is a message banner that only shows a message to user.
|
OverlayCloser |
openOverlay(View view)
Open an Overlay on top of the OverlayLayer implementer.
|
OverlayCloser |
openOverlay(View view,
OverlayLayer.ModalityLevel modalityLevel)
Open an Overlay on top of the OverlayLayer implementer.
|
OverlayCloser openOverlay(View view)
view
- View of the component to be displayed modally.OverlayCloser openOverlay(View view, OverlayLayer.ModalityLevel modalityLevel)
modalityLevel
- Modality level@Deprecated void openAlert(MessageStyleType type, View body, String okButton, AlertCallback callback)
openAlert(MessageStyleType, String, View, String, AlertCallback)
.type
, with given body but with empty title.type
- the message level, i.e. INFO, WARNING or ERRORbody
- the alert dialog's body as a magnolia View
; alternatively one may wrap any Vaadin component as a View using ViewAdapter
okButton
- the OK button textcallback
- the callback to execute when the OK button is pressed, or when the dialog is closedvoid openAlert(MessageStyleType type, String title, String body, String okButton, AlertCallback callback)
type
, with given title and body.type
- the message level, i.e. INFO, WARNING or ERRORtitle
- the alert dialog's titlebody
- the alert dialog's text bodyokButton
- the OK button textcallback
- the callback to execute when the OK button is pressed, or when the dialog is closedvoid openAlert(MessageStyleType type, String title, View body, String okButton, AlertCallback callback)
type
, with given title and body.type
- the message level, i.e. INFO, WARNING or ERRORtitle
- the alert dialog's titlebody
- the alert dialog's body as a magnolia View
; alternatively one may wrap any Vaadin component as a View using ViewAdapter
okButton
- the OK button textcallback
- the callback to execute when the OK button is pressed, or when the dialog is closed@Deprecated void openConfirmation(MessageStyleType type, View body, String confirmButton, String cancelButton, boolean cancelIsDefault, ConfirmationCallback callback)
openConfirmation(MessageStyleType, String, View, String, String, boolean, ConfirmationCallback)
.type
, with given body but with empty title.type
- the message level, i.e. INFO, WARNING or ERRORbody
- the confirmation dialog's body as a magnolia View
; alternatively one may wrap any Vaadin component as a View using ViewAdapter
confirmButton
- the confirm button textcancelButton
- the cancel button textcancelIsDefault
- whether the cancel button should be focused by defaultcallback
- the callback to execute when any button is pressed, or when the dialog is closedvoid openConfirmation(MessageStyleType type, String title, String body, String confirmButton, String cancelButton, boolean cancelIsDefault, ConfirmationCallback callback)
type
, with given title and body.type
- the message level, i.e. INFO, WARNING or ERRORtitle
- the confirmation dialog's titlebody
- the confirmation dialog's body textconfirmButton
- the confirm button textcancelButton
- the cancel button textcancelIsDefault
- whether the cancel button should be focused by defaultcallback
- the callback to execute when any button is pressed, or when the dialog is closedvoid openConfirmation(MessageStyleType type, String title, View body, String confirmButton, String cancelButton, boolean cancelIsDefault, ConfirmationCallback callback)
type
, with given title and body.type
- the message level, i.e. INFO, WARNING or ERRORtitle
- the confirmation dialog's titlebody
- the confirmation dialog's body as a magnolia View
; alternatively one may wrap any Vaadin component as a View using ViewAdapter
confirmButton
- the confirm button textcancelButton
- the cancel button textcancelIsDefault
- whether the cancel button should be focused by defaultcallback
- the callback to execute when any button is pressed, or when the dialog is closedvoid openNotification(MessageStyleType type, boolean doesTimeout, View viewToShow)
viewToShow
- Content to show as View.void openNotification(MessageStyleType type, boolean doesTimeout, String title)
title
- Content to show as string.void openNotification(MessageStyleType type, boolean doesTimeout, String title, String linkText, NotificationCallback cb)
title
- Content to show as string.linkText
- Text to show in a link button.cb
- Callback for when user clicks on link.Copyright © 2015 Magnolia International Ltd.. All rights reserved.