com.ontimize.gui.field

Class CurrencyDataField

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.ontimize.gui.field.DataField

com.ontimize.gui.field.TextFieldDataField

com.ontimize.gui.field.CurrencyDataField

All Implemented Interfaces:

AccessForm, AdvancedDataComponent, DataComponent, FormComponent, IdentifiedElement, HasHelpIdComponent, Internationalization, OpenDialog, ApplicationPreferencesListener, HasPreferenceComponent, SecureElement, SelectCurrencyValues, ValueChangeDataComponent, ImageObserver, MenuContainer, Serializable, EventListener, Accessible

Direct Known Subclasses:

CalculatedCurrencyDataField

public class CurrencyDataField
extends TextFieldDataField
implements OpenDialog, SelectCurrencyValues, AdvancedDataComponent

This class implements a field to introduce coins.
The base coin is EURO, so the setValue() and getValue() methods makes operation in that unit.
It is supported the change operation mode between Euro and Pesetas (1 Euro = 166.386 pta)

Author:

Imatia Innovation

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.ontimize.gui.field.TextFieldDataField

TextFieldDataField.EJTextField, TextFieldDataField.InnerDocumentListener

Nested classes/interfaces inherited from class com.ontimize.gui.field.DataField

DataField.AuxPanel, DataField.CopyActionListener, DataField.ELabel, DataField.FieldButton, DataField.FieldFocusListener, DataField.InfoMouseListener, DataField.ToggleButton

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected JMenuItem	advancedHelpBMenu A reference for advanced help menu.
protected Calculator	calc A calculator reference.
protected JButton	calcButton A reference for a calc button.
static String	CURRENCY
protected JButton	currencyButton Deprecated.
static boolean	DEFAULT_EURO_BUTTON_VISIBLE Deprecated.
protected String	euro Deprecated. Symbol is defined in document
protected ImageIcon	euroIcon Deprecated.
protected Frame	frame A reference for the frame.
protected String	pst Deprecated. Symbol is defined in document
protected ImageIcon	pstIcon Deprecated.
protected boolean	showEuros Deprecated.

Fields inherited from class com.ontimize.gui.field.TextFieldDataField

disabledTextColor, innerListener

Fields inherited from class com.ontimize.gui.field.DataField

advancedQueryMode, ALIGN, ALIGN_CENTER, ALIGN_LEFT, ALIGN_RIGHT, alignment, ASTERISK_REQUIRED_STYLE, ATTR, attribute, backgroundColor, BGCOLOR, bold, BOLD, BORDER, BORDER_REQUIRED_STYLE, borderText, BOTTOM, CENTER, CLIPBOARD_COPY, CLIPBOARD_COPY_es_ES, CLIPBOARD_CUT, CLIPBOARD_CUT_es_ES, CLIPBOARD_PASTE, CLIPBOARD_PASTE_es_ES, conditions, dataField, DEFAULT_BORDER, DEFAULT_BOTTOM_MARGIN, DEFAULT_FIELD_LEFT_MARGIN, DEFAULT_FIELD_RIGHT_MARGIN, DEFAULT_LABEL_LEFT_MARGIN, DEFAULT_LABEL_RIGHT_MARGIN, DEFAULT_PARENT_MARGIN, DEFAULT_PARENT_MARGIN_FOR_SCROLL, DEFAULT_TOP_MARGIN, defaultAsteriskColor, DEFAULTBORDER, defaultDisableBackgroundColor, defaultFieldButtonHigh, defaultPreferenceTextNotRetrievedFromPreferences, DEFINE_HELP_FIELD_PREFERENCE, dim, DIM, disabledbgcolor, DISABLEDBGCOLOR, empty, enabled, ENABLED, EXPAND, FIELD_HELP_TIP, fieldlistenerFocus, fieldSize, fireValueEvents, FOCUS_BACKGROUNDCOLOR, FONT, fontColor, FONTCOLOR, fontSize, FONTSIZE, height, HEIGHT, incrementalFont, initPreferenceHelpText, INSETS, isEnabled, LABELALIGN, labelComponent, LABELFONT, LABELFONTCOLOR, labelPosition, LABELPOSITION, LABELSIZE, labelText, LABELVISIBLE, LEFT, locale, LOWERED, menuCopy, menuCut, menuDefineHelpPreference, menuHelpPreferences, menuPaste, modifiable, NO_STR, NONE, noRequiredBorder, OPAQUE, originalSize, OUTBORDER, panel, parentForm, permissionActivate, permissionVisible, popupMenu, PREF_WIDTH, prefWidth, RAISED, redimensionPanel, redimensJTextField, required, REQUIRED, requiredBorder, REQUIREDBORDER, requiredFieldBackgroundColor, requiredFieldForegroundColor, resources, restricted, RIGHT, show, showLabel, SIZE, TEXT_STR, TEXTALIGN, textAlignment, textHelpPreference, TIP, tipKey, TOP, validData, VALIGN, Valignment, valueListener, valueSave, VISIBLE, VISUALIZE_HELP_FIELD_PREFERENCE, weightDataFieldH, weightPanelH, width, WIDTH, x, X, y, Y, YES_STR

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface com.ontimize.gui.SelectCurrencyValues

