com.hfg.printer.zpl2.labelCmd.ZplFieldBlockCmd 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 java.io.IOException;
import java.io.Writer;

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

//------------------------------------------------------------------------------
/**
 ZPL field block 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 ZplFieldBlockCmd extends ZplLabelCmdImpl
{
   private static final String CMD = "^FB";

   private GfxSize mWidth;
   private int mRows;
   private GfxSize mSpaceBetweenLines;
   private ZplTextJustification mJustificaiton;
   private GfxSize mHangingIntent;

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

   //--------------------------------------------------------------------------
   public ZplFieldBlockCmd(GfxSize inWidth, int inRows)
   {
      mWidth = inWidth;
      mRows = inRows;
   }

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

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

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

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

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

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

      return this;
   }


   //--------------------------------------------------------------------------
   public ZplFieldBlockCmd setSpaceBetweenLines(GfxSize inValue)
   {
      mSpaceBetweenLines = inValue;
      return this;
   }

   //--------------------------------------------------------------------------
   public ZplFieldBlockCmd setJustification(ZplTextJustification inValue)
   {
      mJustificaiton = inValue;
      return this;
   }

   //--------------------------------------------------------------------------
   public ZplFieldBlockCmd setHangingIndent(GfxSize inValue)
   {
      mHangingIntent = inValue;
      return this;
   }

   //--------------------------------------------------------------------------
   @Override
   public void toZPL(Writer inWriter)
         throws IOException
   {
      // ^FBa,b,c,d,e
      // a = width
      // b = rows
      // c = space between lines
      // d = text justification
      // e = hanging indent
      inWriter.write(CMD);

      inWriter.write(buildZplParamList(mWidth, mRows, mSpaceBetweenLines, mJustificaiton, mHangingIntent));

   }
}