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 Details

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