EURO, PST

Fields inherited from interface com.ontimize.gui.field.AdvancedDataComponent

ADVANCED_QUERY

Fields inherited from interface com.ontimize.gui.field.DataComponent

COMP_FOCUS_YELLOW, GREEN_VERY_LIGHT, LIGHT_GRAY_BLUE, LIGHT_GREYISH_BLUE, VERY_LIGHT_BLUE, VERY_LIGHT_GRAY, VERY_LIGHT_PINK, VERY_LIGHT_RED, VERY_LIGHT_SKYBLUE, VERY_LIGHT_YELLOW, VERY_LIGHT_YELLOW_2

Fields inherited from interface com.ontimize.gui.i18n.Internationalization

DEBUG_LANGUAGE

Fields inherited from interface com.ontimize.gui.SecureElement

DESACTIVATE_COMPONENT_BY_PERMISSION_TIP

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, PROPERTIES, SOMEBITS

Constructor Summary

Constructors

Constructor and Description
CurrencyDataField(Hashtable parameters) The class constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	colorSelection(DocumentEvent e) Checks the consistency of currency document value, changing the color to red with an incorrect value.
protected void	createDataField() Creates the data field.
protected CurrencyDocument	createDocument(String currencySymbol)
protected void	createPopupMenu() Creates a pop-up menu.
Object	getDoubleValue() Gets the double value.
int	getSQLDataType() Returns the sql data type according to java.sql.Types
Object	getValue() Gets the value of a component.
void	init(Hashtable parameters) Initializes parameters.
protected void	installInnerListener() Installs an inner listener.
protected void	installValidationDocumentListener() Installs a listener for validate document.
boolean	isEmpty() Checks the data existence in component.
boolean	isModified() This method should be return true when data have been modified.
void	setAdvancedQueryMode(boolean enable) This method must establish the advanced query state, to support advanced query conditions.
void	setComponentLocale(Locale loc)
void	setEnabled(boolean enabled) Enables the field to insert data.
void	setFontSize(int size) Sets font size to size parameter.
void	setParentFrame(Frame parentFrame) This method is called from Form for each component that implements this interface.
void	setResourceBundle(ResourceBundle resource) Sets the language resource bundle.
protected void	setTip() Sets the tip for field.
void	setValue(Object value) Sets the value for component.
void	showCurrencyValue(String currencySymbol)
protected void	showPopupMenu(Component c, int x, int y) Shows the pop-up menu.
void	updateUI()

Methods inherited from class com.ontimize.gui.field.TextFieldDataField

deleteData, getAttribute, getInnerListenerEnabled, getInnerValue, getLabelComponentText, getText, isInnerValueEqual, isModifiable, isRequired, isSelectedAll, setInnerListenerEnabled, setInnerValue

Methods inherited from class com.ontimize.gui.field.DataField

