Package org.symphonyoss.symphony.messageml.elements

Interface TooltipableElement

All Superinterfaces:

SplittableElement

All Known Implementing Classes:

DatePicker, PersonSelector, Select, TextArea, TextField, TimePicker, TimezonePicker

public interface TooltipableElement
extends SplittableElement

Interface to add tooltip to elements Simply implement it into the element when you want to add tooltip support Beware: If the element implementing this interface overrides Element.buildAttribute(org.symphonyoss.symphony.messageml.MessageMLParser, org.w3c.dom.Node) and/or Element.asPresentationML(XmlPrintStream out, MessageMLContext context) without calling super, it is needed to manage manually TITLE attribute and SplittableElement.splittableAsPresentationML(XmlPrintStream out, MessageMLContext context) method

Author:

enrico.molino (24/06/2020)

Field Summary

Fields

Modifier and Type	Field	Description
static String	DATA_TARGET_ID
static String	DATA_TITLE
static String	TITLE
static String	TOOLTIP_CLASS
static int	TOOLTIP_MAX_LENGTH
static String	TOOLTIP_TOO_LONG_ERR
static String	TOOLTIPABLE_PRESENTATIONML

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

PRESENTATIONML_DIV_FLAG

Method Summary

Modifier and Type	Method	Description
default String	getPresentationMLTooltipTag()
default Map<String,String>	getTooltipAttributes(String id)	Used internally, normally you dont need to override the default method
default boolean	isTooltip()
static boolean	isTooltipNode(Node item)	Check if the PresentationML node is a tooltip
default void	validateTooltip()	Validate tooltip max length, if present

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

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

Field Detail

TITLE

static final String TITLE

See Also:

Constant Field Values

DATA_TITLE

static final String DATA_TITLE

See Also:

Constant Field Values

DATA_TARGET_ID

static final String DATA_TARGET_ID

See Also:

Constant Field Values

TOOLTIP_CLASS

static final String TOOLTIP_CLASS

See Also:

Constant Field Values

TOOLTIP_MAX_LENGTH

static final int TOOLTIP_MAX_LENGTH

See Also:

Constant Field Values

TOOLTIP_TOO_LONG_ERR

static final String TOOLTIP_TOO_LONG_ERR

See Also:

Constant Field Values

TOOLTIPABLE_PRESENTATIONML

static final String TOOLTIPABLE_PRESENTATIONML

See Also:

Constant Field Values

Method Detail

getPresentationMLTooltipTag

default String getPresentationMLTooltipTag()

Returns:

label tag. Normally you dont need to override the default method

getTooltipAttributes

default Map<String,String> getTooltipAttributes(String id)

Used internally, normally you dont need to override the default method

Parameters:

id - used to generate the unique element id

Returns:

isTooltip

default boolean isTooltip()

Returns:

true if tooltip exists Normally, you dont need to override the default method

isTooltipNode

static boolean isTooltipNode(Node item)

Check if the PresentationML node is a tooltip

validateTooltip

default void validateTooltip()
                      throws InvalidInputException

Validate tooltip max length, if present

Throws:

InvalidInputException