info.magnolia.ui.framework.overlay
Class OverlayPresenter

java.lang.Object
  info.magnolia.ui.framework.overlay.OverlayPresenter

All Implemented Interfaces:

OverlayLayer

public abstract class OverlayPresenter
extends Object
implements OverlayLayer

Provides implementations for most OverlayLayer methods.

Nested Class Summary

Nested classes/interfaces inherited from interface info.magnolia.ui.api.overlay.OverlayLayer

OverlayLayer.ModalityDomain, OverlayLayer.ModalityLevel

Field Summary

static int

TIMEOUT_SECONDS_DEFAULT

Constructor Summary

OverlayPresenter()

Method Summary

void	openAlert(MessageStyleType type, String title, String body, String confirmButtonText, AlertCallback cb) Convenience method with string content.
void	openAlert(MessageStyleType type, View viewToShow, String confirmButtonText, AlertCallback cb) Open alert dialog with light modality level.
void	openConfirmation(MessageStyleType type, String title, String body, String confirmButtonText, String cancelButtonText, boolean cancelIsDefault, ConfirmationCallback cb) Present modal confirmation dialog with light modality level.
void	openConfirmation(MessageStyleType type, View contentView, String confirmButtonText, String cancelButtonText, boolean cancelIsDefault, ConfirmationCallback callback) Present modal confirmation dialog with light modality level.
void	openNotification(MessageStyleType type, boolean doesTimeout, String title) Convenience method for presenting notification indicator with string content.
void	openNotification(MessageStyleType type, boolean doesTimeout, String title, String linkText, NotificationCallback cb) Convenience method for presenting notification indicator with string content.
void	openNotification(MessageStyleType type, boolean doesTimeout, View viewToShow) Present notification indicator with no modality.
OverlayCloser	openOverlay(View view) Convenience method to open an overlay with the default strong modality level.

Methods inherited from class java.lang.Object

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

Methods inherited from interface info.magnolia.ui.api.overlay.OverlayLayer

openOverlay

Field Detail

TIMEOUT_SECONDS_DEFAULT

public static final int TIMEOUT_SECONDS_DEFAULT

See Also:

Constant Field Values

Constructor Detail

OverlayPresenter

public OverlayPresenter()

Method Detail

openOverlay

public OverlayCloser openOverlay(View view)

Convenience method to open an overlay with the default strong modality level.

Specified by:

openOverlay in interface OverlayLayer

Parameters:

view - View of the component to be displayed modally.

openAlert

public void openAlert(MessageStyleType type,
                      View viewToShow,
                      String confirmButtonText,
                      AlertCallback cb)

Open alert dialog with light modality level. Close dialog on confirm.

Specified by:

openAlert in interface OverlayLayer

openAlert

public void openAlert(MessageStyleType type,
                      String title,
                      String body,
                      String confirmButtonText,
                      AlertCallback cb)

Convenience method with string content. for opening an alert.

Specified by:

openAlert in interface OverlayLayer

openConfirmation

public void openConfirmation(MessageStyleType type,
                             View contentView,
                             String confirmButtonText,
                             String cancelButtonText,
                             boolean cancelIsDefault,
                             ConfirmationCallback callback)

Present modal confirmation dialog with light modality level. Allow any Vaadin content to be presented.

Specified by:

openConfirmation in interface OverlayLayer

openConfirmation

public void openConfirmation(MessageStyleType type,
                             String title,
                             String body,
                             String confirmButtonText,
                             String cancelButtonText,
                             boolean cancelIsDefault,
                             ConfirmationCallback cb)

Present modal confirmation dialog with light modality level. Allow only string content.

Specified by:

openConfirmation in interface OverlayLayer

openNotification

public void openNotification(MessageStyleType type,
                             boolean doesTimeout,
                             View viewToShow)

Present notification indicator with no modality. Close after timeout expires.

Specified by:

openNotification in interface OverlayLayer

viewToShow - Content to show as View.

openNotification

public void openNotification(MessageStyleType type,
                             boolean doesTimeout,
                             String title)

Convenience method for presenting notification indicator with string content.

Specified by:

openNotification in interface OverlayLayer

title - Content to show as string.

openNotification

public void openNotification(MessageStyleType type,
                             boolean doesTimeout,
                             String title,
                             String linkText,
                             NotificationCallback cb)

Convenience method for presenting notification indicator with string content.

Specified by:

openNotification in interface OverlayLayer

title - Content to show as string.

linkText - Text to show in a link button.

cb - Callback for when user clicks on link.