Class BackgroundSize

java.lang.Object
com.itextpdf.layout.properties.BackgroundSize
public class BackgroundSize extends Object
Class to hold background-size property.

  • Field Details

    • backgroundWidthSize

      private UnitValue backgroundWidthSize
      Width size for this image. If UnitValue is in percent, then width depends on the area of the element.

    • backgroundHeightSize

      private UnitValue backgroundHeightSize
      Height size for this image. If UnitValue is in percent, then height depends on the area of the element.

    • cover

      private boolean cover
      Image covers the entire area and its size may be more than the area.

    • contain

      private boolean contain
      Image hsd a maximum size but not larger than the area.

  • Constructor Details

    • BackgroundSize

      public BackgroundSize()
      Creates a new BackgroundSize instance. The "cover" and "contain" properties are not set.

  • Method Details

    • setBackgroundSizeToValues

      public void setBackgroundSizeToValues(UnitValue width, UnitValue height)
      Clears all current properties and sets new width and height values. One of the parameters can be null. Note that in this case null property will be scaled so that it becomes proportionally equal with the non-null value. If both parameters are set to null, then the default image size will be used.
      Parameters:
      width - a UnitValue object
      height - a UnitValue object

    • setBackgroundSizeToContain

      public void setBackgroundSizeToContain()
      Clears all size values and sets the "contain" property true.
      See Also:

    • setBackgroundSizeToCover

      public void setBackgroundSizeToCover()
      Clears all size values and sets the "cover" property true.
      See Also:

    • getBackgroundWidthSize

      public UnitValue getBackgroundWidthSize()
      Gets the background width property of the image.
      Returns:
      the UnitValue width for this image.
      See Also:

    • getBackgroundHeightSize

      public UnitValue getBackgroundHeightSize()
      Gets the background height property of the image.
      Returns:
      the UnitValue height for this image.
      See Also:

    • isSpecificSize

      public boolean isSpecificSize()
      Returns is size has specific property.
      Returns:
      true if size set to "contain" or "cover", otherwise false.

    • isContain

      public boolean isContain()
      Returns value of the "contain" property.
      Returns:
      true if property "contain" is set to the size, otherwise false.
      See Also:

    • isCover

      public boolean isCover()
      Returns value of the "cover" property.
      Returns:
      true if property "cover" is set to the size, otherwise false.
      See Also:

    • clear

      private void clear()