com.swfm.mica.core
Class MiPropertyDescription

java.lang.Object
  com.swfm.mica.core.MiPropertyDescription

All Implemented Interfaces:

java.lang.Cloneable, MiiPropertyTypes, MiiTypes

public class MiPropertyDescription

extends java.lang.Object

implements MiiTypes, MiiPropertyTypes, java.lang.Cloneable

Version:

%I% %G%

Author:

Michael L. Davis

Field Summary

Constructor Summary

MiPropertyDescription(java.lang.String displayName, int type)

MiPropertyDescription(java.lang.String displayName, int type, java.lang.String defaultValue)

MiPropertyDescription(java.lang.String displayName, int type, java.lang.String defaultValue, int geometricType)

MiPropertyDescription(java.lang.String displayName, java.lang.String value)

Method Summary

void	appendPropertyValueRule(MiiValueValidator rule)
java.lang.String	convertDisplayValueToInternalValue(java.lang.String value)
java.lang.String	convertInternalValueToDisplayValue(java.lang.String value)
MiPropertyDescription	copy()
boolean	equals(java.lang.Object otherDesc) A fairly expensive operation.
java.lang.String	generateRandomValue(boolean valid)
java.lang.Object	getAdditionalProperty(java.lang.String name)
MiWidget	getCustomEditor()
java.lang.String	getDefaultValue()
MiiHelpInfo	getDialogHelp()
java.lang.String	getDisplayName()
int	getDisplayPriority()
boolean	getDisplayValuesIgnoreCase()
Strings	getEditingPermissionsClasses()
Strings	getExcludedValues()
int	getGeometricType()
boolean	getIgnoreCase()
double	getMaximumValue()
boolean	getMaximumValueIsSpecified()
double	getMinimumValue()
boolean	getMinimumValueIsSpecified()
java.lang.String	getName()
java.lang.String	getNameOfAdditionalProperty(int index)
int	getNumberOfAdditionalProperties()
int	getNumberOfPropertyValidationRules()
int	getNumberOfValidValues()
MiiValueValidator	getPropertyValueRule(int index)
MiiHelpInfo	getStatusHelp()
double	getStepValue()
boolean	getStepValueIsSpecified()
MiiHelpInfo	getToolHintHelp()
int	getType()
MiiUnits	getUnits()
Strings	getValidDisplayValues()
Strings	getValidValues()
boolean	getValidValuesAreSpecialCasesOnly()
boolean	getValidValuesAreSuggestionsOnly()
Strings	getViewingPermissionsClasses()
int	hashCode()
void	insertPropertyValueRule(MiiValueValidator rule, int index)
boolean	isEditable(java.lang.String usersPermissionsClass)
boolean	isRequired()
boolean	isViewable(java.lang.String usersPermissionsClass)
void	removePropertyValueRule(MiiValueValidator rule)
void	setAdditionalProperty(java.lang.String name, java.lang.Object value)
void	setCustomEditor(MiWidget widget)
void	setDefaultValue(java.lang.String value)
void	setDialogHelp(MiiHelpInfo help)
void	setDialogHelpMessage(java.lang.String msg)
void	setDisplayName(java.lang.String name)
void	setDisplayPriority(int priority)
void	setDisplayValuesIgnoreCase(boolean flag)
MiPropertyDescription	setEditable(boolean flag)
void	setEditingPermissionsClasses(Strings names)
void	setExcludedValues(Strings excludedValues)
void	setGeometricType(int type)
void	setIgnoreCase(boolean flag)
MiPropertyDescription	setMaximumValue(double value)
MiPropertyDescription	setMinimumValue(double value)
void	setName(java.lang.String n)
void	setRequired(boolean flag)
void	setStatusHelp(MiiHelpInfo help)
void	setStatusHelpMessage(java.lang.String msg)
MiPropertyDescription	setStepValue(double value)
void	setToolHintHelp(MiiHelpInfo help)
void	setToolHintMessage(java.lang.String msg)
void	setType(int type)
void	setUnits(MiiUnits units)
void	setValidDisplayValues(Strings validDisplayValues)
void	setValidValues(Strings validValues)
void	setValidValuesAreSpecialCasesOnly(boolean flag) Specifies whether specified valid values are just commonly used values possibly violating the overall constraints of values for the property.
void	setValidValuesAreSuggestionsOnly(boolean flag) Specifies whether specified valid values are just commonly used values within the overall constraints of values for the property.
MiPropertyDescription	setViewable(boolean flag)
void	setViewingPermissionsClasses(Strings names)
java.lang.String	toString()
MiValueValidationError	validateValue(java.lang.String value)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MiPropertyDescription

public MiPropertyDescription(java.lang.String displayName,
                             int type)

MiPropertyDescription

public MiPropertyDescription(java.lang.String displayName,
                             int type,
                             java.lang.String defaultValue)

MiPropertyDescription

public MiPropertyDescription(java.lang.String displayName,
                             int type,
                             java.lang.String defaultValue,
                             int geometricType)

MiPropertyDescription

public MiPropertyDescription(java.lang.String displayName,
                             java.lang.String value)

Method Detail

setType

public void setType(int type)

getType

public int getType()

setGeometricType

public void setGeometricType(int type)

getGeometricType

public int getGeometricType()

setName

public void setName(java.lang.String n)

getName

public java.lang.String getName()

setDisplayName

public void setDisplayName(java.lang.String name)

getDisplayName

public java.lang.String getDisplayName()

setMinimumValue

public MiPropertyDescription setMinimumValue(double value)

getMinimumValue

