org.symphonyoss.symphony.messageml.elements

Interface SplittableElement

All Known Subinterfaces:

LabelableElement, TooltipableElement

All Known Implementing Classes:

Checkbox, PersonSelector, Radio, Select, TextArea, TextField

public interface SplittableElement

Author:

enrico.molino (24/06/2020) This interface is used internally by the extending ones LabelableElement TooltipableElement It is used by all element interfaces that require, during the conversion MessageML to PresentationML, to generate multiple elements starting by a single one. BEWARE: dont implement this interface, instead implement children interfaces E.g.: value to:

1 value

Field Summary

Fields

Modifier and Type	Field and Description
static String	PRESENTATIONML_DIV_FLAG

Method Summary

Modifier and Type	Method and Description
default void	fillAttributes(MessageMLParser parser, Node item) Fill this Element map attributes, used internally during parsing Normally, you dont need to override the default method
default void	fillAttributes(MessageMLParser parser, Node item, Map<String,String> attributes) Fill map attributes passed as parameter, used internally during parsing Normally, you dont need to override the default method
String	getAttribute(String attr) Normally implemented by the root Element implementing this interface
Map<String,String>	getAttributes() Normally implemented by the root Element implementing this interface
default String	getElementId()
String	getStringAttribute(Node attribute) Normally implemented by the root Element implementing this interface
default boolean	isSplittable()
default boolean	isSplittableNodeComponent(Node item) Check if the current PresentationML node is part of SplittableElement Normally, you dont need to override the default method
default String	splittableAsPresentationML(XmlPrintStream out, MessageMLContext context) Convert the splittable elements (MessageML -> PresentationML).
default Set<String>	splittableRemove()
default void	validateSplittable() Validate all splittable elements present Normally, you dont need to override the default method

Field Detail

PRESENTATIONML_DIV_FLAG

static final String PRESENTATIONML_DIV_FLAG

See Also:

Constant Field Values

Method Detail

splittableAsPresentationML

default String splittableAsPresentationML(XmlPrintStream out,
                                          MessageMLContext context)

Convert the splittable elements (MessageML -> PresentationML). It opens also a

block, don't forget to close it by calling XmlPrintStream.closeElement() Normally, you dont need to override the default method

Returns:

the unique id generated

splittableRemove

default Set<String> splittableRemove()

Returns:

attributes that should not present in PresentationML main element Normally, you dont need to override the default method

isSplittableNodeComponent

default boolean isSplittableNodeComponent(Node item)

Check if the current PresentationML node is part of SplittableElement Normally, you dont need to override the default method

validateSplittable

default void validateSplittable()
                         throws InvalidInputException

Validate all splittable elements present Normally, you dont need to override the default method

Throws:

InvalidInputException

isSplittable

default boolean isSplittable()

Returns:

true if any splittable element exists Normally, you dont need to override the default method

getElementId

default String getElementId()

Returns:

the name used to build unique element id

fillAttributes

default void fillAttributes(MessageMLParser parser,
                            Node item,
                            Map<String,String> attributes)
                     throws InvalidInputException

Fill map attributes passed as parameter, used internally during parsing Normally, you dont need to override the default method

Throws:

InvalidInputException

fillAttributes

default void fillAttributes(MessageMLParser parser,
                            Node item)
                     throws InvalidInputException

Fill this Element map attributes, used internally during parsing Normally, you dont need to override the default method

Throws:

InvalidInputException

getAttribute

String getAttribute(String attr)

Normally implemented by the root Element implementing this interface

getAttributes

Map<String,String> getAttributes()

Normally implemented by the root Element implementing this interface

getStringAttribute

String getStringAttribute(Node attribute)

Normally implemented by the root Element implementing this interface