com.helger.pdflayout.render.PreparationContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-pdf-layout Show documentation
Library for creating nicely layouted PDF documents based on PDFBox
The newest version!
/*
 * Copyright (C) 2014-2025 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.helger.pdflayout.render;

import javax.annotation.Nonnegative;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;

import com.helger.commons.string.ToStringGenerator;

/**
 * The current context for preparing an element. The preparation context depends
 * on the location of an element.
 *
 * @author Philip Helger
 */
@Immutable
public final class PreparationContext
{
  private final PreparationContextGlobal m_aGlobalCtx;
  private final float m_fAvailableWidth;
  private final float m_fAvailableHeight;

  /**
   * Constructor
   *
   * @param aGlobalCtx
   *        The global preparation context worked upon. May be
   *        null.
   * @param fAvailableWidth
   *        The available width of the surrounding element. Includes margin,
   *        border and padding of the contained element. Should be > 0.
   * @param fAvailableHeight
   *        The available height of the surrounding element. Includes margin,
   *        border and padding of the contained element. Should be > 0.
   */
  public PreparationContext (@Nullable final PreparationContextGlobal aGlobalCtx,
                             @Nonnegative final float fAvailableWidth,
                             @Nonnegative final float fAvailableHeight)
  {
    // ValueEnforcer.isGE0 (fAvailableWidth, "AvailableWidth");
    // ValueEnforcer.isGE0 (fAvailableHeight, "AvailableHeight");

    m_aGlobalCtx = aGlobalCtx;
    m_fAvailableWidth = fAvailableWidth;
    m_fAvailableHeight = fAvailableHeight;
  }

  @Nullable
  public PreparationContextGlobal getGlobalContext ()
  {
    return m_aGlobalCtx;
  }

  /**
   * @return The available width of the surrounding element. Should be > 0.
   */
  public float getAvailableWidth ()
  {
    return m_fAvailableWidth;
  }

  /**
   * @return The available height of the surrounding element. Should be > 0.
   */
  public float getAvailableHeight ()
  {
    return m_fAvailableHeight;
  }

  @Override
  public String toString ()
  {
    return new ToStringGenerator (this).append ("GlobalCtx", m_aGlobalCtx)
                                       .append ("AvailableWidth", m_fAvailableWidth)
                                       .append ("AvailableHeight", m_fAvailableHeight)
                                       .getToString ();
  }
}