org.symphonyoss.symphony.messageml.elements

Class PersonSelector

java.lang.Object

org.symphonyoss.symphony.messageml.elements.Element

org.symphonyoss.symphony.messageml.elements.FormElement

org.symphonyoss.symphony.messageml.elements.PersonSelector

All Implemented Interfaces:

LabelableElement, SplittableElement, TooltipableElement

public class PersonSelector
extends FormElement
implements LabelableElement, TooltipableElement

Class representing a person selector inside a Symphony Elements form.

Since:

06/11/2019

Author:

Cristiano Faustino

Field Summary

Fields

Modifier and Type	Field and Description
static String	MESSAGEML_TAG

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

format, ID_ATTR, STYLE_ATTR

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

Constructor Summary

Constructors

Constructor and Description
PersonSelector(Element parent, FormatEnum messageFormat)

Method Summary

Modifier and Type	Method and Description
org.commonmark.node.Node	asMarkdown() Return Markdown representation of the element as Node.
void	asPresentationML(XmlPrintStream out, MessageMLContext context) Print a PresentationML representation of the element and its children to the provided PrintStream.
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	getElementId()
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, 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.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

Field Detail

MESSAGEML_TAG

public static final String MESSAGEML_TAG

See Also:

Constant Field Values

Constructor Detail

PersonSelector

public PersonSelector(Element parent,
                      FormatEnum messageFormat)

Method Detail

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

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

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.

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

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

getElementId

public String getElementId()

Specified by:

getElementId in interface SplittableElement

Returns:

the name used to build unique element id