org.apache.ecs.html
Class ObjectElement

java.lang.Object
  |
  +--org.apache.ecs.GenericElement
        |
        +--org.apache.ecs.ElementAttributes
              |
              +--org.apache.ecs.ConcreteElement
                    |
                    +--org.apache.ecs.MultiPartElement
                          |
                          +--org.apache.ecs.html.ObjectElement

All Implemented Interfaces:

Attributes, java.lang.Cloneable, Element, ElementRegistry, KeyEvents, MouseEvents, Printable, java.io.Serializable

public class ObjectElement

extends MultiPartElement

implements Printable, MouseEvents, KeyEvents

This class creates an ObjectElement

Version:

$Id: ObjectElement.java,v 1.4 2003/04/27 09:22:12 rdonkin Exp $

Author:

Stephan Nagy, Jon S. Stevens

See Also:

Serialized Form

Fields inherited from class org.apache.ecs.ConcreteElement

lineSeparator, registry, registryList

Fields inherited from class org.apache.ecs.ElementAttributes

attribute_equality_sign, attribute_filter, attribute_quote, attribute_quote_char, filter_attribute_state

Fields inherited from class org.apache.ecs.GenericElement

__text, _defaultFilter, begin_end_modifier, begin_end_modifier_defined, begin_start_modifier, begin_start_modifier_defined, case_type, codeset, element, element_type, end_element, end_end_modifier, end_end_modifier_defined, end_modifier_defined, end_start_modifier, end_start_modifier_defined, end_tag, filter, filter_state, position, pretty_print, start_modifier_defined, start_tag, tabLevel, VERSION

Fields inherited from interface org.apache.ecs.Attributes

NO_ATTRIBUTE_VALUE

Fields inherited from interface org.apache.ecs.Element

CENTER, LEFT, LOWERCASE, MIXEDCASE, RIGHT, UPPERCASE

Constructor Summary

ObjectElement()
Default constructor.

Method Summary

(package private) void	() Private initializer.
ObjectElement	addElement(Element element) Add an element to the element
ObjectElement	addElement(java.lang.String element) Add an element to the element
ObjectElement	addElement(java.lang.String hashcode, Element element) Adds an Element to the element.
ObjectElement	addElement(java.lang.String hashcode, java.lang.String element) Adds an Element to the element.
ObjectElement	removeElement(java.lang.String hashcode) Removes an Element from the element.
ObjectElement	setAlign(java.lang.String alignment) Set the horizontal or vertical alignment of this object. Convience variables are in the AlignTypes interface.
ObjectElement	setArchive(java.lang.String url) Space seperated archive list.
ObjectElement	setBorder(double border) Suggested link border width.
ObjectElement	setBorder(int border) Suggested link border width.
ObjectElement	setBorder(java.lang.String border) Suggested link border width.
ObjectElement	setClassId(java.lang.String url) Identifies an implementation.
ObjectElement	setCodeBase(java.lang.String url) Determines the base path to resolve relative urls specified by classid.
ObjectElement	setCodeType(java.lang.String codetype) Sets the Internet content type for the code.
ObjectElement	setData(java.lang.String url) This attribute specifies the location of the data to be rendered.
ObjectElement	setDeclare(boolean declare) Sets the declare attribute.
ObjectElement	setHeight(double height) Suggested height of object.
ObjectElement	setHeight(int height) Suggested height of object.
ObjectElement	setHeight(java.lang.String height) Suggested height of object.
ObjectElement	setHSpace(double hspace) Suggested horizontal gutter.
ObjectElement	setHSpace(int hspace) Suggested horizontal gutter.
ObjectElement	setHSpace(java.lang.String hspace) Suggested horizontal gutter.
ObjectElement	setName(java.lang.String name) Set the name of this object.
void	setOnClick(java.lang.String script) The onclick event occurs when the pointing device button is clicked over an element.
void	setOnDblClick(java.lang.String script) The ondblclick event occurs when the pointing device button is double clicked over an element.
void	setOnKeyDown(java.lang.String script) The onkeydown event occurs when a key is pressed down over an element.
void	setOnKeyPress(java.lang.String script) The onkeypress event occurs when a key is pressed and released over an element.
void	setOnKeyUp(java.lang.String script) The onkeyup event occurs when a key is released over an element.
void	setOnMouseDown(java.lang.String script) The onmousedown event occurs when the pointing device button is pressed over an element.
void	setOnMouseMove(java.lang.String script) The onmousemove event occurs when the pointing device is moved while it is over an element.
void	setOnMouseOut(java.lang.String script) The onmouseout event occurs when the pointing device is moved away from an element.
void	setOnMouseOver(java.lang.String script) The onmouseover event occurs when the pointing device is moved onto an element.
void	setOnMouseUp(java.lang.String script) The onmouseup event occurs when the pointing device button is released over an element.
ObjectElement	setShapes(boolean shape) Object has shaped hypertext links.
ObjectElement	setStandBy(java.lang.String cdata) Message to show while the object is loading.
ObjectElement	setTabIndex(int number) Set the elements position in the tabbing order.
ObjectElement	setTabIndex(java.lang.String number) Set the elements position in the tabbing order.
ObjectElement	setType(java.lang.String type) This attribute specifies the Internet Media Type for the data specified by data. This should be a mime type.
ObjectElement	setUseMap(java.lang.String url) Location of image map to use.
ObjectElement	setVSpace(double vspace) Suggested vertical gutter.
ObjectElement	setVSpace(int vspace) Suggested vertical gutter.
ObjectElement	setVSpace(java.lang.String vspace) Suggested vertical gutter.
ObjectElement	setWidth(double width) Suggested width of object.
ObjectElement	setWidth(int width) Suggested width of object.
ObjectElement	setWidth(java.lang.String width) Suggested width of object.

