Package com.helger.pdflayout.base

Interface IPLHasPadding<IMPLTYPE extends IPLHasPadding<IMPLTYPE>>

Type Parameters:
IMPLTYPE - Implementation type
All Superinterfaces:
com.helger.commons.traits.IGenericImplTrait<IMPLTYPE>, IPLHasOutline
All Known Subinterfaces:
IPLBlockElement<IMPLTYPE>, IPLElement<IMPLTYPE>, IPLHasMarginBorderPadding<IMPLTYPE>, IPLInlineElement<IMPLTYPE>
All Known Implementing Classes:
AbstractBulletPointCreatorFontBased, AbstractPLBlockElement, AbstractPLBox, AbstractPLElement, AbstractPLExternalLink, AbstractPLImage, AbstractPLInlineBox, AbstractPLInlineElement, AbstractPLText, BulletPointCreatorConstant, BulletPointCreatorNumeric, BulletPointCreatorSymbol, PLBox, PLExternalLink, PLImage, PLMarginBorderPadding, PLPageSet, PLStreamImage, PLTableCell, PLText
public interface IPLHasPadding<IMPLTYPE extends IPLHasPadding<IMPLTYPE>> extends IPLHasOutline, com.helger.commons.traits.IGenericImplTrait<IMPLTYPE>
Base interface for objects having a padding
Author:
Philip Helger

  • Field Details

    • DEFAULT_PADDING

      static final PaddingSpec DEFAULT_PADDING
      The default padding is a 0 padding, meaning no padding at all.

  • Method Details

    • setPadding

      @Nonnull default IMPLTYPE setPadding(float fPadding)
      Set all padding values (left, top, right, bottom) to the same value.
      Parameters:
      fPadding - The value to use.
      Returns:
      this

    • setPadding

      @Nonnull default IMPLTYPE setPadding(float fPaddingY, float fPaddingX)
      Set all padding values.
      Parameters:
      fPaddingY - The Y-value to use (for top and bottom).
      fPaddingX - The X-value to use (for left and right).
      Returns:
      this

    • setPadding

      @Nonnull default IMPLTYPE setPadding(float fPaddingTop, float fPaddingRight, float fPaddingBottom, float fPaddingLeft)
      Set all padding values to potentially different values.
      Parameters:
      fPaddingTop - Top
      fPaddingRight - Right
      fPaddingBottom - Bottom
      fPaddingLeft - Left
      Returns:
      this

    • setPadding

      @Nonnull IMPLTYPE setPadding(@Nonnull PaddingSpec aPadding)
      Set the padding values.
      Parameters:
      aPadding - Padding to use. May not be null.
      Returns:
      this

    • setPaddingTop

      @Nonnull default IMPLTYPE setPaddingTop(float fPadding)
      Set the top padding value.
      Parameters:
      fPadding - The value to use.
      Returns:
      this

    • setPaddingRight

      @Nonnull default IMPLTYPE setPaddingRight(float fPadding)
      Set the right padding value.
      Parameters:
      fPadding - The value to use.
      Returns:
      this

    • setPaddingBottom

      @Nonnull default IMPLTYPE setPaddingBottom(float fPadding)
      Set the bottom padding value.
      Parameters:
      fPadding - The value to use.
      Returns:
      this

    • setPaddingLeft

      @Nonnull default IMPLTYPE setPaddingLeft(float fPadding)
      Set the left padding value.
      Parameters:
      fPadding - The value to use.
      Returns:
      this

    • setPaddingX

      @Nonnull default IMPLTYPE setPaddingX(float fPadding)
      Set the left padding left AND right value.
      Parameters:
      fPadding - The value to use.
      Returns:
      this
      Since:
      5.2.2

    • setPaddingY

      @Nonnull default IMPLTYPE setPaddingY(float fPadding)
      Set the left padding top AND bottom value.
      Parameters:
      fPadding - The value to use.
      Returns:
      this
      Since:
      5.2.2

    • addPaddingTop

      @Nonnull default IMPLTYPE addPaddingTop(float fPadding)
      Add to the top padding value.
      Parameters:
      fPadding - The value to add.
      Returns:
      this

    • addPaddingRight

      @Nonnull default IMPLTYPE addPaddingRight(float fPadding)
      Add to the right padding value.
      Parameters:
      fPadding - The value to add.
      Returns:
      this

    • addPaddingBottom

      @Nonnull default IMPLTYPE addPaddingBottom(float fPadding)
      Add to the bottom padding value.
      Parameters:
      fPadding - The value to add.
      Returns:
      this

    • addPaddingLeft

      @Nonnull default IMPLTYPE addPaddingLeft(float fPadding)
      Add to the left padding value.
      Parameters:
      fPadding - The value to add.
      Returns:
      this

    • addPaddingX

      @Nonnull default IMPLTYPE addPaddingX(float fPadding)
      Add to the left padding left AND right value.
      Parameters:
      fPadding - The value to add.
      Returns:
      this
      Since:
      5.2.2

    • addPaddingY

      @Nonnull default IMPLTYPE addPaddingY(float fPadding)
      Add to the left padding top AND bottom value.
      Parameters:
      fPadding - The value to add.
      Returns:
      this
      Since:
      5.2.2

    • getPadding

      @Nonnull PaddingSpec getPadding()
      Returns:
      The current padding. Never null.

    • getPaddingTop

      default float getPaddingTop()
      Returns:
      The current top padding.

    • getPaddingRight

      default float getPaddingRight()
      Returns:
      The current right padding.

    • getPaddingBottom

      default float getPaddingBottom()
      Returns:
      The current bottom padding.

    • getPaddingLeft

      default float getPaddingLeft()
      Returns:
      The current left padding.

    • getPaddingXSum

      default float getPaddingXSum()
      Returns:
      The sum of left and right padding.

    • getPaddingYSum

      default float getPaddingYSum()
      Returns:
      The sum of top and bottom padding.

    • getOutlineTop

      default float getOutlineTop()
      Specified by:
      getOutlineTop in interface IPLHasOutline
      Returns:
      margin top + border top + padding top.

    • getOutlineRight

      default float getOutlineRight()
      Specified by:
      getOutlineRight in interface IPLHasOutline
      Returns:
      margin right + border right + padding right.

    • getOutlineBottom

      default float getOutlineBottom()
      Specified by:
      getOutlineBottom in interface IPLHasOutline
      Returns:
      margin bottom + border bottom + padding bottom.

    • getOutlineLeft

      default float getOutlineLeft()
      Specified by:
      getOutlineLeft in interface IPLHasOutline
      Returns:
      margin left + border left + padding left.

    • getOutlineXSum

      default float getOutlineXSum()
      Description copied from interface: IPLHasOutline
      Sum of left and right outline
      Specified by:
      getOutlineXSum in interface IPLHasOutline
      Returns:
      IPLHasOutline.getOutlineLeft() + IPLHasOutline.getOutlineRight()

    • getOutlineYSum

      default float getOutlineYSum()
      Description copied from interface: IPLHasOutline
      Sum of top and bottom outline
      Specified by:
      getOutlineYSum in interface IPLHasOutline
      Returns:
      IPLHasOutline.getOutlineTop() + IPLHasOutline.getOutlineBottom()