Package ca.corbett.extras.properties

Class DirectoryProperty

java.lang.Object

ca.corbett.extras.properties.AbstractProperty

ca.corbett.extras.properties.DirectoryProperty

public class DirectoryProperty
extends AbstractProperty

Represents a field that contains a directory name.

Since:

2024-12-30

Author:

scorbo2

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	allowBlank
protected int	columns
protected File	dir

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
DirectoryProperty(String name, String label)
DirectoryProperty(String name, String label, boolean allowBlank)
DirectoryProperty(String name, String label, boolean allowBlank, File dir)

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	getColumns()
File	getDirectory()
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.
DirectoryProperty	setColumns(int columns)
DirectoryProperty	setDirectory(File dir)

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

dir

protected File dir

columns

protected int columns

allowBlank

protected boolean allowBlank

Constructor Details

DirectoryProperty

public DirectoryProperty(String name,
 String label)

DirectoryProperty

public DirectoryProperty(String name,
 String label,
 boolean allowBlank)

DirectoryProperty

public DirectoryProperty(String name,
 String label,
 boolean allowBlank,
 File dir)

Method Details

getDirectory

public File getDirectory()

setDirectory

public DirectoryProperty setDirectory(File dir)

getColumns

public int getColumns()

setColumns

public DirectoryProperty setColumns(int columns)

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.