org.apache.ecs
Class Option

java.lang.Object
  |
  +--org.apache.ecs.Element
        |
        +--org.apache.ecs.ElementAttributes
              |
              +--org.apache.ecs.ConcreteElement
                    |
                    +--org.apache.ecs.MultiPartElement
                          |
                          +--org.apache.ecs.Option

public class Option
extends MultiPartElement

This class creates a <Option> tag. The Option tag defaults to not having a closing </Option> because it is optional in the spec. This can be overridden by setNeedClosingTag(true)

Version:
$Id: Option.java,v 1.7 1999/06/08 21:29:13 stephan Exp $
Author:
Stephan Nagy, Jon S. Stevens

Fields inherited from class org.apache.ecs.ConcreteElement
h_element, v_element
 
Fields inherited from class org.apache.ecs.ElementAttributes
attribute_filter, filter_attribute_state, NO_ATTRIBUTE_VALUE
 
Fields inherited from class org.apache.ecs.Element
__text, case_type, codeset, element, element_type, end_element, end_modifier, end_modifier_defined, end_tag, filter, filter_state, position, resource, start_modifier, start_modifier_defined, start_tag, VERSION
 
Constructor Summary
Option()
          Basic constructor.
Option(java.lang.String value)
          Basic constructor.
Option(java.lang.String label, double value)
          Basic constructor.
Option(java.lang.String label, int value)
          Basic constructor.
Option(java.lang.String label, java.lang.String value)
          Basic constructor.
 
Method Summary
(package private)  void ()
          Private initialization routine.
 Option addElement(Element element)
          Adds an Element to the element.
 Option addElement(java.lang.String element)
          Adds an Element to the element.
 Option[] addElement(java.lang.String[] element)
          Creates a group of options.
 Option addElement(java.lang.String hashcode, Element element)
          Adds an Element to the element.
 Option addElement(java.lang.String hashcode, java.lang.String element)
          Adds an Element to the element.
 Option removeElement(java.lang.String hashcode)
          Removes an Element from the element.
 Option setDisabled(boolean disabled)
          Sets the disabled value
 Option setLabel(java.lang.String label)
          Sets the LABEL="" attribute
 Option setSelected(boolean selected)
          Sets the selected value
 Option setValue(double value)
          Sets the VALUE="" attribute
 Option setValue(int value)
          Sets the VALUE="" attribute
 Option setValue(java.lang.String value)
          Sets the VALUE="" attribute
 
Methods inherited from class org.apache.ecs.ConcreteElement
addElementToRegistry, addElementToRegistry, addElementToRegistry, addElementToRegistry, addElementToRegistry, addElementToRegistry, addElementToRegistry, addElementToRegistry, clone, output, output, registryHasElement, registryHasElement, removeElementFromRegistry, removeElementFromRegistry
 
Methods inherited from class org.apache.ecs.ElementAttributes
addAttribute, createStartTag, getAttributeFilter, getAttributeFilterState, hasAttribute, removeAttribute, setAttributeFilter, setAttributeFilterState, setClass, setDir, setID, setLang, setStyle, setTitle
 
Methods inherited from class org.apache.ecs.Element
alterCase, createEndTag, getCase, getCodeSet, getElementHashEntry, getElementType, getEndModifier, getEndModifierDefined, getEndTagChar, getFilter, getFilterState, getNeedClosingTag, getStartModifier, getStartModifierDefined, getStartTagChar, getTagPosition, getTagText, getVersion, removeEndModifier, removeStartModifier, setCase, setCodeSet, setElementType, setEndModifier, setEndModifierDefined, setEndTagChar, setFilter, setFilterState, setModifier, setModifier, setNeedClosingTag, setStartModifier, setStartModifierDefined, setStartTagChar, setTagPosition, setTagText, toString, toString
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait
 

Constructor Detail

Option

public Option()
Basic constructor. Use the set* methods to set the values of the attributes.

Option

public Option(java.lang.String value)
Basic constructor. Use the set* methods to set the values of the attributes.
Parameters:
value - sets the attribute VALUE=""

Option

public Option(java.lang.String label,
              java.lang.String value)
Basic constructor. Use the set* methods to set the values of the attributes.
Parameters:
label - sets the attribute LABEL=""
value - sets the attribute VALUE=""

Option

public Option(java.lang.String label,
              int value)
Basic constructor. Use the set* methods to set the values of the attributes.
Parameters:
label - sets the attribute LABEL=""
value - sets the attribute VALUE=""

Option

public Option(java.lang.String label,
              double value)
Basic constructor. Use the set* methods to set the values of the attributes.
Parameters:
label - sets the attribute LABEL=""
value - sets the attribute VALUE=""
Method Detail

void ()
Private initialization routine.
Overrides:
in class MultiPartElement

setLabel

public Option setLabel(java.lang.String label)
Sets the LABEL="" attribute
Parameters:
label - the LABEL="" attribute

setValue

public Option setValue(java.lang.String value)
Sets the VALUE="" attribute
Parameters:
value - the VALUE="" attribute

setValue

public Option setValue(int value)
Sets the VALUE="" attribute
Parameters:
value - the VALUE="" attribute

setValue

public Option setValue(double value)
Sets the VALUE="" attribute
Parameters:
value - the VALUE="" attribute

setSelected

public Option setSelected(boolean selected)
Sets the selected value
Parameters:
selected - true or false

setDisabled

public Option setDisabled(boolean disabled)
Sets the disabled value
Parameters:
disabled - true or false

addElement

public Option 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 Option 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 Option addElement(Element element)
Adds an Element to the element.
Parameters:
element - Adds an Element to the element.

addElement

public Option addElement(java.lang.String element)
Adds an Element to the element.
Parameters:
element - Adds an Element to the element.

addElement

public Option[] addElement(java.lang.String[] element)
Creates a group of options.
Parameters:
Creates - a group of options.

removeElement

public Option removeElement(java.lang.String hashcode)
Removes an Element from the element.
Parameters:
hashcode - the name of the element to be removed.