com.klg.jclass.field.validate
Class JCBigDecimalValidator

java.lang.Object
  |
  +--com.klg.jclass.field.validate.AbstractValidator
        |
        +--com.klg.jclass.field.validate.JCNumberValidator
              |
              +--com.klg.jclass.field.validate.JCBigDecimalValidator

All Implemented Interfaces:

JCValidator, Serializable

Direct Known Subclasses:

JCDoubleValidator, JCFloatValidator

public class JCBigDecimalValidator

extends JCNumberValidator

This class validates objects of type BigDecimal.

See Also:

Serialized Form

Field Summary

protected Object	defaultValue
protected boolean	useFormatting

Fields inherited from class com.klg.jclass.field.validate.JCNumberValidator

currency_locale, currencySymbols, display_pattern, displayFormat, edit_pattern, editFormat, exponentialChar, isCurrency, spin_policy, symbols, use_intl_currency_symbol

Fields inherited from class com.klg.jclass.field.validate.AbstractValidator

abstractInitializing, allow_null, AS_IS, case_policy, increment, invalid_chars, li, locale, LOWERCASE, match_picklist, max, min, NOT_FOUND, picklist, SPIN_FIELD, SPIN_SUBFIELD, SPIN_WRAP, supportedClasses, UPPERCASE, valid_chars

Fields inherited from interface com.klg.jclass.field.validate.JCValidator

DOWN, UP

Constructor Summary

JCBigDecimalValidator()
Constructs a JCBigDecimalValidator.

JCBigDecimalValidator(Locale locale, Number min, Number max, Number increment, String display_pattern, boolean allow_null, boolean currency, boolean use_intl_currency_locale, Locale currency_locale, Object default_value)
Constructs a JCBigDecimalValidator with the values specified.

Method Summary

protected Object	addIncrement(Object current)
void	changeText(com.klg.jclass.field.validate.TextEvent e) Changes the specified text from the start_position to the end_position by inserting/replacing it by a range specified in new_text.
Object	convertFromSupported(Object from, Class class_type) Converts the supported type to the type supported by the validator.
Object	convertToSupported(Object obj) Converts the specified type (if possible) to the type supported by the validator.
protected DecimalFormat	createDisplayFormat(Locale l)
protected DecimalFormat	createEditFormat(Locale l)
String	format(Object obj) Override the base class method.
String	formatForEdit(Object obj) Generates a String representation of the given object for use in edit mode.
protected BigDecimal	getBigDecimal(Object num) Given a Number object, this method will return a BigDecimal object.
Object	getDefaultValue() Returns the default value for the field.
Number	getIncrement() Gets the number by which to spin the values in numeric spin fields.
protected Class[]	getSupportedClasses() Creates a list of classes supported by the validator.
boolean	getUseFormatting() Returns true if formatting is used.
boolean	hasEditFormat() Reports whether the validator has a different edit format or not.
boolean	inRange(BigDecimal value) Checks if the value is in the valid range.
boolean	inRange(Object value) Checks if the value is in the valid range.
Object	parse(Class class_type, String text) Parses the given text and validates it.
void	setCursor(com.klg.jclass.field.validate.TextCursorEvent e) Sets the cursor to the specified position.
void	setDefaultValue(Object default_value) Sets the default value for the field.
void	setIncrement(Number increment) Sets the number by which to spin the values in numeric spin fields.
protected void	setPatterns()
void	setUseFormatting(boolean f) Sets the value of the useFormatting property.
protected Object	subtractIncrement(Object current)
boolean	validate(Object obj) Validates a given object.

Methods inherited from class com.klg.jclass.field.validate.JCNumberValidator

copyValue, getCurrencyLocale, getCurrencySymbol, getCurrencySymbol, getDisplayFormat, getDisplayPattern, getEditFormat, getEditPattern, getFirstValidCursorPosition, getIntlCurrencySymbol, getLocalCurrencySymbol, getUseIntlCurrencySymbol, isCurrency, setCurrency, setCurrencyLocale, setDisplayFormat, setDisplayPattern, setEditFormat, setEditPattern, setLocale, setUseIntlCurrencySymbol

Methods inherited from class com.klg.jclass.field.validate.AbstractValidator

calculateSpinability, checkValidInvalid, compareValues, convertCase, createPopupComponent, getAllowNull, getCasePolicy, getInvalidChars, getItem, getLocale, getMatchPickList, getMax, getMin, getNextValue, getPickList, getPickListIndex, getPreviousValue, getSpinPolicy, getValidChars, inferSubField, isClassSupported, isValidChar, setAllowNull, setCasePolicy, setInvalidChars, setMatchPickList, setMax, setMin, setPickList, setRange, setSpinPolicy, setValidChars, spinDown, spinUp

Methods inherited from class java.lang.Object

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

Field Detail

defaultValue

protected Object defaultValue

useFormatting

protected boolean useFormatting

Constructor Detail

