com.hfg.graphics.PageMargins Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of com_hfg Show documentation
com.hfg xml, html, svg, and bioinformatics utility library
There is a newer version: 20240423
package com.hfg.graphics;


import com.hfg.exception.ProgrammingException;
import com.hfg.graphics.units.GfxSize;
import com.hfg.graphics.units.Inches;

//------------------------------------------------------------------------------
/**
 * Container for page margins.
 *
 * @author J. Alex Taylor, hairyfatguy.com
 */
//------------------------------------------------------------------------------
// com.hfg XML/HTML Coding Library
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
// J. Alex Taylor, President, Founder, CEO, COO, CFO, OOPS hairyfatguy.com
// [email protected]
//------------------------------------------------------------------------------

public class PageMargins implements Cloneable
{
   private GfxSize mTop;
   private GfxSize mRight;
   private GfxSize mBottom;
   private GfxSize mLeft;

   private static GfxSize sDefaultMargin = new Inches(1);

   //##########################################################################
   // CONSTRUCTORS
   //##########################################################################

   //---------------------------------------------------------------------------
   public PageMargins()
   {
      init();
   }

   //---------------------------------------------------------------------------
   private void init()
   {
      mTop    = sDefaultMargin;
      mRight  = sDefaultMargin;
      mBottom = sDefaultMargin;
      mLeft   = sDefaultMargin;
   }

   //##########################################################################
   // PUBLIC METHODS
   //##########################################################################

   //---------------------------------------------------------------------------
   @Override
   public PageMargins clone()
   {
      PageMargins cloneObj;
      try
      {
         cloneObj = (PageMargins) super.clone();
      }
      catch (CloneNotSupportedException e)
      {
         throw new ProgrammingException(e);
      }

      return cloneObj;
   }

   //---------------------------------------------------------------------------
   public PageMargins setTop(GfxSize inValue)
   {
      mTop = inValue;
      return this;
   }

   //---------------------------------------------------------------------------
   public GfxSize getTop()
   {
      return mTop;
   }


   //---------------------------------------------------------------------------
   public PageMargins setRight(GfxSize inValue)
   {
      mRight = inValue;
      return this;
   }

   //---------------------------------------------------------------------------
   public GfxSize getRight()
   {
      return mRight;
   }


   //---------------------------------------------------------------------------
   public PageMargins setBottom(GfxSize inValue)
   {
      mBottom = inValue;
      return this;
   }

   //---------------------------------------------------------------------------
   public GfxSize getBottom()
   {
      return mBottom;
   }


   //---------------------------------------------------------------------------
   public PageMargins setLeft(GfxSize inValue)
   {
      mLeft = inValue;
      return this;
   }

   //---------------------------------------------------------------------------
   public GfxSize getLeft()
   {
      return mLeft;
   }

}