org.apache.ecs.html
Class Frame

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

All Implemented Interfaces:

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

public class Frame

extends MultiPartElement

implements Printable

This class creates a <Frame> tag.

Version:

$Id: Frame.java,v 1.3 2003/04/27 09:21:50 rdonkin Exp $

Author:

Stephan Nagy, Jon S. Stevens

See Also:

Serialized Form

Field Summary

static java.lang.String	auto
static java.lang.String	AUTO
static java.lang.String	no
static java.lang.String	NO
static java.lang.String	yes
static java.lang.String	YES

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

Frame()
Basic constructor.

Frame(Element element)
Basic constructor.

Frame(Element element, java.lang.String name)
Basic constructor.

Frame(Element element, java.lang.String name, java.lang.String src)
Basic constructor.

Frame(java.lang.String element)
Basic constructor.

Frame(java.lang.String element, java.lang.String name)
Basic constructor.

Frame(java.lang.String element, java.lang.String name, java.lang.String src)
Basic constructor.

Method Summary

(package private) void	() Private initialization routine.
Frame	addElement(Element element) Adds an Element to the element.
Frame	addElement(java.lang.String element) Adds an Element to the element.
Frame	addElement(java.lang.String hashcode, Element element) Adds an Element to the element.
Frame	addElement(java.lang.String hashcode, java.lang.String element) Adds an Element to the element.
Frame	removeElement(java.lang.String hashcode) Removes an Element from the element.
Frame	setFrameBorder(boolean frameborder) Sets the FRAMEBORDER="" attribute
Frame	setLongDesc(java.lang.String longdesc) Sets the LONGDESC="" attribute
Frame	setMarginHeight(int marginheight) Sets the MARGINHEIGHT="" attribute
Frame	setMarginHeight(java.lang.String marginheight) Sets the MARGINHEIGHT="" attribute
Frame	setMarginWidth(int marginwidth) Sets the MARGINWIDTH="" attribute
Frame	setMarginWidth(java.lang.String marginwidth) Sets the MARGINWIDTH="" attribute
Frame	setName(java.lang.String name) Sets the NAME="" attribute
Frame	setNoResize(boolean noresize) Sets the noresize value
Frame	setScrolling(java.lang.String scrolling) Sets the SCROLLING="" attribute
Frame	setSrc(java.lang.String src) Sets the SRC="" attribute

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

Field Detail

YES

public static final java.lang.String YES

NO

public static final java.lang.String NO

AUTO

public static final java.lang.String AUTO

yes

public static final java.lang.String yes

no

public static final java.lang.String no

auto

public static final java.lang.String auto

Constructor Detail

Frame

public Frame()

Basic constructor.

Frame

public Frame(Element element)

Basic constructor.

Parameters:

element - Adds an Element to the element.

Frame

public Frame(java.lang.String element)

Basic constructor.

Parameters:

element - Adds an Element to the element.

Frame

public Frame(Element element,
             java.lang.String name)

Basic constructor.

Parameters:

element - Adds an Element to the element.

name - the NAME="" attribute

Frame

public Frame(java.lang.String element,
             java.lang.String name)

Basic constructor.

Parameters:

element - Adds an Element to the element.

name - the NAME="" attribute

Frame

public Frame(Element element,
             java.lang.String name,
             java.lang.String src)

Basic constructor.

Parameters:

element - Adds an Element to the element.

name - the NAME="" attribute

src - the SRC="" attribute

Frame

public Frame(java.lang.String element,
             java.lang.String name,
             java.lang.String src)

Basic constructor.

Parameters:

element - Adds an Element to the element.

name - the NAME="" attribute

src - the SRC="" attribute

Method Detail

void ()

Private initialization routine.

Overrides:

in class MultiPartElement

setLongDesc

public Frame setLongDesc(java.lang.String longdesc)

Sets the LONGDESC="" attribute

Parameters:

longdesc - the LONGDESC="" attribute

setName

public Frame setName(java.lang.String name)

Sets the NAME="" attribute

Parameters:

name - the NAME="" attribute

setSrc

public Frame setSrc(java.lang.String src)

Sets the SRC="" attribute

Parameters:

src - the SRC="" attribute

setFrameBorder

public Frame setFrameBorder(boolean frameborder)

Sets the FRAMEBORDER="" attribute

Parameters:

frameborder - the FRAMEBORDER="" attribute

setMarginWidth

public Frame setMarginWidth(int marginwidth)

Sets the MARGINWIDTH="" attribute

Parameters:

marginwidth - the MARGINWIDTH="" attribute

setMarginWidth

public Frame setMarginWidth(java.lang.String marginwidth)

Sets the MARGINWIDTH="" attribute

Parameters:

marginwidth - the MARGINWIDTH="" attribute

setMarginHeight

public Frame setMarginHeight(int marginheight)

Sets the MARGINHEIGHT="" attribute

Parameters:

marginheight - the MARGINHEIGHT="" attribute

setMarginHeight

public Frame setMarginHeight(java.lang.String marginheight)

Sets the MARGINHEIGHT="" attribute

Parameters:

marginheight - the MARGINHEIGHT="" attribute

setScrolling

public Frame setScrolling(java.lang.String scrolling)

Sets the SCROLLING="" attribute

Parameters:

scrolling - the SCROLLING="" attribute

setNoResize

public Frame setNoResize(boolean noresize)

Sets the noresize value

Parameters:

noresize - true or false

addElement

public Frame 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 Frame 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 Frame addElement(Element element)

Adds an Element to the element.

Parameters:

element - Adds an Element to the element.

addElement

public Frame addElement(java.lang.String element)

Adds an Element to the element.

Parameters:

element - Adds an Element to the element.

removeElement

public Frame removeElement(java.lang.String hashcode)

Removes an Element from the element.

Parameters:

hashcode - the name of the element to be removed.