Module com.gluonhq.attach.display
Package com.gluonhq.attach.display.impl

Class DesktopDisplayService

java.lang.Object
com.gluonhq.attach.display.impl.DesktopDisplayService
All Implemented Interfaces:
DisplayService
public class DesktopDisplayService extends Object implements DisplayService

  • Property Summary

    Properties
    Type
    Property
    Description
    javafx.beans.property.ReadOnlyObjectProperty<DisplayService.Notch>
    notch
    Property that contains the position of the notch, if any, and can be used to track changes in its location.
    javafx.beans.property.ReadOnlyObjectProperty<javafx.geometry.Insets>
    systemBarsInsets
    Property that contains the insets of the system bars (typically the status bar at the top and the navigation bar at the bottom).

  • Nested Class Summary

    Nested classes/interfaces inherited from interface com.gluonhq.attach.display.DisplayService

    DisplayService.Notch

  • Constructor Summary

    Constructors
    Constructor
    Description
    DesktopDisplayService()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    javafx.geometry.Dimension2D
    getDefaultDimensions()
    Returns the default screen dimensions of a mobile device, in density independent pixel units.
    javafx.geometry.Dimension2D
    getScreenResolution()
    Retrieve the dimension of the primary screen based on its bounds
    float
    getScreenScale()
    Returns the screen scale of the primary screen
    boolean
    hasNotch()
    Indicates if the device has a notch that modifies the display or not.
    boolean
    isDesktop()
    Returns true if the device is considered a desktop / laptop.
    boolean
    isPhone()
    Returns true if the device is considered a phone.
    boolean
    isScreenRound()
    Returns true if the device has a round screen
    boolean
    isTablet()
    Returns true if the device is considered a tablet.
    javafx.beans.property.ReadOnlyObjectProperty<DisplayService.Notch>
    notchProperty()
    Property that contains the position of the notch, if any, and can be used to track changes in its location.
    javafx.beans.property.ReadOnlyObjectProperty<javafx.geometry.Insets>
    systemBarsInsetsProperty()
    Property that contains the insets of the system bars (typically the status bar at the top and the navigation bar at the bottom).

    Methods inherited from class java.lang.Object

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

  • Property Details

    • notch

      public javafx.beans.property.ReadOnlyObjectProperty<DisplayService.Notch> notchProperty
      Specified by:
      notchProperty in interface DisplayService
      Returns:
      A read only property with the position of the notch if present

    • systemBarsInsets

      public javafx.beans.property.ReadOnlyObjectProperty<javafx.geometry.Insets> systemBarsInsetsProperty
      Specified by:
      systemBarsInsetsProperty in interface DisplayService
      Returns:
      A read only property with the insets of the system bars

  • Constructor Details

    • DesktopDisplayService

      public DesktopDisplayService()

  • Method Details

    • isPhone

      public boolean isPhone()
      Description copied from interface: DisplayService
      Returns true if the device is considered a phone.
      Specified by:
      isPhone in interface DisplayService
      Returns:
      True if the device is considered a phone.

    • isTablet

      public boolean isTablet()
      Description copied from interface: DisplayService
      Returns true if the device is considered a tablet.
      Specified by:
      isTablet in interface DisplayService
      Returns:
      True if the device is considered a tablet. Running on Desktop, if the property charm-desktop-form is set to tablet, it will return true. False otherwise

    • isDesktop

      public boolean isDesktop()
      Description copied from interface: DisplayService
      Returns true if the device is considered a desktop / laptop.
      Specified by:
      isDesktop in interface DisplayService
      Returns:
      True if the device is considered a desktop / laptop.

    • getScreenResolution

      public javafx.geometry.Dimension2D getScreenResolution()
      Retrieve the dimension of the primary screen based on its bounds
      Specified by:
      getScreenResolution in interface DisplayService
      Returns:
      Dimension of the Screen

    • getDefaultDimensions

      public javafx.geometry.Dimension2D getDefaultDimensions()
      Description copied from interface: DisplayService
      Returns the default screen dimensions of a mobile device, in density independent pixel units. In case of desktop, it gives the form factor of either a phone or a tablet.
      Specified by:
      getDefaultDimensions in interface DisplayService
      Returns:
      The screen dimensions of a mobile device, in dp units.

    • getScreenScale

      public float getScreenScale()
      Returns the screen scale of the primary screen
      Specified by:
      getScreenScale in interface DisplayService
      Returns:
      the screen scale

    • isScreenRound

      public boolean isScreenRound()
      Description copied from interface: DisplayService
      Returns true if the device has a round screen
      Specified by:
      isScreenRound in interface DisplayService
      Returns:
      true if the device has a round screen

    • hasNotch

      public boolean hasNotch()
      Description copied from interface: DisplayService
      Indicates if the device has a notch that modifies the display or not.
      Specified by:
      hasNotch in interface DisplayService
      Returns:
      true if the device has a notch, false otherwise

    • notchProperty

      public javafx.beans.property.ReadOnlyObjectProperty<DisplayService.Notch> notchProperty()
      Description copied from interface: DisplayService
      Property that contains the position of the notch, if any, and can be used to track changes in its location.
      Specified by:
      notchProperty in interface DisplayService
      Returns:
      A read only property with the position of the notch if present

    • systemBarsInsetsProperty

      public javafx.beans.property.ReadOnlyObjectProperty<javafx.geometry.Insets> systemBarsInsetsProperty()
      Description copied from interface: DisplayService
      Property that contains the insets of the system bars (typically the status bar at the top and the navigation bar at the bottom). These insets can be used to add the necessary padding so the application doesn't get underneath the content shown at the system bars.
      Specified by:
      systemBarsInsetsProperty in interface DisplayService
      Returns:
      A read only property with the insets of the system bars