Methods inherited from class org.apache.ecs.ConcreteElement

addElementToRegistry, addElementToRegistry, addElementToRegistry, addElementToRegistry, addElementToRegistry, addElementToRegistry, addElementToRegistry, addElementToRegistry, clone, elements, getElement, isEmpty, keys, output, output, output, output, registryHasElement, registryHasElement, removeElementFromRegistry, removeElementFromRegistry

Methods inherited from class org.apache.ecs.ElementAttributes

addAttribute, addAttribute, addAttribute, addAttribute, attributes, createStartTag, getAttribute, getAttributeEqualitySign, getAttributeFilter, getAttributeFilterState, getAttributeQuote, getAttributeQuoteChar, hasAttribute, removeAttribute, setAttributeEqualitySign, setAttributeFilter, setAttributeFilterState, setAttributeQuote, setAttributeQuoteChar, setClass, setDir, setID, setLang, setStyle, setTitle

Methods inherited from class org.apache.ecs.GenericElement

alterCase, createEndTag, getBeginEndModifier, getBeginEndModifierDefined, getBeginStartModifier, getBeginStartModifierDefined, getCase, getCodeSet, getElementHashEntry, getElementType, getEndEndModifier, getEndEndModifierDefined, getEndStartModifier, getEndStartModifierDefined, getEndTagChar, getFilter, getFilterState, getNeedClosingTag, getNeedLineBreak, getPrettyPrint, getStartTagChar, getTabLevel, getTagPosition, getTagText, getVersion, putTabs, putTabs, removeBeginEndModifier, removeBeginStartModifier, removeEndEndModifier, removeEndStartModifier, setBeginEndModifier, setBeginEndModifierDefined, setBeginModifier, setBeginModifier, setBeginStartModifier, setBeginStartModifierDefined, setCase, setCodeSet, setElementType, setEndEndModifier, setEndEndModifierDefined, setEndModifier, setEndModifier, setEndStartModifier, setEndStartModifierDefined, setEndTagChar, setFilter, setFilterState, setNeedClosingTag, setPrettyPrint, setStartTagChar, setTabLevel, setTagPosition, setTagText, toString, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait

