public final class Menu extends AbstractXmlNode
This identifies the menu, and determines the scope of its grammars.
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
ATTRIBUTE_ACCEPT
When set to "exact" (the default), the text of the choice elements in the
menu defines the exact phrase to be recognized.
|
static java.lang.String |
ATTRIBUTE_DTMF
When set to true, the first nine choices that have not explicitly
specified a value for the dtmf attribute are given the implicit ones "1",
"2", etc.
|
static java.lang.String |
ATTRIBUTE_ID
The identifier of the menu.
|
protected static java.util.ArrayList<java.lang.String> |
ATTRIBUTE_NAMES
Supported attribute names for this node.
|
static java.lang.String |
ATTRIBUTE_SCOPE
The menu's grammar scope.
|
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 |
|---|
Menu()
Construct a new menu object without a node.
|
| Modifier and Type | Method and Description |
|---|---|
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?
|
java.lang.String |
getAccept()
Retrieve the accept attribute.
|
AcceptType |
getAcceptObject()
Retrieve the accept attribute.
|
java.util.Collection<java.lang.String> |
getAttributeNames()
Returns a collection of permitted attribute names for the node.
|
java.lang.String |
getDtmf()
Retrieve the dtmf attribute.
|
java.lang.String |
getId()
Retrieve the id attribute.
|
java.lang.String |
getScope()
Retrieve the scope attribute.
|
java.lang.String |
getTagName()
Get the name of the tag for the derived node.
|
boolean |
isDtmf()
Checks if the DTMF attribute is set.
|
XmlNode |
newInstance(org.w3c.dom.Node n,
XmlNodeFactory<? extends XmlNode> factory)
Create a new instance for the given node.
|
void |
setAccept(AcceptType accept)
Set the accept attribute.
|
void |
setAccept(java.lang.String accept)
Set the accept attribute.
|
void |
setDtmf(boolean enable)
Set the dtmf attribute.
|
void |
setDtmf(java.lang.String dtmf)
Set the dtmf attribute.
|
void |
setId(java.lang.String id)
Set the id attribute.
|
void |
setScope(java.lang.String scope)
Set the scope attribute.
|
addChild, addChild, appendChild, appendChild, appendDeepClone, cloneNode, compareDocumentPosition, equals, getAttribute, 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, 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 TAG_NAME
public static final java.lang.String ATTRIBUTE_ID
<goto> or a <submit>.public static final java.lang.String ATTRIBUTE_SCOPE
public static final java.lang.String ATTRIBUTE_DTMF
public static final java.lang.String ATTRIBUTE_ACCEPT
<choice> can override this
setting.protected static final java.util.ArrayList<java.lang.String> ATTRIBUTE_NAMES
public Menu()
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.XmlNodeFactorypublic java.lang.String getId()
ATTRIBUTE_IDpublic void setId(java.lang.String id)
id - Value of the id attribute.ATTRIBUTE_IDpublic java.lang.String getScope()
ATTRIBUTE_SCOPEpublic void setScope(java.lang.String scope)
scope - Value of the scope attribute.ATTRIBUTE_SCOPEpublic java.lang.String getDtmf()
ATTRIBUTE_DTMFpublic boolean isDtmf()
true if the DTMF attribute is set to true.ATTRIBUTE_DTMFpublic void setDtmf(java.lang.String dtmf)
dtmf - Value of the dtmf attribute.ATTRIBUTE_DTMFpublic void setDtmf(boolean enable)
enable - true if DTMF generation should be enables.ATTRIBUTE_DTMFpublic java.lang.String getAccept()
ATTRIBUTE_ACCEPTpublic AcceptType getAcceptObject()
ATTRIBUTE_ACCEPTpublic void setAccept(java.lang.String accept)
accept - Value of the accept attribute.ATTRIBUTE_ACCEPTpublic void setAccept(AcceptType accept)
accept - Value of the accept attribute.ATTRIBUTE_ACCEPTpublic Text addText(java.lang.String text)
text - The text to be added.protected boolean canContainChild(java.lang.String tagName)
canContainChild in class AbstractXmlNodetagName - Name of child.public java.util.Collection<java.lang.String> getAttributeNames()
getAttributeNames in interface XmlNodegetAttributeNames in class AbstractXmlNode