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:

LabelableElement, MinMaxLengthElement, RegexElement, SplittableElement, TooltipableElement

public class TextField
extends FormElement
implements RegexElement, LabelableElement, TooltipableElement, MinMaxLengthElement

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	ELEMENT_ID
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, ID_ATTR, 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

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

LABEL, LABEL_FOR, LABEL_MAX_LENGTH, LABEL_TOO_LONG_ERR

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

DATA_TARGET_ID, DATA_TITLE, TITLE, TOOLTIP_CLASS, TOOLTIP_MAX_LENGTH, TOOLTIP_TOO_LONG_ERR, TOOLTIPABLE_PRESENTATIONML

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

PRESENTATIONML_DIV_FLAG

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

ALL_MIN_MAX_ATTRS, MAXLENGTH_ATTR, MINLENGTH_ATTR

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 parser, Element element) Process a DOM element, descending into its children, and construct the output MessageML tree.
protected void	buildAttribute(MessageMLParser parser, Node item) Parse a DOM attribute into MessageML element properties.
String	getAttributeValue(String attributeName)
String	getElementId()
String	getElementInitialValue()
String	getElementType()
Integer	getMaxValueAllowed()
Integer	getMinValueAllowed()
Map<String,String>	getOtherAttributes()
String	getPresentationMLTag() Return the element's PresentationML tag.
boolean	hasElementInitialValue()
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, getStringAttribute, hasExactNumberOfChildren, hasIdAttribute, size, throwInvalidInputException

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, getFormat, getRegexAttrForPresentationML, validateRegex

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

getLabelAttribute, getPresentationMLLabelTag, isLabel, isLabelNode, validateLabel

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

getPresentationMLTooltipTag, getTooltipAttributes, isTooltip, isTooltipNode, validateTooltip

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

fillAttributes, fillAttributes, getAttribute, getAttributes, getStringAttribute, isSplittable, isSplittableNodeComponent, splittableAsPresentationML, splittableRemove, validateSplittable

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

getAttributeAsInteger, getDefaultValueIfCurrentIsNull, getLengthErrorMessage, isLengthOutOfRange, isMinAndMaxLengthCombinationValid, isTextBiggerThanMaxLength, isTextSmallerThanMinLength, validateInitialValueIfFound, validateMinAndMaxLengths

Field Detail

MESSAGEML_TAG

public static final String MESSAGEML_TAG

See Also:

Constant Field Values

ELEMENT_ID

public static final String ELEMENT_ID

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 parser,
                     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(MessageMLParser parser,
                              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

getElementId

public String getElementId()

Specified by:

getElementId in interface SplittableElement

Returns:

the name used to build unique element id

getElementType

public String getElementType()

Specified by:

getElementType in interface MinMaxLengthElement

Returns:

the type of the element

hasElementInitialValue

public boolean hasElementInitialValue()

Specified by:

hasElementInitialValue in interface MinMaxLengthElement

Returns:

true if the element has an initial value

getElementInitialValue

public String getElementInitialValue()

Specified by:

getElementInitialValue in interface MinMaxLengthElement

Returns:

the initial value found in the element

getAttributeValue

public String getAttributeValue(String attributeName)

Specified by:

getAttributeValue in interface MinMaxLengthElement

Parameters:

attributeName - we want to retrieve

Returns:

the value corresponding to the attributeName given in input

getMinValueAllowed

public Integer getMinValueAllowed()

Specified by:

getMinValueAllowed in interface MinMaxLengthElement

Returns:

minimum value allowed for the minLength attribute

getMaxValueAllowed

public Integer getMaxValueAllowed()

Specified by:

getMaxValueAllowed in interface MinMaxLengthElement

Returns:

maximum value allowed for the maxLength attribute