byucc.jhdl.apps.util
Interface PropertiesDialogComponent

public interface PropertiesDialogComponent

Helper interface to pass around information on properties. This interface is used to support the PropertiesDialog class. Classes may create PropertiesDialogComponents and hang on to them for use when a PropertiesDialog is to be shown.

Author:

Anthony L. Slade

Method Summary

java.lang.String[]	getDefaultChoices() This method is only used if the property type is TYPE_MULTIPLE_CHOICE.
java.lang.String	getDefaultValue() If the property hasn't been set yet, then this method is used to get a value to initialize it.
java.lang.String	getPropertyIdentifier()
java.lang.String	getPropertyInformation()
java.lang.String	getPropertyName()
int	getPropertyType() The type of the property.

Method Detail

getPropertyIdentifier

public java.lang.String getPropertyIdentifier()

Returns:

the identifier of the property for this component. This should be a unique identifier of a property that is stored in the byucc.jhdl.apps.util.Properties class.

getPropertyName

public java.lang.String getPropertyName()

Returns:

the name of the property for this component. This will be the name of the property displayed in the PropertiesDialog. It can be a short description of the property.

getPropertyType

public int getPropertyType()

The type of the property. This should be one of TYPE_STRING, TYPE_BOOLEAN, TYPE_INTEGER, TYPE_DOUBLE, or TYPE_MULTIPLE_CHOICE from the byucc.jhdl.apps.util.Properties class.

getPropertyInformation

public java.lang.String getPropertyInformation()

Returns:

a description of what this property is used for. This will be the text displayed in a JOptionPane that shows help information for this particular property.

getDefaultValue

public java.lang.String getDefaultValue()

If the property hasn't been set yet, then this method is used to get a value to initialize it.

getDefaultChoices

public java.lang.String[] getDefaultChoices()

This method is only used if the property type is TYPE_MULTIPLE_CHOICE. The returned list will be used to set up the property if, and only if, the property hasn't been set yet.

Returns:

the list of choices for the multiple choice property. If the property type is not TYPE_MULTIPLE_CHOICE, then this method may simply return null, as it won't be used.