com.sas.prompts.definitions
Class ColorDefinition

com.sas.prompts.definitions.ColorDefinition

All Implemented Interfaces:

com.sas.models.VersionInterface, com.sas.prompts.definitions.ColorDefinitionInterface, com.sas.prompts.definitions.ColorDefinitionV2Interface, com.sas.prompts.definitions.HintableDefinitionInterface, com.sas.prompts.definitions.HintableDefinitionV2Interface, com.sas.prompts.definitions.MutableColorDefinitionInterface, com.sas.prompts.definitions.MutableColorDefinitionV2Interface, com.sas.prompts.definitions.MutableHintableDefinitionInterface, com.sas.prompts.definitions.MutableHintableDefinitionV2Interface, com.sas.prompts.definitions.MutablePromptDefinitionInterface, com.sas.prompts.definitions.MutablePromptDefinitionV2Interface, com.sas.prompts.definitions.MutablePromptDefinitionV3Interface, MutableRequiredDefinitionInterface, PromptDefinitionInterface, com.sas.prompts.definitions.PromptDefinitionV2Interface, com.sas.prompts.definitions.PromptDefinitionV3Interface, com.sas.prompts.IdentifiablePromptInterface, com.sas.prompts.MutableIdentifiablePromptInterface, com.sas.prompts.MutablePromptHelpInterface, com.sas.prompts.PromptHelpInterface, com.sas.PublicClonable, com.sas.storage.editableproperties.LocalizableProperties, com.sas.storage.editableproperties.MultiLocaleProperties, com.sas.uiconfig.ContextEnabledObject, com.sas.util.AttributeConfigurationInterface, com.sas.util.AttributeDescription, com.sas.util.macrovar.MacroVariableOptionInterface, com.sas.util.macrovar.MutableMacroVariableOptionInterface, com.sas.util.ResourceReferencesInterface, com.sas.util.xmlpersist.PersistenceInterface, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable

@SASScope(value="ALL")
public class ColorDefinition
implements com.sas.prompts.definitions.MutableColorDefinitionV2Interface

ColorDefinition is a prompt type which allows the specification of one color value.

See Also:

Serialized Form

Field Summary

static java.lang.String

RB_KEY

Fields inherited from interface com.sas.prompts.definitions.PromptDefinitionInterface

