org.tentackle.swing

Class BMoneyFormField

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.text.JTextComponent

javax.swing.JTextField

org.tentackle.swing.AbstractFormField

org.tentackle.swing.AbstractNumberFormField

org.tentackle.swing.AbstractFractionNumberFormField

org.tentackle.swing.BMoneyFormField

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, Scrollable, SwingConstants, FormChangeable, FormChangeableComponent, FormComponent, FormFieldComponent

public class BMoneyFormField
extends AbstractFractionNumberFormField

FormField to edit a BMoney object.

Author:

harald

See Also:

Serialized Form

Nested Class Summary

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

JTextField.AccessibleJTextField

Nested classes/interfaces inherited from class javax.swing.text.JTextComponent

JTextComponent.AccessibleJTextComponent, JTextComponent.DropLocation, JTextComponent.KeyBinding

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
static boolean	defaultAutoComma application-wide default setting for the auto-comma feature

Fields inherited from class org.tentackle.swing.AbstractNumberFormField

decimalFormat

Fields inherited from class org.tentackle.swing.AbstractFormField

errorMessage, errorOffset, savedValue

Fields inherited from class javax.swing.JTextField

notifyAction

Fields inherited from class javax.swing.text.JTextComponent

DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY

Fields inherited from class javax.swing.JComponent

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

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface org.tentackle.swing.FormFieldComponent

ADJUST_LEFT, ADJUST_NONE, ADJUST_RIGHT, ADJUST_TRIM, CONVERT_LC, CONVERT_NONE, CONVERT_UC

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
BMoneyFormField() Creates an empty BMoneyFormField with the default document model, a minimum column width for a BMoney.
BMoneyFormField(boolean parseDMoney) Creates an empty BMoneyFormField with the default document model, and minimum column width.
BMoneyFormField(Document doc, int columns, boolean parseDMoney) Creates an empty BMoneyFormField. Notice: setting doc != null requires a doc derived from FormFieldDocument.
BMoneyFormField(int columns, boolean parseDMoney) Creates an empty BMoneyFormField with the default document model and given column width.

Method Summary

Modifier and Type	Method and Description
org.tentackle.common.DMoney	getDMoney() Gets the value as a DMoney.
org.tentackle.common.BMoney	getFormValue() Retrieves the value from this component. The method is used to update the data model if the view has changed because the user edited it.
protected org.tentackle.common.BMoney	getFormValue(boolean parseDMoney) Parses the money string.
org.tentackle.common.BMoney	getMaxValue() Gets the maximum value.
org.tentackle.common.BMoney	getMinValue() Gets the minimum value.
boolean	isAutoComma() Returns the auto-comma setting.
boolean	isParseDMoney() Gets the flag whether getFormValue() will return DMoney or BMoney.
void	setAutoComma(boolean autoComma) Sets the auto-comma feature. Allows "business" keyboard input, i.e.
void	setFormat(String pattern) Sets the format string. The format string is used to format the view of the data.
void	setFormValue(Object object) Sets a value in this component. The method is used to update the view if the data has changed.
void	setMaxValue(org.tentackle.common.BMoney maxValue) Sets the maximum value.
void	setMinValue(org.tentackle.common.BMoney minValue) Sets the minimum value.
void	setParseDMoney(boolean parseDMoney) Sets whether getFormValue() returns BMoney or DMoney.

Methods inherited from class org.tentackle.swing.AbstractFractionNumberFormField

getScale, setDecimalFormat, setScale

Methods inherited from class org.tentackle.swing.AbstractNumberFormField

clearText, doFormat, getDecimalFormat, getFormat, isBlankZero, isUnsigned, restoreSavedValue, setBlankZero, setText, setUnsigned, setValidChars

Methods inherited from class org.tentackle.swing.AbstractFormField

addValueListener, clearValueShownModified, createDefaultModel, downRight, fireValueChanged, fireValueEntered, getAdjust, getBinding, getBindingPath, getComponentPath, getConvert, getConverter, getDefaultColumns, getErrorMessage, getErrorOffset, getFiller, getFocusTraversalGroup, getHelpURL, getInvalidChars, getMaxColumns, getParentWindow, getPreferredSize, getPropertyGroup, getText, getToolTipText, getValidChars, getValueShown, getVerticalAlignment, hideErrorPopup, invalidateParentInfo, isAutoNext, isAutoSelect, isAutoUpdate, isBindable, isCaretLeft, isCaretRight, isCellEditorUsage, isChangeable, isEmpty, isEraseFirst, isFireRunning, isFormTraversable, isHonourChangeable, isInhibitAutoSelect, isMandatory, isOverwrite, isSmartValueEntered, isStartEditLeftmost, isTriggerValueChangedEnabled, isValueChanged, isValueShownModified, prepareFocusLost, processFocusEvent, processKeyBinding, removeValueListener, requestFocusLater, saveValue, setAdjust, setAutoNext, setAutoSelect, setAutoUpdate, setBindable, setBinding, setBindingPath, setCaretLeft, setCaretRight, setCellEditorUsage, setChangeable, setColumns, setComponentPath, setConvert, setConverter, setDefaultColumns, setEditable, setEraseFirst, setErrorMessage, setErrorOffset, setFiller, setFireRunning, setFocusTraversalGroup, setFormTraversable, setFormWrapWindow, setHelpURL, setHonourChangeable, setInhibitAutoSelect, setInvalidChars, setMandatory, setMaxColumns, setOverwrite, setPropertyGroup, setSmartValueEntered, setStartEditLeftmost, setTriggerValueChangedEnabled, setVerticalAlignment, showErrorPopup, showErrorPopup, showHelp, transferFocus, transferFocusBackward, triggerValueChanged, updateAllChangeable, upLeft, wasFocusGainedFromTransfer, wasFocusGainedFromTransferBackward, wasTransferFocus, wasTransferFocusBackward, wasTransferFocusByEnter

