org.eclipse.scout.rt.client.ui.messagebox

Class MessageBox

java.lang.Object

org.eclipse.scout.rt.platform.reflect.AbstractPropertyObserver

org.eclipse.scout.rt.client.ui.AbstractWidget

org.eclipse.scout.rt.client.ui.messagebox.MessageBox

All Implemented Interfaces:

IStyleable, IWidget, IMessageBox, org.eclipse.scout.rt.platform.reflect.IPropertyObserver

@Bean
public class MessageBox
extends AbstractWidget
implements IMessageBox

Implementation of message box.
Use MessageBoxes to create a message box.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	MessageBox.P_UIFacade

Field Summary

Fields inherited from class org.eclipse.scout.rt.platform.reflect.AbstractPropertyObserver

propertySupport

Fields inherited from interface org.eclipse.scout.rt.client.ui.messagebox.IMessageBox

CANCEL_OPTION, NO_OPTION, YES_OPTION

Fields inherited from interface org.eclipse.scout.rt.client.ui.IWidget

PROP_DISPOSE_DONE, PROP_INIT_CONFIG_DONE, PROP_INIT_DONE

Fields inherited from interface org.eclipse.scout.rt.client.ui.IStyleable

PROP_CSS_CLASS

Constructor Summary

Constructors

Constructor and Description
MessageBox()

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener listener)
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
protected void	closeMessageBox()
protected void	fireClosed()
protected void	fireMessageBoxEvent(MessageBoxEvent e)
long	getAutoCloseMillis()
String	getBody()
String	getCancelButtonText()
String	getCopyPasteText()
IDisplayParent	getDisplayParent()
String	getHeader()
String	getHiddenText()
org.eclipse.scout.rt.platform.html.IHtmlContent	getHtml()
String	getIconId()
String	getNoButtonText()
int	getSeverity()
IMessageBoxUIFacade	getUIFacade()
String	getYesButtonText()
protected void	initConfig()
boolean	isOpen() To query whether the message box is open or closed.
org.eclipse.scout.rt.platform.util.event.IFastListenerList<MessageBoxListener>	messageBoxListeners()
void	removePropertyChangeListener(PropertyChangeListener listener)
void	removePropertyChangeListener(String propertyName, PropertyChangeListener listener)
int	show() Displays the message box and waits for a response.
int	show(int defaultResult) Displays the message box and waits for a response.
protected void	updateCopyPasteTextInternal()
protected void	waitFor()
MessageBox	withAutoCloseMillis(long autoCloseMillis) To close the message box automatically after the specified period of time.
MessageBox	withBody(String body) Sets the body.
MessageBox	withCancelButtonText(String cancelButtonText) Sets the text for the cancel button.
MessageBox	withCopyPasteText(String copyPasteText) Sets the copy paste text.
IMessageBox	withDisplayParent(IDisplayParent displayParent) Sets the display parent to attach this IMessageBox to.
MessageBox	withHeader(String header) Sets the header.
MessageBox	withHiddenText(String hiddenText) Sets the hidden text.
MessageBox	withHtml(org.eclipse.scout.rt.platform.html.IHtmlContent html) Sets the html.
MessageBox	withIconId(String iconId)
MessageBox	withNoButtonText(String noButtonText) Sets the text for the no button.
MessageBox	withSeverity(int severity) Sets the severity.
MessageBox	withYesButtonText(String yesButtonText) Sets the text for the yes / ok button.

Methods inherited from class org.eclipse.scout.rt.client.ui.AbstractWidget

callInitializer, dispose, disposeChildren, disposeChildren, disposeInternal, getChildren, getConfiguredCssClass, getCssClass, init, initChildren, initChildren, initConfigInternal, initInternal, isDisposeDone, isInitConfigDone, isInitDone, reinit, setCssClass, setDisposeDone, setInitConfigDone, setInitDone, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit

Methods inherited from class org.eclipse.scout.rt.platform.reflect.AbstractPropertyObserver

getPropertyChangeListeners, getSpecificPropertyChangeListeners

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.scout.rt.client.ui.messagebox.IMessageBox

addMessageBoxListener, removeMessageBoxListener

Methods inherited from interface org.eclipse.scout.rt.client.ui.IWidget

