com.hfg.html.InputCheckbox 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.html;


//------------------------------------------------------------------------------
/**
 * Represents a checkbox form element (<input type='checkbox'>) tag.
 *
 * @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 InputCheckbox extends HTMLTagWithFormEvents
{

   //##########################################################################
   // PRIVATE FIELDS
   //##########################################################################

   private static String sTagName   = HTML.INPUT;

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

   //--------------------------------------------------------------------------
   public InputCheckbox()
   {
      super(sTagName);
      setAttribute(HTML.TYPE, "checkbox");
   }

   //--------------------------------------------------------------------------
   public InputCheckbox(String inName, String inValue)
   {
      this();
      setName(inName);
      setValue(inValue);
   }

   //--------------------------------------------------------------------------
   public InputCheckbox(String inName, String inValue, boolean checked)
   {
      this(inName, inValue);
      setChecked(checked);
   }

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

   //--------------------------------------------------------------------------
   public InputCheckbox setChecked(boolean checked)
   {
      if (checked) {
         setAttribute(HTML.CHECKED, "true");
      }
      else {
         removeAttribute(HTML.CHECKED);
      }

      return this;
   }

   //--------------------------------------------------------------------------
   public InputCheckbox setDisabled(boolean disabled)
   {
      if (disabled) {
         setAttribute(HTML.DISABLED, HTML.DISABLED);
      }
      else {
         removeAttribute(HTML.DISABLED);
      }

      return this;
   }

   //--------------------------------------------------------------------------
   public boolean isDisabled()
   {
      return hasAttribute(HTML.DISABLED);
   }

   //--------------------------------------------------------------------------
   public InputCheckbox setName(String inValue)
   {
      setAttribute(HTML.NAME, inValue);

      return this;
   }

   //--------------------------------------------------------------------------
   public String getName()
   {
      return getAttributeValue(HTML.NAME);
   }

   //--------------------------------------------------------------------------
   public InputCheckbox setValue(String inValue)
   {
      setAttribute(HTML.VALUE, inValue);

      return this;
   }

   //--------------------------------------------------------------------------
   public String getValue()
   {
      return getAttributeValue(HTML.VALUE);
   }


   // Overrides for HTMLTag setters to allow method chaining.

   //--------------------------------------------------------------------------
   @Override
   public InputCheckbox setId(String inValue)
   {
      return (InputCheckbox) super.setId(inValue);
   }

   //--------------------------------------------------------------------------
   @Override
   public InputCheckbox setStyle(CharSequence inValue)
   {
      return (InputCheckbox) super.setStyle(inValue);
   }

   //--------------------------------------------------------------------------
   @Override
   public InputCheckbox addStyle(String inValue)
   {
      return (InputCheckbox) super.addStyle(inValue);
   }

   // Overrides for HTMLTagWithCoreEvents setters to allow method chaining.

   //--------------------------------------------------------------------------
   @Override
   public InputCheckbox setOnClick(String inValue)
   {
      return (InputCheckbox) super.setOnClick(inValue);
   }

   //---------------------------------------------------------------------------
   @Override
   public InputCheckbox appendToOnClick(String inValue)
   {
      return (InputCheckbox) super.appendToOnClick(inValue);
   }

   //--------------------------------------------------------------------------
   @Override
   public InputCheckbox setOnDblClick(String inValue)
   {
      return (InputCheckbox) super.setOnDblClick(inValue);
   }

   //---------------------------------------------------------------------------
   @Override
   public InputCheckbox appendToOnDblClick(String inValue)
   {
      return (InputCheckbox) super.appendToOnDblClick(inValue);
   }

   //--------------------------------------------------------------------------
   @Override
   public InputCheckbox setOnMouseDown(String inValue)
   {
      return (InputCheckbox) super.setOnMouseDown(inValue);
   }

   //--------------------------------------------------------------------------
   @Override
   public InputCheckbox setOnMouseMove(String inValue)
   {
      return (InputCheckbox) super.setOnMouseMove(inValue);
   }

   //--------------------------------------------------------------------------
   @Override
   public InputCheckbox setOnMouseOut(String inValue)
   {
      return (InputCheckbox) super.setOnMouseOut(inValue);
   }

   //--------------------------------------------------------------------------
   @Override
   public InputCheckbox setOnMouseOver(String inValue)
   {
      return (InputCheckbox) super.setOnMouseOver(inValue);
   }

   //--------------------------------------------------------------------------
   @Override
   public InputCheckbox setOnMouseUp(String inValue)
   {
      return (InputCheckbox) super.setOnMouseUp(inValue);
   }

   //--------------------------------------------------------------------------
   @Override
   public InputCheckbox setOnKeyDown(String inValue)
   {
      return (InputCheckbox) super.setOnKeyDown(inValue);
   }

   //--------------------------------------------------------------------------
   @Override
   public InputCheckbox setOnKeyPress(String inValue)
   {
      return (InputCheckbox) super.setOnKeyPress(inValue);
   }

   //--------------------------------------------------------------------------
   @Override
   public InputCheckbox setOnKeyUp(String inValue)
   {
      return (InputCheckbox) super.setOnKeyUp(inValue);
   }

   // Overrides for HTMLTagWithFormEvents setters to allow method chaining.

   //--------------------------------------------------------------------------
   @Override
   public InputCheckbox setOnBlur(String inValue)
   {
      return (InputCheckbox) super.setOnBlur(inValue);
   }

   //--------------------------------------------------------------------------
   @Override
   public InputCheckbox setOnChange(String inValue)
   {
      return (InputCheckbox) super.setOnChange(inValue);
   }

   //--------------------------------------------------------------------------
   @Override
   public InputCheckbox setOnFocus(String inValue)
   {
      return (InputCheckbox) super.setOnFocus(inValue);
   }

}