com.hfg.printer.zpl2.labelCmd.ZplGraphicBoxCmd Maven / Gradle / Ivy

Go to download
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.printer.zpl2.labelCmd;

import com.hfg.graphics.units.GfxContext;
import com.hfg.graphics.units.GfxSize;
import com.hfg.printer.zpl2.ZplColor;
import com.hfg.printer.zpl2.ZplDocument;

import java.io.IOException;
import java.io.Writer;

//------------------------------------------------------------------------------
/**
 ZPL graphic box label command.
 
 @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 ZplGraphicBoxCmd extends ZplLabelCmdImpl
{
   private static final String CMD = "^GB";

   private GfxSize mWidth;
   private GfxSize mHeight;
   private GfxSize mLineThickness;
   private ZplColor mColor;

   //--------------------------------------------------------------------------
   public ZplGraphicBoxCmd setWidth(GfxSize inValue)
   {
      mWidth = inValue;
      if (getDoc() != null)
      {
         mWidth.setGfxContext(new GfxContext(getDoc().getResolution()));
      }
      return this;
   }

   //--------------------------------------------------------------------------
   public GfxSize getWidth()
   {
      return mWidth;
   }


   //--------------------------------------------------------------------------
   public ZplGraphicBoxCmd setHeight(GfxSize inValue)
   {
      mHeight = inValue;
      if (getDoc() != null)
      {
         mHeight.setGfxContext(new GfxContext(getDoc().getResolution()));
      }
      return this;
   }

   //--------------------------------------------------------------------------
   public GfxSize getHeight()
   {
      return mHeight;
   }


   //--------------------------------------------------------------------------
   public ZplGraphicBoxCmd setLineThickness(GfxSize inValue)
   {
      mLineThickness = inValue;
      if (getDoc() != null)
      {
         mLineThickness.setGfxContext(new GfxContext(getDoc().getResolution()));
      }
      return this;
   }

   //--------------------------------------------------------------------------
   public GfxSize getLineThickness()
   {
      return mLineThickness;
   }


   //--------------------------------------------------------------------------
   public ZplGraphicBoxCmd setColor(ZplColor inValue)
   {
      mColor = inValue;
      return this;
   }

   //--------------------------------------------------------------------------
   public ZplColor getColor()
   {
      if(mColor == null)
      {
          mColor = ZplColor.BLACK;
      }
      return mColor;
   }




   //--------------------------------------------------------------------------
   @Override
   public ZplLabelCmdImpl setDoc(ZplDocument inValue)
   {
      super.setDoc(inValue);

      GfxContext gfxContext = new GfxContext(inValue.getResolution());

      if (mWidth != null)
      {
         mWidth.setGfxContext(gfxContext);
      }

      if (mHeight != null)
      {
         mHeight.setGfxContext(gfxContext);
      }

      if (mLineThickness != null)
      {
         mLineThickness.setGfxContext(gfxContext);
      }

      return this;
   }

   //--------------------------------------------------------------------------
   @Override
   public void toZPL(Writer inWriter)
         throws IOException
   {
      // ^GBw,h,t,c,r
      // w = box width
      // h = box height
      // t = border thickness
      // c = line color ('B' for black, or 'W' for white)
      // r = corner rounding (0 - 8)

      // Ex: ^GB37,0,3.5,B
      inWriter.write(CMD);

      inWriter.write(buildZplParamList(mWidth, mHeight, mLineThickness, getColor().getAbbrev()));
   }
}