Package swingtree.layout

Class Size

java.lang.Object
swingtree.layout.Size
@Immutable public final class Size extends Object
An immutable value object that represents a size in the form of float based width and height or lack thereof. This is used to represent the size and layout dimensions of components in the SwingTree style API, as well as the size of icons as part of IconDeclarations. See UIForAnySwing.withStyle(Styler), ComponentStyleDelegate.image(swingtree.api.Configurator) and ImageConf.size(int, int) for examples of where and how this class is used.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
     
    int
    hashCode()
     
    boolean
    hasPositiveHeight()
    Allows you to check if the height value of this Size instance is both specified (non-negative) and also positive.
    boolean
    hasPositiveWidth()
    Allows you to check if the width value of this Size instance is both specified (non-negative) and also positive.
    Optional<Float>
    height()
    The height of this Size instance may not be specified, in which case this method returns Optional.empty() and the thing that this configuration is applied to should resort to its default height.
    Size
    minus(double size)
    Creates an updated Size instance where the width and height are decreased by the given amount.
    Size
    minus(double width, double height)
    Creates an updated Size instance where the width and height are decreased by the given amount.
    Size
    minus(Size size)
    Creates an updated Size instance where the width and height are decreased by the width and height of the given size.
    static Size
    of(double width, double height)
    A factory method that creates a Size instance from a width and height.
    static Size
    of(float width, float height)
    A factory method that creates a Size instance from a width and height.
    static Size
    of(@Nullable Dimension dimension)
    A factory method that creates a Size instance from a Dimension.
    Size
    plus(double size)
    Creates an updated Size instance where the width and height are increased by the given amount.
    Size
    plus(double width, double height)
    Creates an updated Size instance where the width and height are increased by the given amount.
    Size
    plus(Size size)
    Creates an updated Size instance where the width and height are increased by the width and height of the given size.
    Size
    round()
    Rounds the float based width and height of this Size to the nearest integer value and returns these as a new Size.
    Size
    scale(double scaleFactor)
    Scales the width and height of this Size instance by the given factor.
    Dimension
    toDimension()
     
    String
    toString()
     
    static Size
    unknown()
    Exposes the UNKNOWN size instance, which is a null object that represents an unknown size.
    Optional<Float>
    width()
    The width of this Size instance may not be specified, in which case this method returns Optional.empty() and the thing that this configuration is applied to should resort to its default width.
    Size
    withHeight(double height)
    Creates an updated Size instance with the given height.
    Size
    withWidth(double width)
    Creates an updated Size instance with the given width.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Method Details

    • unknown

      public static Size unknown()
      Exposes the UNKNOWN size instance, which is a null object that represents an unknown size. It uses -1 for both width and height and will return Optional.empty() for both width and height.
      Returns:
      A Size instance that represents an unknown size.

    • of

      public static Size of(float width, float height)
      A factory method that creates a Size instance from a width and height. If the width and height is negative, the returned size will be the UNKNOWN size constant with a width or height of -1.
      Parameters:
      width - The width of the size in the form of a float.
      height - The height of the size in the form of a float.
      Returns:
      A Size instance that represents the given width and height.

    • of

      public static Size of(double width, double height)
      A factory method that creates a Size instance from a width and height. If the width or height is negative, the returned size will be the UNKNOWN size constant with a width or height of -1.
      Parameters:
      width - The width of the size in the form of a double.
      height - The height of the size in the form of a double.
      Returns:
      A Size instance that represents the given width and height.

    • of

      public static Size of(@Nullable Dimension dimension)
      A factory method that creates a Size instance from a Dimension.
      Parameters:
      dimension - The dimension to convert to a Size instance.
      Returns:
      A Size instance that represents the given dimension.

    • width

      public Optional<Float> width()
      The width of this Size instance may not be specified, in which case this method returns Optional.empty() and the thing that this configuration is applied to should resort to its default width.
      Returns:
      The width of this Size instance or Optional.empty() if unknown.

    • height

      public Optional<Float> height()
      The height of this Size instance may not be specified, in which case this method returns Optional.empty() and the thing that this configuration is applied to should resort to its default height.
      Returns:
      The height of this Size instance or Optional.empty() if unknown.

    • hasPositiveWidth

      public boolean hasPositiveWidth()
      Allows you to check if the width value of this Size instance is both specified (non-negative) and also positive.
      Returns:
      True if the width is both specified and positive, false otherwise.

    • hasPositiveHeight

      public boolean hasPositiveHeight()
      Allows you to check if the height value of this Size instance is both specified (non-negative) and also positive.
      Returns:
      True if the height is both specified and positive, false otherwise.

    • withWidth

      public Size withWidth(double width)
      Creates an updated Size instance with the given width. If the width is negative, the width of the returned size will be -1.
      Parameters:
      width - The width of the size to create.
      Returns:
      A new Size instance with the given width.

    • withHeight

      public Size withHeight(double height)
      Creates an updated Size instance with the given height. If the height is negative, the height of the returned size will be -1.
      Parameters:
      height - The height of the size to create.
      Returns:
      A new Size instance with the given height.

    • plus

      public Size plus(double size)
      Creates an updated Size instance where the width and height are increased by the given amount. A dimension of -1 will remain -1.
      Parameters:
      size - The size to add to this size.
      Returns:
      A new Size instance with the added size.

    • plus

      public Size plus(double width, double height)
      Creates an updated Size instance where the width and height are increased by the given amount. A dimension of -1 will remain -1.
      Parameters:
      width - The width to add to this size.
      height - The height to add to this size.
      Returns:
      A new Size instance with the added size.

    • plus

      public Size plus(Size size)
      Creates an updated Size instance where the width and height are increased by the width and height of the given size. A dimension of -1 will remain -1.
      Parameters:
      size - The size to add to this size.
      Returns:
      A new Size instance with the added size.

    • minus

      public Size minus(double size)
      Creates an updated Size instance where the width and height are decreased by the given amount. A dimension of -1 will remain -1.
      Parameters:
      size - The size to subtract from this size.
      Returns:
      A new Size instance with the subtracted size.

    • minus

      public Size minus(double width, double height)
      Creates an updated Size instance where the width and height are decreased by the given amount. A dimension of -1 will remain -1.
      Parameters:
      width - The width to subtract from this size.
      height - The height to subtract from this size.
      Returns:
      A new Size instance with the subtracted size.

    • minus

      public Size minus(Size size)
      Creates an updated Size instance where the width and height are decreased by the width and height of the given size. A dimension of -1 will remain -1.
      Parameters:
      size - The size to subtract from this size.
      Returns:
      A new Size instance with the subtracted size.

    • toDimension

      public Dimension toDimension()

    • scale

      public Size scale(double scaleFactor)
      Scales the width and height of this Size instance by the given factor. If the width or height not specified (i.e. negative), they will remain negative. A negative scale factor will result in a negative width and height.
      Parameters:
      scaleFactor - The factor to scale the width and height by.
      Returns:
      A new Size instance with the scaled width and height.

    • round

      public Size round()
      Rounds the float based width and height of this Size to the nearest integer value and returns these as a new Size.
      Returns:
      A Size objects whose width and height values does not have fractions.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object