Package net.pricefx.server.dto.calculation

Interface ResultHighchart.ContextMenuItem

Enclosing class:

ResultHighchart

public static interface ResultHighchart.ContextMenuItem

An item of the context menu. Get it from ResultHighchart.ContextMenu.addMenuItem().

Set the label, the order and the Context Linking definition of the item, then call back().

Since:

14.0 - Caribou Lou

Method Summary

Modifier and Type	Method	Description
ResultHighchart.ContextMenu	back()	Returns to the context menu.
ResultHighchart.ContextMenuItem	setContextLinking(Map<String,?> linkProperties)	Define all the Context Linking properties, such as targetPage or targetPageAction.
default ResultHighchart.ContextMenuItem	setLabel(String label)	Convenience method to set the menu item's label without any translation options.
ResultHighchart.ContextMenuItem	setLabelTranslations(Map<String,String> labelTranslations)	Set the item's label in multiple languages so the UI will show the one appropriate for the current user.
ResultHighchart.ContextMenuItem	setOrder(int order)	Set the position of the menu item inside the menu explicitly.

Method Details

setLabel

default ResultHighchart.ContextMenuItem setLabel(String label)

Convenience method to set the menu item's label without any translation options.

Parameters:

label - the label of the menu item

Returns:

self - the ResultHighchart.ContextMenuItem instance, for convenience

See Also:

• for setting language specific labels

setLabelTranslations

ResultHighchart.ContextMenuItem setLabelTranslations(Map<String,String> labelTranslations)

Set the item's label in multiple languages so the UI will show the one appropriate for the current user.

Parameters:

labelTranslations - the label of the menu item, referenced by language (e.g. "en", "de", or "" as default)

Returns:

self - the ResultHighchart.ContextMenuItem instance, for convenience

setOrder

ResultHighchart.ContextMenuItem setOrder(int order)

Set the position of the menu item inside the menu explicitly.
Notes:

• there is no validation, make sure to use unique orderIds starting with 1 and no gaps to not confuse the Front End.
• the menu item with order=1 will still be displayed only after the drilldown item, if a drilldown was defined

Parameters:

order - starting at 1

Returns:

self - the ResultHighchart.ContextMenuItem instance, for convenience

Throws:

IllegalArgumentException - if order is less than 1

setContextLinking

ResultHighchart.ContextMenuItem setContextLinking(Map<String,?> linkProperties)

Define all the Context Linking properties, such as targetPage or targetPageAction. There are many options, which may differ according to the desired targetPage. To find out more, please refer to this Knowledge Base page

Parameters:

linkProperties - the Context Linking definition

Returns:

self - the ResultHighchart.ContextMenuItem instance, for convenience

back

ResultHighchart.ContextMenu back()

Returns to the context menu.

Returns:

the ResultHighchart.ContextMenu instance, for convenience

Throws:

IllegalArgumentException - if the label, the order, or the Context Linking definition of the item is not set