Package ca.corbett.extras.properties

Class LongTextProperty

java.lang.Object

ca.corbett.extras.properties.AbstractProperty

ca.corbett.extras.properties.LongTextProperty

public class LongTextProperty
extends AbstractProperty

Represents a property that can store a long text (multi-line) value. The options for creating a LongTextProperty exactly match those for containing a LongTextField, as that is the underlying FormField for this property type.

Since:

sc-util 1.8

Author:

scorbett

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	allowBlank
protected boolean	allowPopoutEditing
protected int	height
protected LongTextField.TextFieldType	textFieldType
protected String	value
protected int	width

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

Modifier	Constructor	Description
protected	LongTextProperty(String name, String label, LongTextField.TextFieldType fieldType, int x, int y)	Invoked internally by the static factory methods.

Method Summary

Modifier and Type	Method	Description
protected FormField	generateFormFieldImpl()	Descendant classes must implement this method to generate a FormField associated with this property.
String	getValue()
boolean	isAllowBlank()
boolean	isAllowPopoutEditing()
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.
static LongTextProperty	ofDynamicSizingMultiLine(String name, String label)	Creates a multi-line TextField which will automatically expand to fill the width of whatever FormPanel it is added to.
static LongTextProperty	ofFixedPixelSizeMultiLine(String name, String label, int width, int height)	Creates a TextProperty with the specified pixel dimensions.
static LongTextProperty	ofFixedSizeMultiLine(String name, String label, int rows, int cols)	Creates a TextProperty with the specified number of rows and columns.
void	saveToProps(Properties props)	Saves the current value(s) of this property to the given Properties instance.
LongTextProperty	setAllowBlank(boolean allow)
LongTextProperty	setAllowPopoutEditing(boolean allow)
LongTextProperty	setValue(String value)

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

value

protected String value

textFieldType

protected LongTextField.TextFieldType textFieldType

width

protected int width

height

protected int height

allowBlank

protected boolean allowBlank

allowPopoutEditing

protected boolean allowPopoutEditing

Constructor Details

LongTextProperty

protected LongTextProperty(String name,
 String label,
 LongTextField.TextFieldType fieldType,
 int x,
 int y)

Invoked internally by the static factory methods.

Method Details

ofFixedSizeMultiLine

public static LongTextProperty ofFixedSizeMultiLine(String name,
 String label,
 int rows,
 int cols)

Creates a TextProperty with the specified number of rows and columns. If rows is 1, a single-line TextField is created. Otherwise, a multi-line TextField is created.

ofFixedPixelSizeMultiLine

public static LongTextProperty ofFixedPixelSizeMultiLine(String name,
 String label,
 int width,
 int height)

Creates a TextProperty with the specified pixel dimensions. Generally, you should avoid specifying pixel dimensions for UI components, as it doesn't scale well with font size changes or Look and Feel changes.

ofDynamicSizingMultiLine

public static LongTextProperty ofDynamicSizingMultiLine(String name,
 String label)

Creates a multi-line TextField which will automatically expand to fill the width of whatever FormPanel it is added to.

getValue

public String getValue()

setValue

public LongTextProperty setValue(String value)

setAllowBlank

public LongTextProperty setAllowBlank(boolean allow)

isAllowBlank

public boolean isAllowBlank()

setAllowPopoutEditing

public LongTextProperty setAllowPopoutEditing(boolean allow)

isAllowPopoutEditing

public boolean isAllowPopoutEditing()

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.