com.solibri.smc.api.ui

Interface UIRadioButtonPanel

All Superinterfaces:

UIComponent, UIRuleParameter

All Known Subinterfaces:

UIRadioButtonPanelHorizontal, UIRadioButtonPanelVertical

public interface UIRadioButtonPanel
extends UIRuleParameter

Interface that defines a radio button panel in the UI. A radio button panel contains a radio button (an option) for each value defined in the given EnumerationParameter. For example, if the given parameter defines 3 options, then the radio button panel will contain 3 radio buttons.

Since:

9.10.2

Method Summary

Modifier and Type	Method and Description
void	addOptionImages(List<UIImage> images) Add images that are added to the radio buttons.
static UIRadioButtonPanel	create(EnumerationParameter ruleParameter) Returns a UI radio button panel with the given rule parameter.
List<UIImage>	getOptionImages() Returns the images attached to the options in this radio button panel.

Methods inherited from interface com.solibri.smc.api.ui.UIRuleParameter

create, getRuleParameter

Methods inherited from interface com.solibri.smc.api.ui.UIComponent

getEnabler, setEnabler

Method Detail

create

static UIRadioButtonPanel create(EnumerationParameter ruleParameter)

Returns a UI radio button panel with the given rule parameter.

Parameters:

ruleParameter - the rule parameter

Returns:

a UI radio button panel with the given rule parameter

Since:

9.10.2

addOptionImages

void addOptionImages(List<UIImage> images)

Add images that are added to the radio buttons. There should be the same number of images in the list as there are values in the EnumerationParameter for which the radio buttons are created. The order of the images defines to which radio button they are attached: the first image is attached to the first radio button and so on.

Parameters:

images - list of images that are placed in the radio button panel along the radio button options

Since:

9.10.2

getOptionImages

List<UIImage> getOptionImages()

Returns the images attached to the options in this radio button panel.

Returns:

the images attached to the options in this radio button panel

Since:

9.10.2