org.w3c.dom.html.HTMLIFrameElement Maven / Gradle / Ivy

/*
 * Copyright (C) 2005 by Quentin Anciaux
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Library General Public License as published by
 * the Free Software Foundation; either version 2 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 Library General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this library; if not, write to the Free Software Foundation,
 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 *	@author Quentin Anciaux
 */

package org.w3c.dom.html;

import org.w3c.dom.Document;


/**
 * Inline subwindows. See the IFRAME element definition in HTML 4.01.
 * 
 * 
 * See also the Document
 * Object Model (DOM) Level 2 HTML Specification .
 * 
 */
public interface HTMLIFrameElement
    extends HTMLElement {
    /**
     * Aligns this object (vertically or horizontally) with respect to its
     * surrounding text. See the align attribute definition in HTML 4.01. This
     * attribute is deprecated in HTML 4.01.
     *
     * @return DOCUMENT ME!
     */
    public String getAlign();

    /**
     * Aligns this object (vertically or horizontally) with respect to its
     * surrounding text. See the align attribute definition in HTML 4.01. This
     * attribute is deprecated in HTML 4.01.
     *
     * @param align DOCUMENT ME!
     */
    public void setAlign(String align);

    /**
     * Request frame borders. See the frameborder attribute definition in HTML
     * 4.01.
     *
     * @return DOCUMENT ME!
     */
    public String getFrameBorder();

    /**
     * Request frame borders. See the frameborder attribute definition in HTML
     * 4.01.
     *
     * @param frameBorder DOCUMENT ME!
     */
    public void setFrameBorder(String frameBorder);

    /**
     * Frame height. See the height attribute definition in HTML 4.01.
     *
     * @return DOCUMENT ME!
     */
    public String getHeight();

    /**
     * Frame height. See the height attribute definition in HTML 4.01.
     *
     * @param height DOCUMENT ME!
     */
    public void setHeight(String height);

    /**
     * URI [ IETF RFC 2396 ]
     * designating a long description of this image or frame. See the longdesc
     * attribute definition in HTML 4.01.
     *
     * @return DOCUMENT ME!
     */
    public String getLongDesc();

    /**
     * URI [ IETF RFC 2396 ]
     * designating a long description of this image or frame. See the longdesc
     * attribute definition in HTML 4.01.
     *
     * @param longDesc DOCUMENT ME!
     */
    public void setLongDesc(String longDesc);

    /**
     * Frame margin height, in pixels. See the marginheight attribute
     * definition in HTML 4.01.
     *
     * @return DOCUMENT ME!
     */
    public String getMarginHeight();

    /**
     * Frame margin height, in pixels. See the marginheight attribute
     * definition in HTML 4.01.
     *
     * @param marginHeight DOCUMENT ME!
     */
    public void setMarginHeight(String marginHeight);

    /**
     * Frame margin width, in pixels. See the marginwidth attribute definition
     * in HTML 4.01.
     *
     * @return DOCUMENT ME!
     */
    public String getMarginWidth();

    /**
     * Frame margin width, in pixels. See the marginwidth attribute definition
     * in HTML 4.01.
     *
     * @param marginWidth DOCUMENT ME!
     */
    public void setMarginWidth(String marginWidth);

    /**
     * The frame name (object of the target attribute). See the
     * name attribute definition in HTML 4.01.
     *
     * @return DOCUMENT ME!
     */
    public String getName();

    /**
     * The frame name (object of the target attribute). See the
     * name attribute definition in HTML 4.01.
     *
     * @param name DOCUMENT ME!
     */
    public void setName(String name);

    /**
     * Specify whether or not the frame should have scrollbars. See the
     * scrolling attribute definition in HTML 4.01.
     *
     * @return DOCUMENT ME!
     */
    public String getScrolling();

    /**
     * Specify whether or not the frame should have scrollbars. See the
     * scrolling attribute definition in HTML 4.01.
     *
     * @param scrolling DOCUMENT ME!
     */
    public void setScrolling(String scrolling);

    /**
     * A URI [ IETF RFC 2396
     * ] designating the initial frame contents. See the src attribute
     * definition in HTML 4.01.
     *
     * @return DOCUMENT ME!
     */
    public String getSrc();

    /**
     * A URI [ IETF RFC 2396
     * ] designating the initial frame contents. See the src attribute
     * definition in HTML 4.01.
     *
     * @param src DOCUMENT ME!
     */
    public void setSrc(String src);

    /**
     * Frame width. See the width attribute definition in HTML 4.01.
     *
     * @return DOCUMENT ME!
     */
    public String getWidth();

    /**
     * Frame width. See the width attribute definition in HTML 4.01.
     *
     * @param width DOCUMENT ME!
     */
    public void setWidth(String width);

    /**
     * The document this frame contains, if there is any and it is available,
     * or null otherwise.
     *
     * @return DOCUMENT ME!
     *
     * @since DOM Level 2
     */
    public Document getContentDocument();
}