com.is2t.microej.workbench.std.launch.ext

Class ComboOption

java.lang.Object

com.is2t.microej.workbench.std.launch.ext.JPFExtensionTabNode

com.is2t.microej.workbench.std.launch.ext.PageContent

com.is2t.microej.workbench.std.launch.ext.InputOption

com.is2t.microej.workbench.std.launch.ext.ComboOption

public class ComboOption
extends InputOption

Combo option

The user can choose option value from a list. By default, the property is set with the value of the list. Subclasses may override this behavior (see getValue())

Constructor Summary

Constructors

Constructor and Description
ComboOption(ILabel label, String outputProperty, String[] items) Create an option based on a combo box.
ComboOption(ILabel label, String outputProperty, String[] items, String[] realValues) Create an option based on a combo box.

Method Summary

Modifier and Type	Method and Description
String	getErrorMessage() An option is considered to be valid if: it is not enabled it has no validator it has a validator which returns without errors
String	getSelection() Return null if no item selected
int	getSelectionIndex(String propertyValue) Called when initializing the option.
String	getValue() Get the current value of the option By default, returns the currently selected item message Subclasses may override this method to return an other value (converted from currently selected index for example)
void	setInitialValue(int initialValueIndex)

Methods inherited from class com.is2t.microej.workbench.std.launch.ext.InputOption

addOptionChangedListener, getConfigurationAttributeName, getOutputProperty, getProperty, setOptionValidator

Methods inherited from class com.is2t.microej.workbench.std.launch.ext.JPFExtensionTabNode

isEnabled, setDescription, setEnableCondition

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ComboOption

public ComboOption(ILabel label,
                   String outputProperty,
                   String[] items)

Create an option based on a combo box. By default, first item of the provided list is selected

Parameters:

items - should not be empty

ComboOption

public ComboOption(ILabel label,
                   String outputProperty,
                   String[] items,
                   String[] realValues)

Create an option based on a combo box. By default, first item of the provided list is selected

Parameters:

items - should not be empty

Method Detail

getErrorMessage

public String getErrorMessage()

Description copied from class: InputOption

An option is considered to be valid if:

• it is not enabled
• it has no validator
• it has a validator which returns without errors

Overrides:

getErrorMessage in class InputOption

Returns:

the error message to display, null if the option is valid.

getSelection

public String getSelection()

Return null if no item selected

getSelectionIndex

public int getSelectionIndex(String propertyValue)

Called when initializing the option. Given the value of the property, return the item index of the current selection the index of the value in items, -1 if the given value does not appear in combo items Subclasses may override this method to give the selection index when registered value is not directly an item

Parameters:

propertyValue - may be null if the value has never been registered (most likely a new launch)

Returns:

-1 if combo should remain unselected

See Also:

getValue()

getValue

public String getValue()

Get the current value of the option By default, returns the currently selected item message Subclasses may override this method to return an other value (converted from currently selected index for example)

setInitialValue

public void setInitialValue(int initialValueIndex)