Methods inherited from class javax.swing.JTextField

actionPropertyChanged, addActionListener, configurePropertiesFromAction, createActionPropertyChangeListener, fireActionPerformed, getAccessibleContext, getAction, getActionListeners, getActions, getColumns, getColumnWidth, getHorizontalAlignment, getHorizontalVisibility, getScrollOffset, getUIClassID, isValidateRoot, paramString, postActionEvent, removeActionListener, scrollRectToVisible, setAction, setActionCommand, setDocument, setFont, setHorizontalAlignment, setScrollOffset

Methods inherited from class javax.swing.text.JTextComponent

addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getDropLocation, getDropMode, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getPreferredScrollableViewportSize, getPrintable, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, moveCaretPosition, paste, print, print, print, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, replaceSelection, restoreComposedText, saveComposedText, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDragEnabled, setDropMode, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setUI, updateUI, viewToModel, write

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, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, 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, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, 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, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, 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, processHierarchyBoundsEvent, processHierarchyEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tentackle.swing.FormFieldComponent

getCaretPosition, getColumns, getHorizontalAlignment, postActionEvent, setCaretPosition, setHorizontalAlignment, setToolTipText

Methods inherited from interface org.tentackle.swing.FormComponent

getBaseline, hasFocus

Field Detail

defaultAutoComma

public static boolean defaultAutoComma

application-wide default setting for the auto-comma feature

Constructor Detail

BMoneyFormField

public BMoneyFormField(Document doc,
                       int columns,
                       boolean parseDMoney)

Creates an empty BMoneyFormField.
Notice: setting doc != null requires a doc derived from FormFieldDocument.

Parameters:

doc - the document model, null = default

columns - the number of columns, 0 = minimum width

parseDMoney - true if getFormValue() returns DMoney, false if BMoney

BMoneyFormField

public BMoneyFormField(int columns,
                       boolean parseDMoney)

Creates an empty BMoneyFormField with the default document model and given column width.

Parameters:

columns - the number of columns, 0 = minimum width

parseDMoney - true if getFormValue() returns DMoney, false if BMoney

BMoneyFormField

public BMoneyFormField(boolean parseDMoney)

Creates an empty BMoneyFormField with the default document model, and minimum column width.

Parameters:

parseDMoney - true if getFormValue() returns DMoney, false if BMoney

BMoneyFormField

public BMoneyFormField()

Creates an empty BMoneyFormField with the default document model, a minimum column width for a BMoney.

Method Detail

setMinValue

public void setMinValue(org.tentackle.common.BMoney minValue)

Sets the minimum value.

Parameters:

minValue - the minimum value, null if none

getMinValue

public org.tentackle.common.BMoney getMinValue()

Gets the minimum value.

Returns:

the minimum value, null if none

setMaxValue

public void setMaxValue(org.tentackle.common.BMoney maxValue)

Sets the maximum value.

Parameters:

maxValue - the maximum value, null if none

getMaxValue

public org.tentackle.common.BMoney getMaxValue()

Gets the maximum value.

Returns:

the maximum value

setFormValue

public void setFormValue(Object object)

Sets a value in this component.
The method is used to update the view if the data has changed.

Overridden to set the scale from the money value

Specified by:

setFormValue in interface FormComponent

Overrides:

setFormValue in class AbstractNumberFormField

Parameters:

object - is the object to set

getFormValue

protected org.tentackle.common.BMoney getFormValue(boolean parseDMoney)

Parses the money string.

Parameters:

parseDMoney - true if returned value is a DMoney, else BMoney

Returns:

the parsed value

getFormValue

public org.tentackle.common.BMoney getFormValue()

Description copied from interface: FormComponent

Retrieves the value from this component.
The method is used to update the data model if the view has changed because the user edited it.

Returns:

the object from the form

getDMoney

public org.tentackle.common.DMoney getDMoney()

Gets the value as a DMoney.

Returns:

the money value or null if field is empty

setParseDMoney

public void setParseDMoney(boolean parseDMoney)

Sets whether getFormValue() returns BMoney or DMoney.

Parameters:

parseDMoney - true if parse to DMoney, else BMoney

isParseDMoney

public boolean isParseDMoney()

Gets the flag whether getFormValue() will return DMoney or BMoney.

Returns:

true if DMoney, else BMoney (default)

setFormat

public void setFormat(String pattern)

Sets the format string.
The format string is used to format the view of the data.

The format string will be converted to a DecimalFormat.

Overridden cause of comma-char.

Specified by:

setFormat in interface FormFieldComponent

Overrides:

setFormat in class AbstractNumberFormField

Parameters:

pattern - the format string

See Also:

AbstractNumberFormField.setDecimalFormat(java.text.DecimalFormat)

setAutoComma

public void setAutoComma(boolean autoComma)

Sets the auto-comma feature.
Allows "business" keyboard input, i.e. comma is set according to the property scale if no comma has been entered by the user.

 Example: "1122" -> "11.22" if scale was 2.
 

Parameters:

autoComma - true if automatically set the comma, false if not (default)

See Also:

defaultAutoComma

isAutoComma

public boolean isAutoComma()

Returns the auto-comma setting.

Returns:

true if automatically set the comma according to scale