Constructor Detail

ObjectElement

public ObjectElement()

Default constructor. Creates the <object/> Element.
use set* methods.

Method Detail

void ()

Private initializer.

Overrides:

in class MultiPartElement

setDeclare

public ObjectElement setDeclare(boolean declare)

Sets the declare attribute. (declare this object but don't instantiate it.

Parameters:

declare - declare on or off

setClassId

public ObjectElement setClassId(java.lang.String url)

Identifies an implementation.

Parameters:

url - location of classid.

setCodeType

public ObjectElement setCodeType(java.lang.String codetype)

Sets the Internet content type for the code.

Parameters:

codetype - Sets the Internet content type for the code.

setCodeBase

public ObjectElement setCodeBase(java.lang.String url)

Determines the base path to resolve relative urls specified by classid.

Parameters:

url - base path to resolve relative urls specified by classid.

setData

public ObjectElement setData(java.lang.String url)

This attribute specifies the location of the data to be rendered.

Parameters:

url - this attribute specifies the location of the data to be rendered.

setType

public ObjectElement setType(java.lang.String type)

This attribute specifies the Internet Media Type for the data specified by data.
This should be a mime type.

Parameters:

type - a mime type for the data specifed by the data attribute.

setArchive

public ObjectElement setArchive(java.lang.String url)

Space seperated archive list.

Parameters:

url - Space seperate archive list.

setStandBy

public ObjectElement setStandBy(java.lang.String cdata)

Message to show while the object is loading.

Parameters:

cdata - the message to show while the object is loading.

setBorder

public ObjectElement setBorder(java.lang.String border)

Suggested link border width.

Parameters:

border - suggested link border width.

setBorder

public ObjectElement setBorder(int border)

Suggested link border width.

Parameters:

border - suggested link border width.

setBorder

public ObjectElement setBorder(double border)

Suggested link border width.

Parameters:

border - suggested link border width.

setHeight

public ObjectElement setHeight(java.lang.String height)

Suggested height of object.

Parameters:

height - suggested link height.

setHeight

public ObjectElement setHeight(int height)

Suggested height of object.

Parameters:

height - suggested link height.

setHeight

public ObjectElement setHeight(double height)

Suggested height of object.

Parameters:

height - suggested link height.

setWidth

public ObjectElement setWidth(java.lang.String width)

Suggested width of object.

Parameters:

height - suggested link width.

setWidth

public ObjectElement setWidth(int width)

Suggested width of object.

Parameters:

height - suggested link width.

setWidth

public ObjectElement setWidth(double width)

Suggested width of object.

Parameters:

height - suggested link width.

setHSpace

public ObjectElement setHSpace(java.lang.String hspace)

Suggested horizontal gutter.

Parameters:

hspace - suggested horizontal gutter.

setHSpace

public ObjectElement setHSpace(int hspace)

Suggested horizontal gutter.

Parameters:

hspace - suggested horizontal gutter.

setHSpace

public ObjectElement setHSpace(double hspace)

Suggested horizontal gutter.

Parameters:

hspace - suggested horizontal gutter.

setVSpace

public ObjectElement setVSpace(java.lang.String vspace)

Suggested vertical gutter.

Parameters:

hspace - suggested vertical gutter.

setVSpace

public ObjectElement setVSpace(int vspace)

Suggested vertical gutter.

Parameters:

hspace - suggested vertical gutter.

setVSpace

public ObjectElement setVSpace(double vspace)

Suggested vertical gutter.

Parameters:

hspace - suggested vertical gutter.

setAlign

public ObjectElement setAlign(java.lang.String alignment)

Set the horizontal or vertical alignment of this object.
Convience variables are in the AlignTypes interface.

Parameters:

alignment - Set the horizontal or vertical alignment of this object.
Convience variables are in the AlignTypes interface.

setUseMap

public ObjectElement setUseMap(java.lang.String url)

Location of image map to use.

Parameters:

url - location of image map to use.

setShapes

public ObjectElement setShapes(boolean shape)

Object has shaped hypertext links.

Parameters:

shape - does the object have shaped hypertext links?

setName

public ObjectElement setName(java.lang.String name)

Set the name of this object.

Parameters:

name - set the name of this object.

setTabIndex

public ObjectElement setTabIndex(int number)

Set the elements position in the tabbing order.

Parameters:

number - set the elements position in the tabbing order.

setTabIndex

public ObjectElement setTabIndex(java.lang.String number)

Set the elements position in the tabbing order.

Parameters:

number - set the elements position in the tabbing order.

addElement

public ObjectElement addElement(java.lang.String hashcode,
                                Element element)

Adds an Element to the element.

Parameters:

hashcode - name of element for hash table

element - Adds an Element to the element.

addElement

public ObjectElement addElement(java.lang.String hashcode,
                                java.lang.String element)

Adds an Element to the element.

Parameters:

hashcode - name of element for hash table

element - Adds an Element to the element.

addElement

public ObjectElement addElement(java.lang.String element)

Add an element to the element

Parameters:

element - a string representation of the element

addElement

public ObjectElement addElement(Element element)

Add an element to the element

Parameters:

element - an element to add

removeElement

public ObjectElement removeElement(java.lang.String hashcode)

Removes an Element from the element.

Parameters:

hashcode - the name of the element to be removed.

setOnClick

public void setOnClick(java.lang.String script)

The onclick event occurs when the pointing device button is clicked over an element. This attribute may be used with most elements.

Specified by:

setOnClick in interface MouseEvents

Parameters:

The - script

setOnDblClick

public void setOnDblClick(java.lang.String script)

The ondblclick event occurs when the pointing device button is double clicked over an element. This attribute may be used with most elements.

Specified by:

setOnDblClick in interface MouseEvents

Parameters:

The - script

setOnMouseDown

public void setOnMouseDown(java.lang.String script)

The onmousedown event occurs when the pointing device button is pressed over an element. This attribute may be used with most elements.

Specified by:

setOnMouseDown in interface MouseEvents

Parameters:

The - script

setOnMouseUp

public void setOnMouseUp(java.lang.String script)

The onmouseup event occurs when the pointing device button is released over an element. This attribute may be used with most elements.

Specified by:

setOnMouseUp in interface MouseEvents

Parameters:

The - script

setOnMouseOver

public void setOnMouseOver(java.lang.String script)

The onmouseover event occurs when the pointing device is moved onto an element. This attribute may be used with most elements.

Specified by:

setOnMouseOver in interface MouseEvents

Parameters:

The - script

setOnMouseMove

public void setOnMouseMove(java.lang.String 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.

Specified by:

setOnMouseMove in interface MouseEvents

Parameters:

The - script

setOnMouseOut

public void setOnMouseOut(java.lang.String script)

The onmouseout event occurs when the pointing device is moved away from an element. This attribute may be used with most elements.

Specified by:

setOnMouseOut in interface MouseEvents

Parameters:

The - script

setOnKeyPress

public void setOnKeyPress(java.lang.String script)

The onkeypress event occurs when a key is pressed and released over an element. This attribute may be used with most elements.

Specified by:

setOnKeyPress in interface KeyEvents

Parameters:

The - script

setOnKeyDown

public void setOnKeyDown(java.lang.String script)

The onkeydown event occurs when a key is pressed down over an element. This attribute may be used with most elements.

Specified by:

setOnKeyDown in interface KeyEvents

Parameters:

The - script

setOnKeyUp

public void setOnKeyUp(java.lang.String script)

The onkeyup event occurs when a key is released over an element. This attribute may be used with most elements.

Specified by:

setOnKeyUp in interface KeyEvents

Parameters:

The - script