com.hfg.html.Frame 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 frame (<frame>) 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 Frame extends HTMLTag
{

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

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

    //--------------------------------------------------------------------------
    public Frame()
    {
    	super(HTML.FRAME);
    }
    
    //--------------------------------------------------------------------------
    public Frame(String inName, String inSrc)
    {
		this();
        setName(inName);
        setSrc(inSrc);
    }
    
    //##########################################################################
    // PUBLIC METHODS
    //##########################################################################

    //--------------------------------------------------------------------------
    public Frame setName(String inName)
    {
        setAttribute(HTML.NAME, inName);

        return this;
    }

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

    //--------------------------------------------------------------------------
    public Frame setSrc(String inSrc)
    {
        setAttribute(HTML.SRC, inSrc);

        return this;
    }

    //--------------------------------------------------------------------------
    public String getSrc()
    {
        return getAttributeValue(HTML.SRC);
    }

    //--------------------------------------------------------------------------
    public Frame 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 Frame setScrolling(boolean inValue)
    {
        setAttribute(HTML.SCROLLING, (inValue ? "yes" : "no"));

        return this;
    }

    //--------------------------------------------------------------------------
    public boolean getScrolling()
    {
        return (getAttributeValue(HTML.SCROLLING).equalsIgnoreCase("yes") ? true : false);
    }

    //--------------------------------------------------------------------------
    public Frame setResizable(boolean inValue)
    {
        setAttribute(HTML.RESIZABLE, (inValue ? "yes" : "no"));

        return this;
    }

    //--------------------------------------------------------------------------
    public boolean getResizable()
    {
        return (getAttributeValue(HTML.RESIZABLE).equalsIgnoreCase("yes") ? true : false);
    }


   // Overrides for HTMLTag setters to allow method chaining.

   //--------------------------------------------------------------------------
   @Override
   public Frame addClass(String inValue)
   {
      return (Frame) super.addClass(inValue);
   }

   //--------------------------------------------------------------------------
   @Override
   public Frame setClass(String inValue)
   {
      return (Frame) super.setClass(inValue);
   }

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

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

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

}