PROMPT_VALIDATION_ERROR_ABOVE_MAXIMUM, PROMPT_VALIDATION_ERROR_ABOVE_MAXIMUM_DECIMAL_PLACES, PROMPT_VALIDATION_ERROR_ABOVE_MAXIMUM_LENGTH, PROMPT_VALIDATION_ERROR_ABOVE_MAXIMUM_LINES, PROMPT_VALIDATION_ERROR_ABOVE_MAXIMUM_VALUE_COUNT, PROMPT_VALIDATION_ERROR_BELOW_MINIMUM, PROMPT_VALIDATION_ERROR_BELOW_MINIMUM_LENGTH, PROMPT_VALIDATION_ERROR_BELOW_MINIMUM_VALUE_COUNT, PROMPT_VALIDATION_ERROR_DATA_SOURCE_COLUMN_TYPE_NOT_ALLOWED, PROMPT_VALIDATION_ERROR_DATA_SOURCE_CONTAINS_NO_DATA_ITEMS, PROMPT_VALIDATION_ERROR_DATA_SOURCE_NOT_AVAILABLE, PROMPT_VALIDATION_ERROR_DATA_SOURCE_TYPE_NOT_ALLOWED, PROMPT_VALIDATION_ERROR_EMPTY_STATIC_LIST_AND_REQUIRED_WITH_NO_ADDITIONAL_VALUES_ALLOWED, PROMPT_VALIDATION_ERROR_ERROR_LOADING_SHARED_PROMPT, PROMPT_VALIDATION_ERROR_FILE_TYPE_NOT_ALLOWED, PROMPT_VALIDATION_ERROR_FROM_SCRIPT, PROMPT_VALIDATION_ERROR_INCORRECT_RELATIVE_DATE_VALUE, PROMPT_VALIDATION_ERROR_INPUT_DOES_NOT_MATCH_PATTERN, PROMPT_VALIDATION_ERROR_INVALID_INPUT_PATTERN, PROMPT_VALIDATION_ERROR_LOWER_RANGE_VALUE_ABOVE_MAXIMUM, PROMPT_VALIDATION_ERROR_LOWER_RANGE_VALUE_ABOVE_MAXIMUM_LENGTH, PROMPT_VALIDATION_ERROR_LOWER_RANGE_VALUE_ABOVE_UPPER_RANGE_VALUE, PROMPT_VALIDATION_ERROR_LOWER_RANGE_VALUE_BELOW_MINIMUM, PROMPT_VALIDATION_ERROR_LOWER_RANGE_VALUE_BELOW_MINIMUM_LENGTH, PROMPT_VALIDATION_ERROR_MASKED_HIDDEN_REQUIRED, PROMPT_VALIDATION_ERROR_MAX_DECIMAL_PLACES_ABOVE_MAX_PERCISION, PROMPT_VALIDATION_ERROR_MAXIMUM_LENGTH_BELOW_ZERO, PROMPT_VALIDATION_ERROR_MIN_DECIMAL_PLACES_ABOVE_MAX_PERCISION, PROMPT_VALIDATION_ERROR_MINIMUM_ABOVE_MAXIMUM, PROMPT_VALIDATION_ERROR_MINIMUM_ABOVE_MAXIMUM_DECIMAL_PLACES, PROMPT_VALIDATION_ERROR_MINIMUM_ABOVE_MAXIMUM_LENGTH, PROMPT_VALIDATION_ERROR_MINIMUM_ABOVE_MAXIMUM_VALUE_COUNT, PROMPT_VALIDATION_ERROR_MINIMUM_LENGTH_ABOVE_MAXIMUM_LENGTH, PROMPT_VALIDATION_ERROR_MINIMUM_LENGTH_BELOW_ZERO, PROMPT_VALIDATION_ERROR_MORE_THAN_ONE_SPECIAL_VALUE_SPECIFIED, PROMPT_VALIDATION_ERROR_MULTIPLE_DATA_SOURCES_NOT_ALLOWED, PROMPT_VALIDATION_ERROR_NO_DATA_SOURCE, PROMPT_VALIDATION_ERROR_NON_EDITABLE_REQUIRED_WITH_NO_DEFAULT_NOT_ALLOWED, PROMPT_VALIDATION_ERROR_NOT_VALID_OBJECT, PROMPT_VALIDATION_ERROR_ONLY_DIRECTORIES_ALLOWED, PROMPT_VALIDATION_ERROR_ONLY_FILES_ALLOWED, PROMPT_VALIDATION_ERROR_PERIOD_ENDS_200_YEARS_AHEAD, PROMPT_VALIDATION_ERROR_PERIOD_STARTS_200_YEARS_AGO, PROMPT_VALIDATION_ERROR_SPECIAL_VALUE_MIXED_WITH_OTHER_VALUES, PROMPT_VALIDATION_ERROR_STATIC_VALUE_INVALID, PROMPT_VALIDATION_ERROR_UPPER_RANGE_VALUE_ABOVE_MAXIMUM, PROMPT_VALIDATION_ERROR_UPPER_RANGE_VALUE_ABOVE_MAXIMUM_LENGTH, PROMPT_VALIDATION_ERROR_UPPER_RANGE_VALUE_BELOW_MINIMUM, PROMPT_VALIDATION_ERROR_UPPER_RANGE_VALUE_BELOW_MINIMUM_LENGTH, PROMPT_VALIDATION_NO_ERRORS

Constructor Summary

ColorDefinition()
Constructor

ColorDefinition(java.lang.String promptName)
Constructor

Method Summary

