com.helger.pdflayout.base.IPLHasVerticalAlignment 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.base;

import javax.annotation.Nonnull;

import com.helger.pdflayout.spec.EVertAlignment;

/**
 * Base interface for objects with a vertical alignment
 *
 * @author Philip Helger
 * @param 
 *        Implementation type
 */
public interface IPLHasVerticalAlignment >
                                         extends IPLObject 
{
  EVertAlignment DEFAULT_VERT_ALIGNMENT = EVertAlignment.DEFAULT;

  /**
   * @return The vertical alignment of this element. By default it is
   *         {@link EVertAlignment#DEFAULT}. Never null.
   */
  @Nonnull
  EVertAlignment getVertAlign ();

  /**
   * Set the vertical alignment of this element.
   *
   * @param eVertAlign
   *        The new vertical alignment. May not be null.
   * @return this
   */
  @Nonnull
  IMPLTYPE setVertAlign (@Nonnull EVertAlignment eVertAlign);
}