Package org.symphonyoss.symphony.messageml.elements

Class Button

java.lang.Object

org.symphonyoss.symphony.messageml.elements.Element

org.symphonyoss.symphony.messageml.elements.Button

public class Button
extends Element

This class specify the Symphony Element Button represented by tag name "button". A Button can be included either inside Forms or in UIActions (at least one is required). Depending on the location, the messageML representation can be different. When is part of a Form it can contain the following attributes:

• name (required) -> used to identify the button
• type -> default "action", specify the type of the button. Allowed values are "action", "reset" and "cancel"
• class -> can be "primary", "secondary", "tertiary" (deprecated: "primary-destructive","secondary-destructive")
• title -> description displayed as a hint
  When the Button is included inside a UIAction, only "class" and "title" are allowed as attributes.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ACTION_TYPE
static String	CANCEL_TYPE
static String	MESSAGEML_TAG
static String	RESET_TYPE

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

CLASS_ATTR, format, ID_ATTR, ID_MAX_LENGTH, MAPPER, STYLE_ATTR

Constructor Summary

Constructors

Constructor	Description
Button(Element parent, FormatEnum format)

Method Summary

Modifier and Type	Method	Description
org.commonmark.node.Node	asMarkdown()
void	buildAttribute(MessageMLParser parser, Node item)
void	updateBiContext(BiContext context)
void	validate()

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

addChild, areNestedElementsAllowed, asText, buildAll, buildNode, countChildrenOfType, countNonTextNodesInNodeList, findElements, findElements, findElements, getAttribute, getAttributes, getChild, getChildren, getFormat, getMessageMLTag, getParent, getPresentationMLTag, getStringAttribute, hasExactNumberOfChildren, hasIdAttribute, putIntegerIfPresent, putOneIfPresent, putStringIfPresent, 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

ACTION_TYPE

public static final String ACTION_TYPE

See Also:

Constant Field Values

CANCEL_TYPE

public static final String CANCEL_TYPE

See Also:

Constant Field Values

RESET_TYPE

public static final String RESET_TYPE

See Also:

Constant Field Values

Constructor Detail

Button

public Button(Element parent,
              FormatEnum format)

Method Detail

buildAttribute

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

Throws:

InvalidInputException

asMarkdown

public org.commonmark.node.Node asMarkdown()

validate

public void validate()
              throws InvalidInputException

Throws:

InvalidInputException

updateBiContext

public void updateBiContext(BiContext context)