void	configureAttributes(java.util.Map<java.lang.String,?> options, java.util.Map<java.lang.String,?> context)
void	consumeRelatedObjects(com.sas.util.xmlpersist.RelatedObjectListsHolder roHolder) Persistence method for reading in subtags.
com.sas.storage.valueprovider.ValueProviderInterface	getColorProvider() Returns back ValueProvider to the users of ColorDefinition in case custom colors are set else returns null
com.sas.storage.valueprovider.ValueProviderInterface	getDefaultColorProvider() Returns back a default ColorProvider created from the Swing Color Picker model
com.sas.datatypes.DataTypeInterface	getPromptDataType() Returns an instance of com.sas.datatypes.ColorType that can be used to process values for this prompt.
java.util.Collection<ValidationEntry>	getPromptValueValidationErrors(java.lang.Object value, java.util.Locale locale) Returns a Collection containing the set of ValidationEntry objects or an empty collection if no errors were found.
java.lang.String	getVersion()
boolean	isPromptValueValid(java.lang.Object value, java.util.Locale locale) Returns whether the specified value is valid for the current settings of the color prompt.
boolean	isRequired() Returns whether the user will be required to enter a value for this prompt before continuing in the application
void	setColorProvider(com.sas.storage.valueprovider.ValueProviderInterface colorProvider) Sets the ValueProvider containing custom palette colors.
void	setRequired(boolean required) Sets whether the user will be required to enter a value for this prompt before continuing in the application
java.util.Collection<ValidationEntry>	validateDefinition(java.util.Locale locale) This method is used to validate that the various attributes of the definition all contain valid values.

Methods inherited from class com.sas.prompts.definitions.PromptDefinition

addUserInfo, clearDefaultValue, getApplicationContext, getAttributeDescriptors, getConstraints, getCustomErrorMessage, getCustomErrorMessages, getDefaultValue, getDependentPromptsForAttributes, getHint, getHintPlacement, getHints, getInlineHint, getInlineHints, getLabelPlacement, getLocalizableProperties, getMutableUserInfo, getPromptDescription, getPromptDescriptions, getPromptHelp, getPromptID, getPromptLabel, getPromptLabels, getPromptName, getScript, getScripts, getUIConfiguration, getUserInfo, getUserInfoAsText, isDefaultValueSet, isDisplayDefaultValueAsBlank, isFixed, isHidden, isPromptValueValid, isValueClearedForNonSelectedModalChoiceGroup, removeScript, removeUserInfo, setAdditionalCascadeDependencies, setApplicationContext, setCustomErrorMessage, setCustomErrorMessages, setDefaultValue, setDependentPromptsForAttributes, setDisplayDefaultValueAsBlank, setFixed, setHidden, setHint, setHintPlacement, setHints, setInlineHint, setInlineHints, setLabelPlacement, setLocalizableProperties, setPromptDescription, setPromptDescriptions, setPromptHelp, setPromptLabel, setPromptLabels, setPromptName, setScript, setUIConfiguration, setUserInfo, setValueClearedForNonSelectedModalChoiceGroup, toString

Methods inherited from interface com.sas.prompts.definitions.PromptDefinitionInterface

clearDefaultValue, getDefaultValue, getPromptDescription, getPromptDescriptions, getPromptLabel, getPromptLabels, getPromptName, getUserInfo, isDefaultValueSet, isFixed, isHidden, isPromptValueValid

Methods inherited from interface com.sas.PublicClonable

clone

Field Detail

RB_KEY

public static final java.lang.String RB_KEY

See Also:

Constant Field Values

Constructor Detail

ColorDefinition

public ColorDefinition()

Constructor

ColorDefinition

public ColorDefinition(java.lang.String promptName)

Constructor

Method Detail

isRequired

public boolean isRequired()

Returns whether the user will be required to enter a value for this prompt before continuing in the application

Specified by:

isRequired in interface PromptDefinitionInterface

Specified by:

isRequired in class PromptDefinition

Returns:

whether the user will be required to enter a value for this prompt before continuing in the application

See Also:

PromptDefinitionInterface.isRequired()

setRequired

public void setRequired(boolean required)

Sets whether the user will be required to enter a value for this prompt before continuing in the application

Specified by:

setRequired in interface MutableRequiredDefinitionInterface

Parameters:

required - whether the user will be required to enter a value for this prompt before continuing in the application

isPromptValueValid

public boolean isPromptValueValid(java.lang.Object value,
                                  java.util.Locale locale)

