org.biouno.unochoice

Interface CascadableParameter<T>

All Superinterfaces:

ScriptableParameter<T>, UnoChoiceParameter

All Known Implementing Classes:

AbstractCascadableParameter, CascadeChoiceParameter, DynamicReferenceParameter

public interface CascadableParameter<T>
extends ScriptableParameter<T>

A parameter that monitors other referenced parameters. When any of these parameters change, this parameter gets updated. It has a map with the current parameters that can be retrieved by the UI to render the most updated view, based on the state of the referenced parameters.

Since:

0.20

Author:

Bruno P. Kinoshita

Method Summary

Modifier and Type	Method and Description
void	doUpdate(String parameters) Exposed to the UI.
List<Object>	getChoicesForUI() Evaluates a script and returns its result as a Map.
String	getReferencedParameters() Gets the list of referenced parameters.

Methods inherited from interface org.biouno.unochoice.ScriptableParameter

getChoices

Method Detail

getReferencedParameters

String getReferencedParameters()

Gets the list of referenced parameters. If any of these parameters change in the UI we will update our current parameters.

Returns:

the referencedParameters

getChoicesForUI

List<Object> getChoicesForUI()

Evaluates a script and returns its result as a Map. List values are automatically handled and converted to Maps too.

Returns:

script result as Map

doUpdate

void doUpdate(String parameters)

Exposed to the UI. Is triggered every time any of the referenced parameters gets updated.

Parameters:

parameters - Comma separated list of parameters