JCBigDecimalValidator

public JCBigDecimalValidator()

Constructs a JCBigDecimalValidator.

JCBigDecimalValidator

public JCBigDecimalValidator(Locale locale,
                             Number min,
                             Number max,
                             Number increment,
                             String display_pattern,
                             boolean allow_null,
                             boolean currency,
                             boolean use_intl_currency_locale,
                             Locale currency_locale,
                             Object default_value)

Constructs a JCBigDecimalValidator with the values specified.

Parameters:

allow_null -

currency -

currency_locale -

default_value -

display_pattern -

increment -

locale -

max -

min -

use_intl_currency_locale -

Method Detail

getSupportedClasses

protected Class[] getSupportedClasses()

Creates a list of classes supported by the validator.

Returns:

getBigDecimal

protected BigDecimal getBigDecimal(Object num)

Given a Number object, this method will return a BigDecimal object.

Parameters:

num -

Returns:

createDisplayFormat

protected DecimalFormat createDisplayFormat(Locale l)

Specified by:

createDisplayFormat in class JCNumberValidator

createEditFormat

protected DecimalFormat createEditFormat(Locale l)

Specified by:

createEditFormat in class JCNumberValidator

setPatterns

protected void setPatterns()

Specified by:

setPatterns in class JCNumberValidator

setCursor

public void setCursor(com.klg.jclass.field.validate.TextCursorEvent e)

Sets the cursor to the specified position.

Specified by:

setCursor in interface JCValidator

Overrides:

setCursor in class JCNumberValidator

Parameters:

e -

addIncrement

protected Object addIncrement(Object current)

Specified by:

addIncrement in class AbstractValidator

subtractIncrement

protected Object subtractIncrement(Object current)

Specified by:

subtractIncrement in class AbstractValidator

getIncrement

public Number getIncrement()

Gets the number by which to spin the values in numeric spin fields.

Returns:

number to spin the values in the numeric spin fields

setIncrement

public void setIncrement(Number increment)

Sets the number by which to spin the values in numeric spin fields.

Parameters:

increment -

inRange

public boolean inRange(BigDecimal value)

Checks if the value is in the valid range.

Parameters:

value -

Returns:

inRange

public boolean inRange(Object value)

Checks if the value is in the valid range.

Specified by:

inRange in class AbstractValidator

Parameters:

value -

Returns:

changeText

public void changeText(com.klg.jclass.field.validate.TextEvent e)

Changes the specified text from the start_position to the end_position by inserting/replacing it by a range specified in new_text.

Specified by:

changeText in interface JCValidator

Overrides:

changeText in class AbstractValidator

Parameters:

e - The text event generated by the text change

parse

public Object parse(Class class_type,
                    String text)

Parses the given text and validates it.

Specified by:

parse in interface JCValidator

Specified by:

parse in class AbstractValidator

Parameters:

class_type - object returned will be of the specified class type

text - text to parse

Returns:

validate

public boolean validate(Object obj)

Validates a given object.

Specified by:

validate in interface JCValidator

Overrides:

validate in class AbstractValidator

Parameters:

obj -

Returns:

format

public String format(Object obj)

Override the base class method. Returns a formatted String given an object.

Specified by:

format in interface JCValidator

Overrides:

format in class JCNumberValidator

Parameters:

obj -

Returns:

a formatted String

formatForEdit

public String formatForEdit(Object obj)

Generates a String representation of the given object for use in edit mode.

Specified by:

formatForEdit in interface JCValidator

Specified by:

formatForEdit in class AbstractValidator

Parameters:

obj -

Returns:

hasEditFormat

public boolean hasEditFormat()

Reports whether the validator has a different edit format or not.

Specified by:

hasEditFormat in interface JCValidator

Specified by:

hasEditFormat in class AbstractValidator

Returns:

convertToSupported

public Object convertToSupported(Object obj)

Converts the specified type (if possible) to the type supported by the validator. To reverse this operation use the convertFromSupported() method.

Specified by:

convertToSupported in class AbstractValidator

Parameters:

obj -

Returns:

See Also:

convertFromSupported(java.lang.Object, java.lang.Class)

convertFromSupported

public Object convertFromSupported(Object from,
                                   Class class_type)

Converts the supported type to the type supported by the validator.
Note: The object passed in is not modified, but only used as a reference.

Specified by:

convertFromSupported in class AbstractValidator

Parameters:

from -

class_type -

Returns:

See Also:

convertToSupported(java.lang.Object)

getDefaultValue

public Object getDefaultValue()

Returns the default value for the field.

Returns:

default value

setDefaultValue

public void setDefaultValue(Object default_value)

Sets the default value for the field.

Parameters:

default_value -

setUseFormatting

public void setUseFormatting(boolean f)

Sets the value of the useFormatting property.

Parameters:

f - true if formatting is desired.

getUseFormatting

public boolean getUseFormatting()

Returns true if formatting is used.