io.github.mmm.ui.api.UiScreen Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mmm-ui-api-core Show documentation

Core of the API for user-interface.

There is a newer version: 0.9.11

/* Copyright (c) The m-m-m Team, Licensed under the Apache License, Version 2.0
 * http://www.apache.org/licenses/LICENSE-2.0 */
package io.github.mmm.ui.api;

import io.github.mmm.ui.api.attribute.AttributeReadSize;
import io.github.mmm.ui.api.datatype.UiScreenType;
import io.github.mmm.ui.impl.UiScreenProvider;

/**
 * This is the interface for the display where the UI objects are shown. 

 * ATTENTION:

 * Be aware of multi-monitor setups. This object will represent the main screen OR the current screen where the main
 * window is located. This can depend on the underlying implementation or in case of a web-application on the browser.
 *
 * @see #get()
 * @since 1.0.0
 */
public interface UiScreen extends AttributeReadSize {

  /**
   * @return the {@link UiScreenType} that categorizes the display size.
   */
  UiScreenType getType();

  /**
   * @return the dots per inch (DPI) rate of this display.
   */
  double getDpi();

  /**
   * @return screen size (diagonal) in inches.
   */
  double getSize();

  /**
   * Forces the display to update. Typically the screen-resolution does not change while your application is running.
   * Therefore values of {@link UiScreen} may be pre-calculated and cached. However, you can call this method before
   * reading resolution or screen type to force that you are getting most recent values.
   */
  void update();

  /**
   * @return the singleton instance of this {@link UiScreen}.
   */
  static UiScreen get() {

    return UiScreenProvider.SCREEN;
  }

}