com.hfg.math.HistogramSvgSettings 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.math;

import java.awt.Font;

import com.hfg.graphics.units.GfxSize;
import com.hfg.setting.StringSetting;
import com.hfg.svg.SvgGenerationSettings;

//------------------------------------------------------------------------------
/**
 * Settings for use with generating histogram SVGs.
 *
 * @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 HistogramSvgSettings extends SvgGenerationSettings
{
   private static final String BAR_STYLE_CLASS = "barStyleClass";
   private static final String RANGE_LABEL_FORMAT_STRING = "rangeLabelFormatString";

   private final String sDefaultRangeLabelFormatString = "%.1f";

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

   //---------------------------------------------------------------------------
   public HistogramSvgSettings()
   {
      super();
   }

   //---------------------------------------------------------------------------
   @Override
   protected void init()
   {
      super.init();

      add(new StringSetting(BAR_STYLE_CLASS));
      add(new StringSetting(RANGE_LABEL_FORMAT_STRING));

      setRangeLabelFormatString(sDefaultRangeLabelFormatString);
   }

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

   //---------------------------------------------------------------------------
   public HistogramSvgSettings setBarStyleClass(String inValue)
   {
      get(BAR_STYLE_CLASS).setValue(inValue);
      return this;
   }

   //---------------------------------------------------------------------------
   public String getBarStyleClass()
   {
      return (String) get(BAR_STYLE_CLASS).getValue();
   }


   //---------------------------------------------------------------------------
   public HistogramSvgSettings setRangeLabelFormatString(String inValue)
   {
      get(RANGE_LABEL_FORMAT_STRING).setValue(inValue != null ? inValue.toString() : null);
      return this;
   }

   //---------------------------------------------------------------------------
   public String getRangeLabelFormatString()
   {
      return (String) get(RANGE_LABEL_FORMAT_STRING).getValue();
   }

   //---------------------------------------------------------------------------
   @Override
   public HistogramSvgSettings setHeight(GfxSize inValue)
   {
      return (HistogramSvgSettings) super.setHeight(inValue);
   }

   //---------------------------------------------------------------------------
   @Override
   public HistogramSvgSettings setWidth(GfxSize inValue)
   {
      return (HistogramSvgSettings) super.setWidth(inValue);
   }


   //---------------------------------------------------------------------------
   @Override
   public HistogramSvgSettings setFont(Font inValue)
   {
      return (HistogramSvgSettings) super.setFont(inValue);
   }


   //---------------------------------------------------------------------------
   @Override
   public HistogramSvgSettings setPadding(GfxSize inValue)
   {
      return (HistogramSvgSettings) super.setPadding(inValue);
   }

}