org.symphonyoss.symphony.messageml.elements

Class Chime

java.lang.Object

org.symphonyoss.symphony.messageml.elements.Element

org.symphonyoss.symphony.messageml.elements.Chime

public class Chime
extends Element

Class representing a convenience element for a chime. Translated to an audio element.

Since:

3/27/17

Author:

lukasz

Field Summary

Fields

Modifier and Type	Field and Description
static String	MESSAGEML_TAG
static String	PRESENTATIONML_TAG

Fields inherited from class org.symphonyoss.symphony.messageml.elements.Element

CLASS_ATTR, format, ID_ATTR, STYLE_ATTR

Constructor Summary

Constructors

Constructor and Description
Chime(Element parent, FormatEnum format)

Method Summary

Modifier and Type	Method and Description
void	asPresentationML(XmlPrintStream out, MessageMLContext context) Print a PresentationML representation of the element and its children to the provided PrintStream.
String	asText() Return a text representation of the element, descending into its children.
protected void	buildAttribute(MessageMLParser parser, Node item) Parse a DOM attribute into MessageML element properties.
String	getPresentationMLTag() Return the element's PresentationML tag.
void	validate() Check the syntax and contents of the element.

Methods inherited from class org.symphonyoss.symphony.messageml.elements.Element

addChild, areNestedElementsAllowed, buildAll, buildNode, countNonTextNodesInNodeList, findElements, findElements, findElements, getAttribute, getAttributes, getChild, getChildren, getFormat, getMessageMLTag, getParent, getStringAttribute, hasExactNumberOfChildren, hasIdAttribute, size, throwInvalidInputException

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MESSAGEML_TAG

public static final String MESSAGEML_TAG

See Also:

Constant Field Values

PRESENTATIONML_TAG

public static final String PRESENTATIONML_TAG

See Also:

Constant Field Values

Constructor Detail

Chime

public Chime(Element parent,
             FormatEnum format)
      throws InvalidInputException

Throws:

InvalidInputException

Method Detail

buildAttribute

protected void buildAttribute(MessageMLParser parser,
                              Node item)
                       throws InvalidInputException

Description copied from class: Element

Parse a DOM attribute into MessageML element properties.

Throws:

InvalidInputException

asPresentationML

public void asPresentationML(XmlPrintStream out,
                             MessageMLContext context)

Description copied from class: Element

Print a PresentationML representation of the element and its children to the provided PrintStream.

asText

public String asText()

Description copied from class: Element

Return a text representation of the element, descending into its children.

Overrides:

asText in class Element

validate

public void validate()
              throws InvalidInputException

Description copied from class: Element

Check the syntax and contents of the element.

Throws:

InvalidInputException

getPresentationMLTag

public String getPresentationMLTag()

Description copied from class: Element

Return the element's PresentationML tag. By default is equals to MessageML tag, override when needed

Overrides:

getPresentationMLTag in class Element