dispose, getChildren, init, isDisposeDone, isInitConfigDone, isInitDone, reinit, visit, visit, visit, visit, visit, visit, visit, visit

Methods inherited from interface org.eclipse.scout.rt.client.ui.IStyleable

addCssClass, cssClassesAsList, getCssClass, removeCssClass, setCssClass, toggleCssClass

Constructor Detail

MessageBox

public MessageBox()

Method Detail

initConfig

@PostConstruct
protected void initConfig()

Overrides:

initConfig in class AbstractWidget

getDisplayParent

public IDisplayParent getDisplayParent()

Specified by:

getDisplayParent in interface IMessageBox

Returns:

the IDisplayParent to attach this IMessageBox to; is never null.

withDisplayParent

public IMessageBox withDisplayParent(IDisplayParent displayParent)

Description copied from interface: IMessageBox

Sets the display parent to attach this IMessageBox to.

A display parent is the anchor to attach this IMessageBox to, and affects its accessibility and modality scope. Possible parents are IDesktop, IOutline, or IForm:

• Desktop: IMessageBox is always accessible; blocks the entire desktop;
• Outline: IMessageBox is only accessible when the given outline is active; only blocks the outline;
• Form: IMessageBox is only accessible when the given Form is active; only blocks the Form;

Specified by:

withDisplayParent in interface IMessageBox

Parameters:

displayParent - like IDesktop, IOutline, IForm, or null to derive the IDisplayParent from the current calling context.

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Specified by:

addPropertyChangeListener in interface org.eclipse.scout.rt.platform.reflect.IPropertyObserver

Overrides:

addPropertyChangeListener in class org.eclipse.scout.rt.platform.reflect.AbstractPropertyObserver

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Specified by:

removePropertyChangeListener in interface org.eclipse.scout.rt.platform.reflect.IPropertyObserver

Overrides:

removePropertyChangeListener in class org.eclipse.scout.rt.platform.reflect.AbstractPropertyObserver

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName,
                                      PropertyChangeListener listener)

Specified by:

addPropertyChangeListener in interface org.eclipse.scout.rt.platform.reflect.IPropertyObserver

Overrides:

addPropertyChangeListener in class org.eclipse.scout.rt.platform.reflect.AbstractPropertyObserver

removePropertyChangeListener

public void removePropertyChangeListener(String propertyName,
                                         PropertyChangeListener listener)

Specified by:

removePropertyChangeListener in interface org.eclipse.scout.rt.platform.reflect.IPropertyObserver

Overrides:

removePropertyChangeListener in class org.eclipse.scout.rt.platform.reflect.AbstractPropertyObserver

getHeader

public String getHeader()

Specified by:

getHeader in interface IMessageBox

See Also:

#withHeader(String)}

withHeader

public MessageBox withHeader(String header)

Description copied from interface: IMessageBox

Sets the header.

The header is by default represented in bold font as first entry in the message box.

Specified by:

withHeader in interface IMessageBox

getBody

public String getBody()

Specified by:

getBody in interface IMessageBox

See Also:

#withBody(String)}

withBody

public MessageBox withBody(String body)

Description copied from interface: IMessageBox

Sets the body.

The body is by default represented in normal font as second entry after the header (if available).

Specified by:

withBody in interface IMessageBox

getHtml

public org.eclipse.scout.rt.platform.html.IHtmlContent getHtml()

Specified by:

getHtml in interface IMessageBox

See Also:

#withHtml(IHtmlContent)}

withHtml

public MessageBox withHtml(org.eclipse.scout.rt.platform.html.IHtmlContent html)

Description copied from interface: IMessageBox

Sets the html.

The html allows to use custom html and is positioned as third entry after the body (if available).

Specified by:

withHtml in interface IMessageBox

getHiddenText

public String getHiddenText()

Specified by:

getHiddenText in interface IMessageBox

See Also:

#withHiddenText(String)}

withHiddenText

public MessageBox withHiddenText(String hiddenText)

Description copied from interface: IMessageBox

Sets the hidden text.

The hidden text is used for the default copy paste text, thus not visible in the UI directly.
Examples usages are stacktraces or more detailed information that should not be directly presented to the user.

Specified by:

withHiddenText in interface IMessageBox

getYesButtonText

public String getYesButtonText()

Specified by:

getYesButtonText in interface IMessageBox

See Also:

#withYesButtonText(String)}

