Module io.github.mmm.ui.api.window

Package io.github.mmm.ui.api.widget.window

Interface UiPopup

All Superinterfaces:

AttributeReadAttached, AttributeReadEnabled, AttributeReadId, AttributeReadTitle, AttributeReadValid, AttributeReadVisible, AttributeWriteClosable, AttributeWriteEnabled, AttributeWriteId, AttributeWriteMaximized, AttributeWriteMinimized, AttributeWriteMoveable, AttributeWriteReadOnly, AttributeWriteResizable, AttributeWriteTitle, AttributeWriteTooltip, AttributeWriteVisible, io.github.mmm.event.EventSource<UiEvent,UiEventListener>, UiAbstractWindow, UiChildWindow, UiComposite<UiRegularWidget>, UiMutableComposite<UiRegularWidget>, UiNativeWidget, UiRemovableComposite<UiRegularWidget>, UiWidget

public interface UiPopup
extends UiChildWindow, UiNativeWidget

UiAbstractWindow representing a modal popup window that blocks the client application until it is closed.
NOTE:
You typically want to call createAndAddCloseButton(). This is not done automatically so you can define the order of the buttons yourself.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
default UiButton	createAndAddCloseButton()	This method creates a button to close this popup and adds it to the button panel.
UiButtonPanel	getButtonPanel()
static UiPopup	of(String title)

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeReadAttached

isAttached

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeReadId

getId

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeReadTitle

getTitle

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteClosable

isClosable, setClosable

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteId

setId

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteMaximized

isMaximized, setMaximized

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteMinimized

isMinimized, setMinimized

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteMoveable

isMovable, setMovable

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteResizable

isResizable, setResizable

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteTitle

setTitle

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteTooltip

getTooltip, setTooltip

Methods inherited from interface io.github.mmm.event.EventSource

addListener, addListener, addWeakListener, removeListener

Methods inherited from interface io.github.mmm.ui.api.widget.window.UiAbstractWindow

close, findChild, getParent, open

Methods inherited from interface io.github.mmm.ui.api.widget.window.UiChildWindow

centerOnScreen, getPosition, getSize

Methods inherited from interface io.github.mmm.ui.api.widget.composite.UiComposite

getChild, getChild, getChildById, getChildCount, getChildIndex, getChildSibling, getChildSibling, getDescendant, getModificationTimestamp, getPropagation, isModified, isValid, reset, setFocused

Methods inherited from interface io.github.mmm.ui.api.widget.composite.UiMutableComposite

addChild, addChild

Methods inherited from interface io.github.mmm.ui.api.widget.composite.UiRemovableComposite

removeChild, removeChild

Methods inherited from interface io.github.mmm.ui.api.widget.UiWidget

cast, dispose, getReadOnlyFixed, getStyles, isDisposed, isEnabled, isEnabled, isFocused, isReadOnly, isVisible, isVisible, setEnabled, setEnabled, setReadOnly, setReadOnlyFixed, setVisible, setVisible, validate, validate, validate, validateDown, validateUp

Method Details

getButtonPanel

UiButtonPanel getButtonPanel()

Returns:

the UiButtonPanel located at the bottom of this popup where buttons shall be added.

createAndAddCloseButton

default UiButton createAndAddCloseButton()

This method creates a button to close this popup and adds it to the button panel.

Returns:

the close button.

of

static UiPopup of(String title)

Parameters:

title - the new title of the UiPopup to create.

Returns:

the new UiPopup.