org.symphonyoss.symphony.messageml.elements

Class TextField

java.lang.Object

org.symphonyoss.symphony.messageml.elements.Element

org.symphonyoss.symphony.messageml.elements.FormElement

org.symphonyoss.symphony.messageml.elements.TextField

All Implemented Interfaces:

RegexElement

public class TextField
extends FormElement
implements RegexElement

Class representing a Text Field inside a Form.

Since:

06/07/2019

Author:

Lucas Macedo

Field Summary

Fields

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

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

INPUT_TAG, NAME_ATTR, TYPE_ATTR

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

CLASS_ATTR, format, STYLE_ATTR

Fields inherited from interface org.symphonyoss.symphony.messageml.elements.RegexElement

ALL_REGEX_ATTRS, ATTRIBUTE_MANDATORY_WHEN_ATTRIBUTE_DEFINED_ERR, ATTRIBUTE_TOO_LONG_ERR, PATTERN_ATTR, PATTERN_ERROR_MESSAGE_ATTR, PATTERN_ERROR_MESSAGE_MAX_LENGTH, PATTERN_MAX_LENGTH, PRESENTATIONML_PATTERN_ERROR_MESSAGE_ATTR, REGEX_NOT_VALID_ERR

Constructor Summary

Constructors

Constructor and Description
TextField(Element parent, FormatEnum messageFormat)

Method Summary

Modifier and Type	Method and Description
boolean	areNestedElementsAllowed() Return true if nested elements are allowed By default true, override to false for elements that dont support nested elements
org.commonmark.node.Node	asMarkdown() Return Markdown representation of the element as Node.
void	buildAll(MessageMLParser context, Element element) Process a DOM element, descending into its children, and construct the output MessageML tree.
protected void	buildAttribute(Node item) Parse a DOM attribute into MessageML element properties.
Map<String,String>	getOtherAttributes()
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, asText, buildNode, countNonTextNodesInNodeList, findElements, findElements, findElements, getAttribute, getAttributes, getChild, getChildren, getFormat, getMessageMLTag, getParent, hasExactNumberOfChildren, hasIdAttribute, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.symphonyoss.symphony.messageml.elements.RegexElement

getAttribute, getAttributes, getRegexAttrForPresentationML, validateRegex

Field Detail

MESSAGEML_TAG

public static final String MESSAGEML_TAG

See Also:

Constant Field Values

PRESENTATIONML_INPUT_TYPE

public static final String PRESENTATIONML_INPUT_TYPE

See Also:

Constant Field Values

Constructor Detail

TextField

public TextField(Element parent,
                 FormatEnum messageFormat)

Method Detail

validate

public void validate()
              throws InvalidInputException

Description copied from class: Element

Check the syntax and contents of the element.

Overrides:

validate in class FormElement

Throws:

InvalidInputException

buildAll

public void buildAll(MessageMLParser context,
                     Element element)
              throws InvalidInputException,
                     ProcessingException

Description copied from class: Element

Process a DOM element, descending into its children, and construct the output MessageML tree.

Overrides:

buildAll in class Element

Throws:

InvalidInputException

ProcessingException

asMarkdown

public org.commonmark.node.Node asMarkdown()

Description copied from class: Element

Return Markdown representation of the element as Node.

buildAttribute

protected void buildAttribute(Node item)
                       throws InvalidInputException

Description copied from class: Element

Parse a DOM attribute into MessageML element properties.

Throws:

InvalidInputException

getOtherAttributes

public Map<String,String> getOtherAttributes()

Specified by:

getOtherAttributes in interface RegexElement

Returns:

all element's attributes that are not regex related

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

areNestedElementsAllowed

public boolean areNestedElementsAllowed()

Description copied from class: Element

Return true if nested elements are allowed By default true, override to false for elements that dont support nested elements

Overrides:

areNestedElementsAllowed in class Element