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

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

Interface UiMainWindow

All Superinterfaces:

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

public interface UiMainWindow
extends UiAbstractWindow, UiNativeWidget

UiAbstractWindow that represents the main window. Each client application has a single instance of this main window. In case of a web-application this represents the browser window (or more precisely the tab running the app).
ATTENTION:
There must be only a single instance of UiMainWindow that shall be accessed via get(). Never manually create UiMainWindow via UiWidgetFactoryNative.create(Class). This is only possible for modularity of the UI implementations and direct creation is unspecified and behavior can change in future versions.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
static UiMainWindow	get()
AttributeReadPosition	getPosition()	ATTENTION: It is strictly discouraged to modify the position of the main window by the application.
AttributeReadSize	getSize()	ATTENTION: It is strictly discouraged to modify the size of the main window by the application.
boolean	isWindowPositionAbsolute()

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.AttributeWriteId

setId

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.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 Detail

getPosition

AttributeReadPosition getPosition()

ATTENTION: It is strictly discouraged to modify the position of the main window by the application. In case of a web-application this will move the browser window what will cause unacceptable impact on usability. However, if you are fully aware of what you are doing, it is technically possible to cast the result of this method to AttributeWritePosition to do so.

Specified by:

getPosition in interface UiAbstractWindow

Returns:

access to read and write the position of this window.

getSize

AttributeReadSize getSize()

ATTENTION: It is strictly discouraged to modify the size of the main window by the application. In case of a web-application this will resize the browser window what will cause unacceptable impact on usability. However, if you are fully aware of what you are doing, it is technically possible to cast the result of this method to AttributeWriteSizeInPixel to do so.

Specified by:

getSize in interface UiAbstractWindow

Returns:

access to read and write the size of this window.

isWindowPositionAbsolute

boolean isWindowPositionAbsolute()

Returns:

true if the position of windows is absolute (on UiScreen), false if relative to this main window (MDI mode).

get

static UiMainWindow get()

Returns:

the UiMainWindow instance.