withYesButtonText

public MessageBox withYesButtonText(String yesButtonText)

Description copied from interface: IMessageBox

Sets the text for the yes / ok button.

Specified by:

withYesButtonText in interface IMessageBox

getNoButtonText

public String getNoButtonText()

Specified by:

getNoButtonText in interface IMessageBox

See Also:

#withNoButtonText(String)}

withNoButtonText

public MessageBox withNoButtonText(String noButtonText)

Description copied from interface: IMessageBox

Sets the text for the no button.

Specified by:

withNoButtonText in interface IMessageBox

getCancelButtonText

public String getCancelButtonText()

Specified by:

getCancelButtonText in interface IMessageBox

See Also:

#withCancelButtonText(String)}

withCancelButtonText

public MessageBox withCancelButtonText(String cancelButtonText)

Description copied from interface: IMessageBox

Sets the text for the cancel button.

Specified by:

withCancelButtonText in interface IMessageBox

getIconId

public String getIconId()

Specified by:

getIconId in interface IMessageBox

withIconId

public MessageBox withIconId(String iconId)

Specified by:

withIconId in interface IMessageBox

getSeverity

public int getSeverity()

Specified by:

getSeverity in interface IMessageBox

See Also:

#withSeverity(int)}

withSeverity

public MessageBox withSeverity(int severity)

Description copied from interface: IMessageBox

Sets the severity.

Specified by:

withSeverity in interface IMessageBox

Parameters:

severity - One of the IStatus constants.

Returns:

getAutoCloseMillis

public long getAutoCloseMillis()

Specified by:

getAutoCloseMillis in interface IMessageBox

See Also:

#withAutoCloseMillis(long)}

withAutoCloseMillis

public MessageBox withAutoCloseMillis(long autoCloseMillis)

Description copied from interface: IMessageBox

To close the message box automatically after the specified period of time. By default, the result IMessageBox.CANCEL_OPTION is returned after being closed. This can be changed by using IMessageBox.show(int) to construct the message box.

Specified by:

withAutoCloseMillis in interface IMessageBox

Parameters:

autoCloseMillis - timeout [ms]

getCopyPasteText

public String getCopyPasteText()

Specified by:

getCopyPasteText in interface IMessageBox

See Also:

#withCopyPasteText(String)}

withCopyPasteText

public MessageBox withCopyPasteText(String copyPasteText)

Description copied from interface: IMessageBox

Sets the copy paste text.

The text is used if the user applies the copy shortcut on the message box.

If not explicitly set, the default copy paste text is used, which is a combination of header, body, html (plain text) and hidden text (separated by newline).

Specified by:

withCopyPasteText in interface IMessageBox

updateCopyPasteTextInternal

protected void updateCopyPasteTextInternal()

messageBoxListeners

public org.eclipse.scout.rt.platform.util.event.IFastListenerList<MessageBoxListener> messageBoxListeners()

Specified by:

messageBoxListeners in interface IMessageBox

fireClosed

protected void fireClosed()

fireMessageBoxEvent

protected void fireMessageBoxEvent(MessageBoxEvent e)

getUIFacade

public IMessageBoxUIFacade getUIFacade()

Specified by:

getUIFacade in interface IMessageBox

isOpen

public boolean isOpen()

Description copied from interface: IMessageBox

To query whether the message box is open or closed.

Specified by:

isOpen in interface IMessageBox

Returns:

true if the message box is open, false if closed.

show

public int show()

Displays the message box and waits for a response.

If getAutoCloseMillis() is set, the message box will return with IMessageBox.CANCEL_OPTION after the specific time.

Specified by:

show in interface IMessageBox

Returns:

The close result (IMessageBox.YES_OPTION, IMessageBox.NO_OPTION, IMessageBox.CANCEL_OPTION).

show

public int show(int defaultResult)

Displays the message box and waits for a response.

If getAutoCloseMillis() is set, the message box will return with given response after the specific time.

Specified by:

show in interface IMessageBox

Parameters:

defaultResult - default result to return if not closed by the user (e.g. by auto-close timer).

Returns:

The close result (IMessageBox.YES_OPTION, IMessageBox.NO_OPTION, IMessageBox.CANCEL_OPTION).

waitFor

protected void waitFor()

closeMessageBox

protected void closeMessageBox()