Package ca.corbett.extras.properties

Class FileProperty

java.lang.Object

ca.corbett.extras.properties.AbstractProperty

ca.corbett.extras.properties.FileProperty

public class FileProperty
extends AbstractProperty

Represents a property field to allow selection of a file. By default, any file (existing or not) will be allowed. You can specify a FileField.SelectionType if you want to allow only existing or only non-existing files, or you can add a FormFieldGenerationListener to intercept the FormField and add your own FieldValidator to it to only allow files with a certain extension or whatever.

Since:

2024-12-08

Author:

scorbo2

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	allowBlank
protected int	columns
protected File	file
protected FileField.SelectionType	selectionType

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
FileProperty(String name, String label)
FileProperty(String name, String label, boolean allowBlank)
FileProperty(String name, String label, boolean allowBlank, File file)
FileProperty(String name, String label, FileField.SelectionType selectionType)
FileProperty(String name, String label, FileField.SelectionType selectionType, boolean allowBlank, File file)
FileProperty(String name, String label, FileField.SelectionType selectionType, File file)
FileProperty(String name, String label, File file)

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	getFile()
FileField.SelectionType	getSelectionType()
boolean	isAllowBlank()
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.
FileProperty	setAllowBlank(boolean allow)
FileProperty	setColumns(int columns)
FileProperty	setFile(File file)
void	setSelectionType(FileField.SelectionType selectionType)

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

Field Details

allowBlank

protected boolean allowBlank

selectionType

protected FileField.SelectionType selectionType

file

protected File file

columns

protected int columns

Constructor Details

FileProperty

public FileProperty(String name,
 String label)

FileProperty

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

FileProperty

public FileProperty(String name,
 String label,
 FileField.SelectionType selectionType)

FileProperty

public FileProperty(String name,
 String label,
 File file)

FileProperty

public FileProperty(String name,
 String label,
 FileField.SelectionType selectionType,
 File file)

FileProperty

public FileProperty(String name,
 String label,
 boolean allowBlank,
 File file)

FileProperty

public FileProperty(String name,
 String label,
 FileField.SelectionType selectionType,
 boolean allowBlank,
 File file)

Method Details

setAllowBlank

public FileProperty setAllowBlank(boolean allow)

isAllowBlank

public boolean isAllowBlank()

getSelectionType

public FileField.SelectionType getSelectionType()

setSelectionType

public void setSelectionType(FileField.SelectionType selectionType)

getFile

public File getFile()

setFile

public FileProperty setFile(File file)

getColumns

public int getColumns()

setColumns

public FileProperty 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.