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


import com.hfg.xml.XMLNode;

//------------------------------------------------------------------------------
/**
 * Represents a frameset (<frameset>) 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 Frameset extends HTMLTag
{

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


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

   //--------------------------------------------------------------------------
   public Frameset()
   {
      super(HTML.FRAMESET);
   }

   //--------------------------------------------------------------------------
   public Frameset(XMLNode inXMLNode)
   {
      this();
      initFromXMLNode(inXMLNode);
   }

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

   //--------------------------------------------------------------------------
   public Frame addFrame()
   {
      Frame frame = new Frame();
      addSubtag(frame);

      return frame;
   }

   //--------------------------------------------------------------------------
   public Frame addFrame(String inName, String inSrc)
   {
      Frame frame = new Frame(inName, inSrc);
      addSubtag(frame);

      return frame;
   }


   //--------------------------------------------------------------------------
   public Frameset setId(String inValue)
   {
      setAttribute(HTML.ID, inValue);
      return this;
   }


   //--------------------------------------------------------------------------
   public Frameset setRows(String inValue)
   {
      setAttribute(HTML.ROWS, inValue);
      return this;
   }

   //--------------------------------------------------------------------------
   public String getRows()
   {
      return getAttributeValue(HTML.ROWS);
   }


   //--------------------------------------------------------------------------
   public Frameset setCols(String inValue)
   {
      setAttribute(HTML.COLS, inValue);
      return this;
   }

   //--------------------------------------------------------------------------
   public String getCols()
   {
      return getAttributeValue(HTML.COLS);
   }


   //--------------------------------------------------------------------------
   public Frameset setBorder(int inBorder)
   {
      setAttribute(HTML.BORDER, inBorder + "");

      return this;
   }

   //--------------------------------------------------------------------------
   public Integer getBorder()
   {
      Integer border = null;

      String value = getAttributeValue(HTML.BORDER);
      if (value != null)
      {
         border = new Integer(value);
      }

      return border;
   }

   //--------------------------------------------------------------------------
   public Frameset setFrameBorder(int inBorder)
   {
      setAttribute(HTML.FRAMEBORDER, inBorder + "");

      return this;
   }

   //--------------------------------------------------------------------------
   public Integer getFrameBorder()
   {
      Integer frameBorder = null;

      String value = getAttributeValue(HTML.FRAMEBORDER);
      if (value != null)
      {
         frameBorder = new Integer(value);
      }

      return frameBorder;
   }

   //--------------------------------------------------------------------------
   public Frameset setFrameSpacing(int inSpacing)
   {
      setAttribute(HTML.FRAMESPACING, inSpacing + "");

      return this;
   }

   //--------------------------------------------------------------------------
   public Integer getFrameSpacing()
   {
      Integer frameSpacing = null;

      String value = getAttributeValue(HTML.FRAMESPACING);
      if (value != null)
      {
         frameSpacing = new Integer(value);
      }

      return frameSpacing;
   }

}