public double getMinimumValue()

getMinimumValueIsSpecified

public boolean getMinimumValueIsSpecified()

setMaximumValue

public MiPropertyDescription setMaximumValue(double value)

getMaximumValue

public double getMaximumValue()

getMaximumValueIsSpecified

public boolean getMaximumValueIsSpecified()

setStepValue

public MiPropertyDescription setStepValue(double value)

getStepValue

public double getStepValue()

getStepValueIsSpecified

public boolean getStepValueIsSpecified()

setDefaultValue

public void setDefaultValue(java.lang.String value)

getDefaultValue

public java.lang.String getDefaultValue()

setIgnoreCase

public void setIgnoreCase(boolean flag)

getIgnoreCase

public boolean getIgnoreCase()

setDisplayValuesIgnoreCase

public void setDisplayValuesIgnoreCase(boolean flag)

getDisplayValuesIgnoreCase

public boolean getDisplayValuesIgnoreCase()

setValidValuesAreSuggestionsOnly

public void setValidValuesAreSuggestionsOnly(boolean flag)

Specifies whether specified valid values are just commonly used values within the overall constraints of values for the property. False is the default. The corresponding widget would be a editable combobox with the valid values pre-populated.

Parameters:

flag - true if suggestions

See Also:

setValidValues(Strings), setValidValuesAreSpecialCasesOnly(boolean)

getValidValuesAreSuggestionsOnly

public boolean getValidValuesAreSuggestionsOnly()

setValidValuesAreSpecialCasesOnly

public void setValidValuesAreSpecialCasesOnly(boolean flag)

Specifies whether specified valid values are just commonly used values possibly violating the overall constraints of values for the property. False is the default. The corresponding widget would be a editable combobox with the valid values pre-populated.

Parameters:

flag - true if special cases

See Also:

setValidValues(Strings), setValidValuesAreSuggestionsOnly(boolean)

getValidValuesAreSpecialCasesOnly

public boolean getValidValuesAreSpecialCasesOnly()

setCustomEditor

public void setCustomEditor(MiWidget widget)

getCustomEditor

public MiWidget getCustomEditor()

appendPropertyValueRule

public void appendPropertyValueRule(MiiValueValidator rule)

insertPropertyValueRule

public void insertPropertyValueRule(MiiValueValidator rule,
                                    int index)

removePropertyValueRule

public void removePropertyValueRule(MiiValueValidator rule)

getNumberOfPropertyValidationRules

public int getNumberOfPropertyValidationRules()

getPropertyValueRule

public MiiValueValidator getPropertyValueRule(int index)

setUnits

public void setUnits(MiiUnits units)

getUnits

public MiiUnits getUnits()

setRequired

public void setRequired(boolean flag)

isRequired

public boolean isRequired()

setViewable

public MiPropertyDescription setViewable(boolean flag)

isViewable

public boolean isViewable(java.lang.String usersPermissionsClass)

setEditable

public MiPropertyDescription setEditable(boolean flag)

isEditable

public boolean isEditable(java.lang.String usersPermissionsClass)

setDisplayPriority

public void setDisplayPriority(int priority)

getDisplayPriority

public int getDisplayPriority()

setEditingPermissionsClasses

public void setEditingPermissionsClasses(Strings names)

getEditingPermissionsClasses

public Strings getEditingPermissionsClasses()

setViewingPermissionsClasses

public void setViewingPermissionsClasses(Strings names)

getViewingPermissionsClasses

public Strings getViewingPermissionsClasses()

setToolHintHelp

public void setToolHintHelp(MiiHelpInfo help)

getToolHintHelp

public MiiHelpInfo getToolHintHelp()

setToolHintMessage

public void setToolHintMessage(java.lang.String msg)

setStatusHelp

public void setStatusHelp(MiiHelpInfo help)

setStatusHelpMessage

public void setStatusHelpMessage(java.lang.String msg)

getStatusHelp

public MiiHelpInfo getStatusHelp()

setDialogHelp

public void setDialogHelp(MiiHelpInfo help)

setDialogHelpMessage

public void setDialogHelpMessage(java.lang.String msg)

getDialogHelp

public MiiHelpInfo getDialogHelp()

setAdditionalProperty

public void setAdditionalProperty(java.lang.String name,
                                  java.lang.Object value)

getNumberOfAdditionalProperties

public int getNumberOfAdditionalProperties()

getNameOfAdditionalProperty

public java.lang.String getNameOfAdditionalProperty(int index)

getAdditionalProperty

public java.lang.Object getAdditionalProperty(java.lang.String name)

validateValue

public MiValueValidationError validateValue(java.lang.String value)

getNumberOfValidValues

public int getNumberOfValidValues()

setValidValues

public void setValidValues(Strings validValues)

getValidValues

public Strings getValidValues()

setValidDisplayValues

public void setValidDisplayValues(Strings validDisplayValues)

getValidDisplayValues

public Strings getValidDisplayValues()

getExcludedValues

public Strings getExcludedValues()

setExcludedValues

public void setExcludedValues(Strings excludedValues)

convertInternalValueToDisplayValue

public java.lang.String convertInternalValueToDisplayValue(java.lang.String value)

convertDisplayValueToInternalValue

public java.lang.String convertDisplayValueToInternalValue(java.lang.String value)

toString

public java.lang.String toString()

generateRandomValue

public java.lang.String generateRandomValue(boolean valid)

hashCode

public int hashCode()

equals

public boolean equals(java.lang.Object otherDesc)

A fairly expensive operation.

copy

public MiPropertyDescription copy()