addFocusListener, addHelpMenuPopup, addValueChangeListener, changeButton, changeOpacity, checkDefineHelpPermission, checkEnabledPermission, checkVisiblePermission, configurePopupMenuHelp, createFocusListener, createInstanceConditionCombo, defineHelpField, finalize, fireValueChanged, getBorder, getConstraints, getDataField, getDisabledbgcolor, getFontColor, getHelpIdString, getHelpPreferenceKey, getLabelComponent, getLabelFontColor, getLabelText, getParentForm, getPreferenceHelpText, getPreferredSize, getTextsToTranslate, getValueChangeListeners, hasHelpInPreferences, initPermissions, initPreferences, installFocusListener, installHelpId, installPopupMenuListener, installPreferenceHelpListener, isAdvancedQueryMode, isEnabled, isHidden, isLabelVisible, isRestricted, parseBoolean, preferenceChanged, removeFocusListener, removeValueChangeListener, requestFocus, seeHelpField, setBold, setDisabledbgcolor, setFont, setFontColor, setLabelFontColor, setModifiable, setParentForm, setRequired, setRequiredFieldBackground, setVisible, updateBackgroundColor, updateBackgroundColor, updateFont, updateTip, validateComponentPositions

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ontimize.gui.field.DataComponent

deleteData, getLabelComponentText, isHidden, isModifiable, isRequired, setModifiable, setRequired

Methods inherited from interface com.ontimize.gui.field.FormComponent

getConstraints, isEnabled, setVisible

Methods inherited from interface com.ontimize.gui.i18n.Internationalization

getTextsToTranslate

Methods inherited from interface com.ontimize.gui.field.IdentifiedElement

getAttribute

Methods inherited from interface com.ontimize.gui.SecureElement

initPermissions, isRestricted

Field Detail

CURRENCY

public static final String CURRENCY

See Also:

Constant Field Values

DEFAULT_EURO_BUTTON_VISIBLE

@Deprecated
public static boolean DEFAULT_EURO_BUTTON_VISIBLE

Deprecated.

The default visibility condition for euro button. By default, false.

euroIcon

@Deprecated
protected ImageIcon euroIcon

Deprecated.

The euro icon. By default, null.

pstIcon

@Deprecated
protected ImageIcon pstIcon

Deprecated.

The pta icon. By default, null.

euro

@Deprecated
protected String euro

Deprecated. Symbol is defined in document

An instance of Euro.

pst

@Deprecated
protected String pst

Deprecated. Symbol is defined in document

An instance of Pta.

currencyButton

@Deprecated
protected JButton currencyButton

Deprecated.

An instance of currency button. By default, null.

showEuros

@Deprecated
protected boolean showEuros

Deprecated.

The condition to show euro coin. By default, true.

advancedHelpBMenu

protected JMenuItem advancedHelpBMenu

A reference for advanced help menu. By default, null.

frame

protected Frame frame

A reference for the frame. By default, null.

calcButton

protected JButton calcButton

A reference for a calc button. By default, null.

calc

protected Calculator calc

A calculator reference. By default, null.

Constructor Detail

CurrencyDataField

public CurrencyDataField(Hashtable parameters)

The class constructor. Inits parameters and installs a validation document listener.

Parameters:

parameters - the Hashtable with parameters.

Method Detail

init

public void init(Hashtable parameters)

Initializes parameters.

Specified by:

init in interface FormComponent

Overrides:

init in class TextFieldDataField

Parameters:

parameters - the Hashtable with parameters.

attribute	values	default	required	meaning
change	yes/no		yes	To support the change in the currency value.
calc	yes/no	no	no	The presence of the calendar.
minintegerdigits			no	The minimum number of integer digits.
maxintegerdigits			no	The maximum number of integer digits.
mindecimaldigits			no	The minimum number of decimal digits.
maxdecimaldigits			no	The maximum number of decimal digits.
grouping	yes/no		no	The condition to put the numbers in groups (1 000 000 -> 1000000)

createDocument

protected CurrencyDocument createDocument(String currencySymbol)

createDataField

protected void createDataField()

