/**
 * <copyright> Copyright (c) 2006 by Know-Center, Graz, Austria </copyright>
 * 
 * This software is the confidential and proprietary information of Know-Center,
 * Graz, Austria. You shall not disclose such Confidential Information and shall
 * use it only in accordance with the terms of the license agreement you entered
 * into with Know-Center.
 * 
 * KNOW-CENTER MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF
 * THE SOFTWARE, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR
 * NON-INFRINGEMENT. KNOW-CENTER SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY
 * LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS
 * DERIVATIVES.
 * 
 * $Id:  $
 */
package at.knowcenter.wag.egov.egiz.pdf;

/**
 * The positioning instruction holds information of where to place the signature
 * block.
 * 
 * <p>
 * This instruction is given to the PDF writer in order to place the signature.
 * </p>
 * 
 * @author wprinz
 */
public class PositioningInstruction
{

  /**
   * Tells, if a new plain page should be appended.
   * 
   * <p>
   * This command is executed before the signature block is positioned according
   * to page, x and y.
   * </p>
   */
  protected boolean make_new_page = false;

  /**
   * The number of the page on which the signature block is to be placed. If
   * specified to make a new page, the number of this newly created page can be
   * used here as well.
   */
  protected int page = 0;

  /**
   * The x coordinate where the upper left corner of the signature block should
   * be placed.
   */
  protected float x = 0.0f;

  /**
   * The y coordinate where the upper left corner of the signature block should
   * be placed.
   */
  protected float y = 0.0f;

  /**
   * 
   * @param make_new_page
   *          Tells, if a new plain page should be appended. This command is
   *          executed before the signature block is positioned according to
   *          page, x and y.
   * @param page
   *          The number of the page on which the signature block is to be
   *          placed. If specified to make a new page, the number of this newly
   *          created page can be used here as well.
   * @param x
   *          The x coordinate where the upper left corner of the signature
   *          block should be placed.
   * @param y
   *          The y coordinate where the upper left corner of the signature
   *          block should be placed.
   */
  public PositioningInstruction(boolean make_new_page, int page, float x, float y)
  {
    this.make_new_page = make_new_page;
    this.page = page;
    this.x = x;
    this.y = y;
  }

  /**
   * Tells, if a new plain page should be appended to the document.
   * 
   * @return Returns true, if a new plain page should be appended.
   */
  public boolean isMakeNewPage()
  {
    return this.make_new_page;
  }

  /**
   * Returns the page on which the signature is to be printed.
   * 
   * @return Returns the page on which the signature is to be printed.
   */
  public int getPage()
  {
    return this.page;
  }

  /**
   * Returns the x coordinate where the upper left corner of the signature block
   * should be placed.
   * 
   * @return Returns the x coordinate where the upper left corner of the
   *         signature block should be placed.
   */
  public float getX()
  {
    return this.x;
  }

  /**
   * Returns the y coordinate where the upper left corner of the signature block
   * should be placed.
   * 
   * @return Returns the y coordinate where the upper left corner of the
   *         signature block should be placed.
   */
  public float getY()
  {
    return this.y;
  }

}