public final class Enumerate extends AbstractXmlNode
The <enumerate> element is an automatically generated
description of the choices available to the user. It specifies a template
that is applied to each choice in the order they appear in the menu. If it is
used with no content, a default template that lists all the choices is used,
determined by the interpreter context. If it has content, the content is the
template specifier. This specifier may refer to two special variables:
_prompt is the choice's prompt, and _dtmf is a normalized representation
(i.e. a single whitespace between DTMF tokens) of the choice's assigned DTMF
sequence (note that if no DTMF sequence is assigned to the choice element, or
if a <grammar> element is specified in
<choice>, then the _dtmf variable is assigned the
ECMAScript undefined value ).
The <enumerate> element may be used within the prompts
and the catch elements associated with <menu> elements
and with <field> elements that contain
<option> elements.
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
DTMF_VARIABLE
Name of the varaible that holds the DTMF value.
|
static java.lang.String |
PROMPT_VARIABLE
Name of the varaible that holds the prompt value.
|
static java.lang.String |
TAG_NAME
Name of the tag.
|
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE| Constructor and Description |
|---|
Enumerate()
Construct a new enumerate object without a node.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addDtmfVariable()
Adds a
_dtmf variable to this enumerat tag. |
void |
addPromptVariable()
Adds a
_prompt variable to this enumerat tag. |
Text |
addText(java.lang.String text)
Create a new text within this node.
|
protected boolean |
canContainChild(java.lang.String tagName)
Can the specified sub-tag be contained within this node?
|
Field |
getField()
Retrieves the
<field> containing this node. |
java.lang.String |
getTagName()
Get the name of the tag for the derived node.
|
XmlNode |
newInstance(org.w3c.dom.Node n,
XmlNodeFactory<? extends XmlNode> factory)
Create a new instance for the given node.
|
addChild, addChild, appendChild, appendChild, appendDeepClone, cloneNode, compareDocumentPosition, equals, getAttribute, getAttributeNames, getAttributes, getBaseURI, getChildNodes, getChildNodes, getChildren, getDefinedAttributeNames, getFeature, getFirstChild, getFirstLevelTextContent, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNode, getNodeFactory, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getOwnerXmlDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttribute, hasAttributes, hasChildNodes, hashCode, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setAttribute, setNodeValue, setPrefix, setTextContent, setUserData, toStringclone, finalize, getClass, notify, notifyAll, wait, wait, waitaddChild, getAttribute, getAttributeNames, getChildNodes, getChildren, getNode, setAttributeappendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserDatapublic static final java.lang.String DTMF_VARIABLE
public static final java.lang.String PROMPT_VARIABLE
public static final java.lang.String TAG_NAME
public Enumerate()
This is necessary for the node factory.
VoiceXmlNodeFactorypublic java.lang.String getTagName()
public XmlNode newInstance(org.w3c.dom.Node n, XmlNodeFactory<? extends XmlNode> factory)
Each XmlNode can serve as a prototype in a
XmlNodeFactory to produce a collection of
child nodes. Factories can then use the prototype pattern to
produce new nodes.
n - The node to encapsulate.factory - the factroy that calls this method.XmlNodeFactoryprotected boolean canContainChild(java.lang.String tagName)
canContainChild in class AbstractXmlNodetagName - Name of child.public Text addText(java.lang.String text)
text - The text to be added.public void addPromptVariable()
_prompt variable to this enumerat tag.public void addDtmfVariable()
_dtmf variable to this enumerat tag.public Field getField()
<field> containing this node.null if there is none.