com.bristle.javalib.ui
Class PropertyDisplayData

java.lang.Object
  com.bristle.javalib.ui.PropertyDisplayData

public class PropertyDisplayData
extends Object

This class carries the display data about one property of a displayable object.

Usage:
   - See ObjectDisplayDataMap for typical usage.

Assumptions:
Effects:
       - None.
Anticipated Changes:
Notes:
Implementation Notes:
Portability Issues:
Revision History:
   $Log$

Field Summary

static boolean	blnREADONLY
static boolean	blnREQUIRED

Constructor Summary

PropertyDisplayData(String strName, DisplayDataTypeEnum dataType, String strDataTypeMessage, boolean blnRequired, String strRequiredMessage, boolean blnReadOnly, String strReadOnlyMessage, String strPrompt, int intMinDisplayLength, int intMaxLength, String strMaxLengthMessage, String strDisallowedChars, String strDisallowedCharsMessage, float fltMinValue, String strMinValueMessage, float fltMaxValue, String strMaxValueMessage)
Constructor (the only way to set the values).

Method Summary

DisplayDataTypeEnum	getDataType() Get the data type.
String	getDataTypeMessage() Get the message to show a user if the value of the property has the wrong data type.
String	getDisallowedChars() Get the disallowed chars.
String	getDisallowedCharsMessage() Get the message to show a user if the value of the property contains disallowed chars.
int	getMaxLength() Get the max length.
String	getMaxLengthMessage() Get the message to show a user if the value of the property is too long.
float	getMaxValue() Get the max value.
String	getMaxValueMessage() Get the message to show a user if the value of the property is more than the max.
int	getMinDisplayLength() Get the min display length.
float	getMinValue() Get the min value.
String	getMinValueMessage() Get the message to show a user if the value of the property is less than the min.
String	getName() Get the name.
String	getPrompt() Get the prompt.
String	getReadOnlyMessage() Get the message to show a user if the readonly value of the property is changed.
String	getRequiredMessage() Get the message to show a user if the value of the property is empty.
boolean	isReadOnly() Get the readonly flag.
boolean	isRequired() Get the required flag.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

blnREQUIRED

public static final boolean blnREQUIRED

See Also:

Constant Field Values

blnREADONLY

public static final boolean blnREADONLY

See Also:

Constant Field Values

Constructor Detail

PropertyDisplayData

public PropertyDisplayData(String strName,
                           DisplayDataTypeEnum dataType,
                           String strDataTypeMessage,
                           boolean blnRequired,
                           String strRequiredMessage,
                           boolean blnReadOnly,
                           String strReadOnlyMessage,
                           String strPrompt,
                           int intMinDisplayLength,
                           int intMaxLength,
                           String strMaxLengthMessage,
                           String strDisallowedChars,
                           String strDisallowedCharsMessage,
                           float fltMinValue,
                           String strMinValueMessage,
                           float fltMaxValue,
                           String strMaxValueMessage)

Constructor (the only way to set the values).

Parameters:

strName - The name of the property.

dataType - The data type of the property.

strDataTypeMessage - The message to show a user if the value of the property has the wrong data type.

blnRequired - Is the property required to have a value?

strRequiredMessage - The message to show a user if the value of the property is empty.

blnReadOnly - Is the property readonly?

strReadOnlyMessage - The message to show a user if the readonly value of the property is changed.

strPrompt - The prompt to show the user for this property.

intMinDisplayLength - The min length to show the user in a table or any place where space is at a premium.

intMaxLength - The max char length to let the user enter.

strMaxLengthMessage - The message to show a user if the value of the property is too long.

strDisallowedChars - Chars to prevent the user from entering as part of the value.

strDisallowedCharsMessage - The message to show a user if the value of the property contains disallowed chars.

fltMinValue - The min allowed value.

strMinValueMessage - The message to show a user if the value of the property is less than the min.

fltMaxValue - The max allowed value.

strMaxValueMessage - The message to show a user if the value of the property is more than the max.

Method Detail

getName

public String getName()

Get the name.

Returns:

The name.

getDataType

public DisplayDataTypeEnum getDataType()

Get the data type.

Returns:

The data type.

getDataTypeMessage

public String getDataTypeMessage()

Get the message to show a user if the value of the property has the wrong data type.

Returns:

The message.

isRequired

public boolean isRequired()

Get the required flag.

Returns:

The required flag.

getRequiredMessage

public String getRequiredMessage()

Get the message to show a user if the value of the property is empty.

Returns:

The message.

isReadOnly

public boolean isReadOnly()

Get the readonly flag.

Returns:

The readonly flag.

getReadOnlyMessage

public String getReadOnlyMessage()

Get the message to show a user if the readonly value of the property is changed.

getPrompt

public String getPrompt()

Get the prompt.

Returns:

The prompt.

getMinDisplayLength

public int getMinDisplayLength()

Get the min display length.

Returns:

The min display length.

getMaxLength

public int getMaxLength()

Get the max length.

Returns:

The max length.

getMaxLengthMessage

public String getMaxLengthMessage()

Get the message to show a user if the value of the property is too long.

Returns:

The message.

getDisallowedChars

public String getDisallowedChars()

Get the disallowed chars.

Returns:

The disallowed chars.

getDisallowedCharsMessage

public String getDisallowedCharsMessage()

Get the message to show a user if the value of the property contains disallowed chars.

Returns:

The message.

getMinValue

public float getMinValue()

Get the min value.

Returns:

The min value.

getMinValueMessage

public String getMinValueMessage()

Get the message to show a user if the value of the property is less than the min.

Returns:

The message.

getMaxValue

public float getMaxValue()

Get the max value.

Returns:

The max value.

getMaxValueMessage

public String getMaxValueMessage()

Get the message to show a user if the value of the property is more than the max.

Returns:

The message.