Class WLength

java.lang.Object
eu.webtoolkit.jwt.WLength

public class WLength
extends java.lang.Object
A value class that describes a CSS length.

The class combines a value with a unit. There is a special value auto which has a different meaning depending on the context.

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  WLength.Unit
    The unit.
  • Field Summary

    Fields 
    Modifier and Type Field Description
    static WLength Auto
    An 'auto' length.
  • Constructor Summary

    Constructors 
    Constructor Description
    WLength()
    Creates an 'auto' length.
    WLength​(double value)
    Creates a length with value and unit.
    WLength​(double value, WLength.Unit unit)
    Creates a length with value and unit.
    WLength​(java.lang.String str)
    Creates a length by parsing the argument as a css length string.
  • Method Summary

    Modifier and Type Method Description
    boolean equals​(WLength other)
    Indicates whether some other object is "equal to" this one.
    java.lang.String getCssText()
    Returns the CSS text.
    WLength.Unit getUnit()
    Returns the unit.
    double getValue()
    Returns the value.
    boolean isAuto()
    Returns whether the length is 'auto'.
    double toPixels()
    Returns the (approximate) length in pixels.
    double toPixels​(double fontSize)
    Returns the (approximate) length in pixels.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

  • Constructor Details

    • WLength

      public WLength()
      Creates an 'auto' length.

      Specifies an 'auto' length.

      See Also:
      Auto
    • WLength

      public WLength​(java.lang.String str)
      Creates a length by parsing the argument as a css length string.

      This supports all CSS length formats that have an API counterpart.

    • WLength

      public WLength​(double value, WLength.Unit unit)
      Creates a length with value and unit.

      This constructor is also used for the implicit conversion of a double to a WLength, assuming a pixel unit.

    • WLength

      public WLength​(double value)
      Creates a length with value and unit.

      Calls this(value, WLength.Unit.Pixel)

  • Method Details

    • isAuto

      public boolean isAuto()
      Returns whether the length is 'auto'.

      See Also:
      WLength(), Auto
    • getValue

      public double getValue()
      Returns the value.

      See Also:
      getUnit()
    • getUnit

      public WLength.Unit getUnit()
      Returns the unit.

      See Also:
      getValue()
    • getCssText

      public java.lang.String getCssText()
      Returns the CSS text.
    • equals

      public boolean equals​(WLength other)
      Indicates whether some other object is "equal to" this one.
    • toPixels

      public double toPixels​(double fontSize)
      Returns the (approximate) length in pixels.

      When the length isAuto(), 0 is returned, otherwise the approximate length in pixels.

    • toPixels

      public final double toPixels()
      Returns the (approximate) length in pixels.

      Returns toPixels(16.0)