Returns whether the specified value is valid for the current settings of the color prompt. Valid values include java.awt.Color objects, null, and com.sas.MissingValues objects.

Specified by:

isPromptValueValid in interface com.sas.prompts.definitions.PromptDefinitionV2Interface

Overrides:

isPromptValueValid in class PromptDefinition

Returns:

true if the specified value is valid, false if not

See Also:

PromptDefinitionV2Interface.isPromptValueValid(java.lang.Object, java.util.Locale)

getPromptValueValidationErrors

public java.util.Collection<ValidationEntry> getPromptValueValidationErrors(java.lang.Object value,
                                                                            java.util.Locale locale)

Returns a Collection containing the set of ValidationEntry objects or an empty collection if no errors were found.

Specified by:

getPromptValueValidationErrors in interface PromptDefinitionInterface

Overrides:

getPromptValueValidationErrors in class PromptDefinition

Parameters:

value - The value to check for errors

locale - The locale to return the error messages in

Returns:

A Collection containing the set of ValidationEntry objects or an empty collection if no errors were found.

See Also:

PromptDefinitionInterface.getPromptValueValidationErrors(Object, Locale)

validateDefinition

public java.util.Collection<ValidationEntry> validateDefinition(java.util.Locale locale)

This method is used to validate that the various attributes of the definition all contain valid values. If the definition is valid, and empty collection will be returned, otherwise the collection with contain ValidationEntry objects for each error. This method should be called before the definition is to be used. Subclasses should override this method to return the appropriate validation errors.

Specified by:

validateDefinition in interface PromptDefinitionInterface

Overrides:

validateDefinition in class PromptDefinition

Parameters:

locale - Locale

Returns:

A Collection containing the set of ValidationEntry objects or an empty collection if no errors were found.

See Also:

PromptDefinitionInterface.validateDefinition(Locale)

getPromptDataType

public com.sas.datatypes.DataTypeInterface getPromptDataType()

Returns an instance of com.sas.datatypes.ColorType that can be used to process values for this prompt.

Specified by:

getPromptDataType in interface PromptDefinitionInterface

Specified by:

getPromptDataType in class PromptDefinition

Returns:

an instance of com.sas.datatypes.ColorType.

See Also:

PromptDefinitionInterface.getPromptDataType()

consumeRelatedObjects

public void consumeRelatedObjects(com.sas.util.xmlpersist.RelatedObjectListsHolder roHolder)
                           throws org.xml.sax.SAXException

Description copied from class: PromptDefinition

Persistence method for reading in subtags.

Specified by:

consumeRelatedObjects in interface com.sas.util.xmlpersist.PersistenceInterface

Overrides:

consumeRelatedObjects in class PromptDefinition

Throws:

org.xml.sax.SAXException

configureAttributes

public void configureAttributes(java.util.Map<java.lang.String,?> options,
                                java.util.Map<java.lang.String,?> context)

Specified by:

configureAttributes in interface com.sas.util.AttributeConfigurationInterface

Overrides:

configureAttributes in class PromptDefinition

getColorProvider

public com.sas.storage.valueprovider.ValueProviderInterface getColorProvider()

Returns back ValueProvider to the users of ColorDefinition in case custom colors are set else returns null

Specified by:

getColorProvider in interface com.sas.prompts.definitions.ColorDefinitionV2Interface

Returns:

ValueProvider

getDefaultColorProvider

public com.sas.storage.valueprovider.ValueProviderInterface getDefaultColorProvider()

Returns back a default ColorProvider created from the Swing Color Picker model

Specified by:

getDefaultColorProvider in interface com.sas.prompts.definitions.ColorDefinitionV2Interface

Returns:

ValueProvider

setColorProvider

public void setColorProvider(com.sas.storage.valueprovider.ValueProviderInterface colorProvider)

Sets the ValueProvider containing custom palette colors. For default behavior users can set null value

Specified by:

setColorProvider in interface com.sas.prompts.definitions.MutableColorDefinitionV2Interface

Parameters:

colorProvider -

getVersion

public java.lang.String getVersion()

Specified by:

getVersion in interface com.sas.models.VersionInterface

Overrides:

getVersion in class PromptDefinition