All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.ecs.html.ObjectElement Maven / Gradle / Ivy

/*
 * ====================================================================
 * 
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 1999-2003 The Apache Software Foundation.  All rights 
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer. 
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowlegement:  
 *       "This product includes software developed by the 
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "The Jakarta Project", "Jakarta Element Construction Set", 
 *    "Jakarta ECS" , and "Apache Software Foundation" must not be used 
 *    to endorse or promote products derived
 *    from this software without prior written permission. For written 
 *    permission, please contact [email protected].
 *
 * 5. Products derived from this software may not be called "Apache",
 *    "Jakarta Element Construction Set" nor "Jakarta ECS" nor may "Apache" 
 *    appear in their names without prior written permission of the Apache Group.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * .
 *
 */
package org.apache.ecs.html;

import org.apache.ecs.*;

/**
    This class creates an ObjectElement

    @version $Id: ObjectElement.java,v 1.4 2003/04/27 09:22:12 rdonkin Exp $
    @author Stephan Nagy
    @author Jon S. Stevens
*/
public class ObjectElement extends MultiPartElement implements Printable, MouseEvents, KeyEvents
{
    /**
        Private initializer.
    */
    {
        setElementType("object");
    }

    /**
        Default constructor.  Creates the <object/> Element.
use set* methods. */ public ObjectElement() { } /** Sets the declare attribute. (declare this object but don't instantiate it. @param declare declare on or off */ public ObjectElement setDeclare(boolean declare) { if(declare) addAttribute("declare",NO_ATTRIBUTE_VALUE); else removeAttribute("declare"); return(this); } /** Identifies an implementation. @param url location of classid. */ public ObjectElement setClassId(String url) { addAttribute("classid",url); return(this); } /** Sets the Internet content type for the code. @param codetype Sets the Internet content type for the code. */ public ObjectElement setCodeType(String codetype) { addAttribute("codetype",codetype); return(this); } /** Determines the base path to resolve relative urls specified by classid. @param url base path to resolve relative urls specified by classid. */ public ObjectElement setCodeBase(String url) { addAttribute("codebase",url); return(this); } /** This attribute specifies the location of the data to be rendered. @param url this attribute specifies the location of the data to be rendered. */ public ObjectElement setData(String url) { addAttribute("data",url); return(this); } /** This attribute specifies the Internet Media Type for the data specified by data.
This should be a mime type. @param type a mime type for the data specifed by the data attribute. */ public ObjectElement setType(String type) { addAttribute("type",type); return(this); } /** Space seperated archive list. @param url Space seperate archive list. */ // Anyone know what the hell this is? the spec is rather vague in its definition. public ObjectElement setArchive(String url) { addAttribute("archive",url); return(this); } /** Message to show while the object is loading. @param cdata the message to show while the object is loading. */ public ObjectElement setStandBy(String cdata) { addAttribute("standby",cdata); return(this); } /** Suggested link border width. @param border suggested link border width. */ public ObjectElement setBorder(String border) { addAttribute("border",border); return(this); } /** Suggested link border width. @param border suggested link border width. */ public ObjectElement setBorder(int border) { addAttribute("border",Integer.toString(border)); return(this); } /** Suggested link border width. @param border suggested link border width. */ public ObjectElement setBorder(double border) { addAttribute("border",Double.toString(border)); return(this); } /** Suggested height of object. @param height suggested link height. */ public ObjectElement setHeight(String height) { addAttribute("height",height); return(this); } /** Suggested height of object. @param height suggested link height. */ public ObjectElement setHeight(int height) { addAttribute("height",Integer.toString(height)); return(this); } /** Suggested height of object. @param height suggested link height. */ public ObjectElement setHeight(double height) { addAttribute("height",Double.toString(height)); return(this); } /** Suggested width of object. @param height suggested link width. */ public ObjectElement setWidth(String width) { addAttribute("width",width); return(this); } /** Suggested width of object. @param height suggested link width. */ public ObjectElement setWidth(int width) { addAttribute("width",Integer.toString(width)); return(this); } /** Suggested width of object. @param height suggested link width. */ public ObjectElement setWidth(double width) { addAttribute("width",Double.toString(width)); return(this); } /** Suggested horizontal gutter. @param hspace suggested horizontal gutter. */ public ObjectElement setHSpace(String hspace) { addAttribute("hspace",hspace); return(this); } /** Suggested horizontal gutter. @param hspace suggested horizontal gutter. */ public ObjectElement setHSpace(int hspace) { addAttribute("hspace",Integer.toString(hspace)); return(this); } /** Suggested horizontal gutter. @param hspace suggested horizontal gutter. */ public ObjectElement setHSpace(double hspace) { addAttribute("hspace",Double.toString(hspace)); return(this); } /** Suggested vertical gutter. @param hspace suggested vertical gutter. */ public ObjectElement setVSpace(String vspace) { addAttribute("vspace",vspace); return(this); } /** Suggested vertical gutter. @param hspace suggested vertical gutter. */ public ObjectElement setVSpace(int vspace) { addAttribute("vspace",Integer.toString(vspace)); return(this); } /** Suggested vertical gutter. @param hspace suggested vertical gutter. */ public ObjectElement setVSpace(double vspace) { addAttribute("vspace",Double.toString(vspace)); return(this); } /** Set the horizontal or vertical alignment of this object.
Convience variables are in the AlignTypes interface. @param alignment Set the horizontal or vertical alignment of this object.
Convience variables are in the AlignTypes interface. */ public ObjectElement setAlign(String alignment) { addAttribute("align",alignment); return(this); } /** Location of image map to use. @param url location of image map to use. */ public ObjectElement setUseMap(String url) { addAttribute("usemap",url); return(this); } /** Object has shaped hypertext links. @param shape does the object have shaped hypertext links? */ public ObjectElement setShapes(boolean shape) { if(shape) addAttribute("shapes",NO_ATTRIBUTE_VALUE); else removeAttribute("shapes"); return(this); } /** Set the name of this object. @param name set the name of this object. */ public ObjectElement setName(String name) { addAttribute("name",name); return(this); } /** Set the elements position in the tabbing order. @param number set the elements position in the tabbing order. */ public ObjectElement setTabIndex(int number) { addAttribute("tabindex",Integer.toString(number)); return(this); } /** Set the elements position in the tabbing order. @param number set the elements position in the tabbing order. */ public ObjectElement setTabIndex(String number) { addAttribute("tabindex",number); return(this); } /** Adds an Element to the element. @param hashcode name of element for hash table @param element Adds an Element to the element. */ public ObjectElement addElement(String hashcode,Element element) { addElementToRegistry(hashcode,element); return(this); } /** Adds an Element to the element. @param hashcode name of element for hash table @param element Adds an Element to the element. */ public ObjectElement addElement(String hashcode,String element) { addElementToRegistry(hashcode,element); return(this); } /** Add an element to the element @param element a string representation of the element */ public ObjectElement addElement(String element) { addElementToRegistry(element); return(this); } /** Add an element to the element @param element an element to add */ public ObjectElement addElement(Element element) { addElementToRegistry(element); return(this); } /** Removes an Element from the element. @param hashcode the name of the element to be removed. */ public ObjectElement removeElement(String hashcode) { removeElementFromRegistry(hashcode); return(this); } /** The onclick event occurs when the pointing device button is clicked over an element. This attribute may be used with most elements. @param The script */ public void setOnClick(String script) { addAttribute ( "onClick", script ); } /** The ondblclick event occurs when the pointing device button is double clicked over an element. This attribute may be used with most elements. @param The script */ public void setOnDblClick(String script) { addAttribute ( "onDblClick", script ); } /** The onmousedown event occurs when the pointing device button is pressed over an element. This attribute may be used with most elements. @param The script */ public void setOnMouseDown(String script) { addAttribute ( "onMouseDown", script ); } /** The onmouseup event occurs when the pointing device button is released over an element. This attribute may be used with most elements. @param The script */ public void setOnMouseUp(String script) { addAttribute ( "onMouseUp", script ); } /** The onmouseover event occurs when the pointing device is moved onto an element. This attribute may be used with most elements. @param The script */ public void setOnMouseOver(String script) { addAttribute ( "onMouseOver", script ); } /** The onmousemove event occurs when the pointing device is moved while it is over an element. This attribute may be used with most elements. @param The script */ public void setOnMouseMove(String script) { addAttribute ( "onMouseMove", script ); } /** The onmouseout event occurs when the pointing device is moved away from an element. This attribute may be used with most elements. @param The script */ public void setOnMouseOut(String script) { addAttribute ( "onMouseOut", script ); } /** The onkeypress event occurs when a key is pressed and released over an element. This attribute may be used with most elements. @param The script */ public void setOnKeyPress(String script) { addAttribute ( "onKeyPress", script ); } /** The onkeydown event occurs when a key is pressed down over an element. This attribute may be used with most elements. @param The script */ public void setOnKeyDown(String script) { addAttribute ( "onKeyDown", script ); } /** The onkeyup event occurs when a key is released over an element. This attribute may be used with most elements. @param The script */ public void setOnKeyUp(String script) { addAttribute ( "onKeyUp", script ); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy