Package ca.corbett.extras.properties

Class SliderProperty

java.lang.Object

ca.corbett.extras.properties.AbstractProperty

ca.corbett.extras.properties.SliderProperty

public class SliderProperty
extends AbstractProperty

Field Summary

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

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

Constructor Summary

Constructors

Constructor	Description
SliderProperty(String name, String label, int min, int max, int value)

Method Summary

Modifier and Type	Method	Description
protected FormField	generateFormFieldImpl()	Descendant classes must implement this method to generate a FormField associated with this property.
List<Color>	getColorStops()
List<String>	getLabels()
int	getMaxValue()
int	getMinValue()
int	getValue()
boolean	isAllowNumericValueInLabel()
boolean	isShouldExpand()
boolean	isShowValueLabel()
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.
SliderProperty	setColorStops(List<Color> stops)
SliderProperty	setLabels(List<String> labels, boolean alsoShowNumericValueInLabel)
SliderProperty	setMaxValue(int maxValue)
SliderProperty	setMinValue(int minValue)
SliderProperty	setShouldExpand(boolean should)
SliderProperty	setShowValueLabel(boolean showValueLabel)
SliderProperty	setValue(int currentValue)

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

addAllExtraAttributes, addBottomPadding, addFormFieldChangeListener, addFormFieldGenerationListener, addInnerPadding, addLeftPadding, addPadding, addRightPadding, addTopPadding, clearExtraAttribute, clearExtraAttributes, equals, fireFormFieldChangedEvent, fireFormFieldGeneratedEvent, generateFormField, generateFormField, getCategoryName, getExtraAttribute, getFullyQualifiedName, getHelpText, getMarginPadding, getPropertyLabel, getPropertyName, getSubCategoryName, hashCode, isAllowsUserInput, isEnabled, isExposed, isInitiallyEditable, isInitiallyVisible, removeAllFormFieldChangeListeners, removeAllFormFieldGenerationListeners, removeFormFieldChangeListener, removeFormFieldGenerationListener, setAllExtraAttributes, setEnabled, setExposed, setExtraAttribute, setHelpText, setInitiallyEditable, setInitiallyVisible, setPropertyLabel

Methods inherited from class java.lang.Object

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

Constructor Details

SliderProperty

public SliderProperty(String name,
 String label,
 int min,
 int max,
 int value)

Method Details

getMinValue

public int getMinValue()

setMinValue

public SliderProperty setMinValue(int minValue)

getMaxValue

public int getMaxValue()

setMaxValue

public SliderProperty setMaxValue(int maxValue)

getValue

public int getValue()

setValue

public SliderProperty setValue(int currentValue)

isShowValueLabel

public boolean isShowValueLabel()

setShowValueLabel

public SliderProperty setShowValueLabel(boolean showValueLabel)

getColorStops

public List<Color> getColorStops()

getLabels

public List<String> getLabels()

isAllowNumericValueInLabel

public boolean isAllowNumericValueInLabel()

setColorStops

public SliderProperty setColorStops(List<Color> stops)

setLabels

public SliderProperty setLabels(List<String> labels,
 boolean alsoShowNumericValueInLabel)

setShouldExpand

public SliderProperty setShouldExpand(boolean should)

isShouldExpand

public boolean isShouldExpand()

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.