Package ca.corbett.extras.properties

Class ComboProperty<T>

java.lang.Object

ca.corbett.extras.properties.AbstractProperty

ca.corbett.extras.properties.ComboProperty<T>

public class ComboProperty<T>
extends AbstractProperty

Represents a single-select chooser field that allows selection from a list of items.

Since:

sc-util 1.8

Author:

scorbett

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	isEditable
protected final List<T>	items
protected int	selectedIndex

Fields inherited from class ca.corbett.extras.properties.AbstractProperty

categoryName, DEFAULT_CATEGORY, DEFAULT_PROPERTY_NAME, extraAttributes, fullyQualifiedName, helpText, isEnabled, isExposed, isInitiallyEditable, isInitiallyVisible, propertyLabel, propertyName, subCategoryName

Constructor Summary

Constructors

Constructor	Description
ComboProperty(String name, String label, List<T> items, int selectedIndex, boolean isEditable)

Method Summary

Modifier and Type	Method	Description
protected FormField	generateFormFieldImpl()	Descendant classes must implement this method to generate a FormField associated with this property.
int	getSelectedIndex()
T	getSelectedItem()
int	indexOf(T item)
int	indexOfString(String item)
boolean	isEditable()
void	loadFromFormField(FormField field)	Populates this Property's value(s) from the given form field, assuming the field is of the correct type.
void	loadFromProps(Properties props)	Loads the value(s) for this property from the given Properties instance, overwriting any current value.
void	saveToProps(Properties props)	Saves the current value(s) of this property to the given Properties instance.
ComboProperty<T>	setSelectedIndex(int index)
ComboProperty<T>	setSelectedItem(T item)

Methods inherited from class ca.corbett.extras.properties.AbstractProperty

addAllExtraAttributes, addFormFieldChangeListener, clearExtraAttribute, clearExtraAttributes, equals, fireFormFieldChangedEvent, generateFormField, generateFormField, getCategoryName, getExtraAttribute, getFullyQualifiedName, getHelpText, getPropertyLabel, getPropertyName, getSubCategoryName, hashCode, isEnabled, isExposed, isInitiallyEditable, isInitiallyVisible, removeAllListeners, removeFormFieldChangeListener, setAllExtraAttributes, setEnabled, setExposed, setExtraAttribute, setHelpText, setInitiallyEditable, setInitiallyVisible, setPropertyLabel

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

items

protected final List<T> items

selectedIndex

protected int selectedIndex

isEditable

protected boolean isEditable

Constructor Details

ComboProperty

public ComboProperty(String name,
 String label,
 List<T> items,
 int selectedIndex,
 boolean isEditable)

Method Details

setSelectedIndex

public ComboProperty<T> setSelectedIndex(int index)

getSelectedIndex

public int getSelectedIndex()

setSelectedItem

public ComboProperty<T> setSelectedItem(T item)

indexOf

public int indexOf(T item)

indexOfString

public int indexOfString(String item)

getSelectedItem

public T getSelectedItem()

isEditable

public boolean isEditable()

saveToProps

public void saveToProps(Properties props)

Description copied from class: AbstractProperty

Saves the current value(s) of this property to the given Properties instance.

Specified by:

saveToProps in class AbstractProperty

Parameters:

props - Any Properties instance which will receive the value(s) of this property.

loadFromProps

public void loadFromProps(Properties props)

Description copied from class: AbstractProperty

Loads the value(s) for this property from the given Properties instance, overwriting any current value. The current value of this property will be used as a default value in the event that this property does not exist in the given Properties instance.

Specified by:

loadFromProps in class AbstractProperty

Parameters:

props - Any Properties instance which contains value(s) for this property.

generateFormFieldImpl

protected FormField generateFormFieldImpl()

Description copied from class: AbstractProperty

Descendant classes must implement this method to generate a FormField associated with this property. The generateFormField() method in this class will call this abstract method to create the FormField, which will then be augmented with our fully qualified name, read-only state, help text, and extra attributes.

Specified by:

generateFormFieldImpl in class AbstractProperty

Returns:

A FormField associated with this property.

loadFromFormField

public void loadFromFormField(FormField field)

Description copied from class: AbstractProperty

Populates this Property's value(s) from the given form field, assuming the field is of the correct type.

Specified by:

loadFromFormField in class AbstractProperty

Parameters:

field - The FormField containing a value for this property.