Description copied from class: TextFieldDataField

Creates the data field.

Overrides:

createDataField in class TextFieldDataField

setEnabled

public void setEnabled(boolean enabled)

Description copied from class: DataField

Enables the field to insert data.

Specified by:

setEnabled in interface FormComponent

Overrides:

setEnabled in class DataField

Parameters:

enabled - the condition to set enable

getValue

public Object getValue()

Description copied from interface: DataComponent

Gets the value of a component.

Specified by:

getValue in interface DataComponent

Returns:

the object with value.

setValue

public void setValue(Object value)

Description copied from interface: DataComponent

Sets the value for component.

Specified by:

setValue in interface DataComponent

Parameters:

value - the object with value to set

getSQLDataType

public int getSQLDataType()

Description copied from interface: DataComponent

Returns the sql data type according to java.sql.Types

Specified by:

getSQLDataType in interface DataComponent

Returns:

the Integer type

getDoubleValue

public Object getDoubleValue()

Gets the double value.

Returns:

the double value

setTip

protected void setTip()

Sets the tip for field.

showCurrencyValue

public void showCurrencyValue(String currencySymbol)

Specified by:

showCurrencyValue in interface SelectCurrencyValues

isModified

public boolean isModified()

Description copied from interface: DataComponent

This method should be return true when data have been modified. The method setValue() should be change this condition.

Specified by:

isModified in interface DataComponent

Overrides:

isModified in class DataField

Returns:

the modified condition

setFontSize

public void setFontSize(int size)

Description copied from class: DataField

Sets font size to size parameter.

Overrides:

setFontSize in class DataField

Parameters:

size - the font size parameter

updateUI

public void updateUI()

Overrides:

updateUI in class DataField

setAdvancedQueryMode

public void setAdvancedQueryMode(boolean enable)

Description copied from interface: AdvancedDataComponent

This method must establish the advanced query state, to support advanced query conditions.

Specified by:

setAdvancedQueryMode in interface AdvancedDataComponent

Parameters:

enable - the condition to enable this state

colorSelection

protected boolean colorSelection(DocumentEvent e)

Checks the consistency of currency document value, changing the color to red with an incorrect value.

Parameters:

e - the document event

Returns:

the consistency condition

createPopupMenu

protected void createPopupMenu()

Description copied from class: DataField

Creates a pop-up menu.

Overrides:

createPopupMenu in class DataField

setResourceBundle

public void setResourceBundle(ResourceBundle resource)

Description copied from interface: Internationalization

Sets the language resource bundle. When the application changes the configured language, for all the objects that implement this interface this method must be called with the new file.
The method must translate all the elements that have texts in the GUI

Specified by:

setResourceBundle in interface Internationalization

Overrides:

setResourceBundle in class DataField

Parameters:

resource - the new language bundle.

showPopupMenu

protected void showPopupMenu(Component c,
                 int x,
                 int y)

Description copied from class: DataField

Shows the pop-up menu.

Overrides:

showPopupMenu in class DataField

Parameters:

c - the component

x - the x coordinate

y - the y coordinate

isEmpty

public boolean isEmpty()

Description copied from interface: DataComponent

Checks the data existence in component.

Specified by:

isEmpty in interface DataComponent

Overrides:

isEmpty in class TextFieldDataField

Returns:

true when component is empty

installValidationDocumentListener

protected void installValidationDocumentListener()

Installs a listener for validate document.

setParentFrame

public void setParentFrame(Frame parentFrame)

Description copied from interface: OpenDialog

This method is called from Form for each component that implements this interface. It fixes the parent frame for element. This frame is needed to open the modal dialog.

Specified by:

setParentFrame in interface OpenDialog

Parameters:

parentFrame - the frame

installInnerListener

protected void installInnerListener()

Description copied from class: TextFieldDataField

Installs an inner listener.

Overrides:

installInnerListener in class TextFieldDataField

setComponentLocale

public void setComponentLocale(Locale loc)

Specified by:

setComponentLocale in interface Internationalization

Overrides:

setComponentLocale in class DataField