com.helger.pdflayout.element.text.PLTextSplittable 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
There is a newer version: 7.3.5
/**
 * Copyright (C) 2014-2016 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.element.text;

import java.util.List;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.helger.commons.collection.CollectionHelper;
import com.helger.pdflayout.PLDebug;
import com.helger.pdflayout.base.IPLSplittableObject;
import com.helger.pdflayout.base.PLElementWithSize;
import com.helger.pdflayout.base.PLSplitResult;
import com.helger.pdflayout.spec.EVertAlignment;
import com.helger.pdflayout.spec.FontSpec;
import com.helger.pdflayout.spec.TextAndWidthSpec;

/**
 * Render text
 *
 * @author Philip Helger
 */
public class PLTextSplittable extends AbstractPLText 
                              implements IPLSplittableObject 
{
  public PLTextSplittable (@Nullable final String sText, @Nonnull final FontSpec aFontSpec)
  {
    super (sText, aFontSpec);
  }

  @Nullable
  public PLSplitResult splitElements (final float fElementWidth, final float fAvailableHeight)
  {
    if (fAvailableHeight <= 0)
      return null;

    final float fLineHeight = m_fLineHeight;

    // Get the lines in the correct order from top to bottom
    final List  aLines = isTopDown () ? m_aPreparedLines
                                                        : CollectionHelper.getReverseList (m_aPreparedLines);

    int nLines = (int) (fAvailableHeight / fLineHeight);
    if (nLines <= 0)
    {
      // Splitting makes no sense because the resulting text 1 would be empty
      if (PLDebug.isDebugSplit ())
        PLDebug.debugSplit (this,
                            "Failed to split because the result would be " +
                                  nLines +
                                  " lines for available height " +
                                  fAvailableHeight +
                                  " and line height " +
                                  fLineHeight);
      return null;
    }

    if (nLines >= aLines.size ())
    {
      // Splitting makes no sense because the resulting text 2 would be empty
      if (PLDebug.isDebugSplit ())
        PLDebug.debugSplit (this,
                            "Failed to split because the result of " +
                                  nLines +
                                  " lines fits into the available height " +
                                  fAvailableHeight +
                                  " and line height " +
                                  fLineHeight +
                                  " (=" +
                                  (fAvailableHeight * fLineHeight) +
                                  ")");
      return null;
    }

    // Calc estimated height (required because an offset is added)
    final float fExpectedHeight = getDisplayHeightOfLines (nLines);
    if (fExpectedHeight > fAvailableHeight)
    {
      // Show one line less
      --nLines;
      if (nLines <= 0)
      {
        // Splitting makes no sense
        if (PLDebug.isDebugSplit ())
          PLDebug.debugSplit (this,
                              "Failed to split because the result would be " +
                                    nLines +
                                    " lines for available height " +
                                    fAvailableHeight +
                                    " and expected height " +
                                    fExpectedHeight);
        return null;
      }
    }

    // First elements does not need to be splittable anymore
    final PLElementWithSize aText1 = getCopy (fElementWidth, aLines.subList (0, nLines), false);
    // Second element may need additional splitting
    final PLElementWithSize aText2 = getCopy (fElementWidth, aLines.subList (nLines, aLines.size ()), true);

    // Important: vertical alignment is in case of splitting always "TOP"
    ((AbstractPLText ) aText1.getElement ()).setVertAlign (EVertAlignment.TOP);
    ((AbstractPLText ) aText2.getElement ()).setVertAlign (EVertAlignment.TOP);

    return new PLSplitResult (aText1, aText2);
  }
}