Package org.compiere.grid.ed

Class VNumber

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.compiere.grid.ed.VNumber

All Implemented Interfaces:

ActionListener, FocusListener, KeyListener, ImageObserver, MenuContainer, PropertyChangeListener, Serializable, EventListener, VEditor, VManagedEditor, CEditor

public final class VNumber
extends JComponent
implements VEditor, ActionListener, KeyListener, FocusListener, VManagedEditor

Number Control

Version:

$Id: VNumber.java,v 1.2 2006/07/30 00:51:27 jjanke Exp $

Author:

Jorg Janke, Teo Sarca, SC ARHIPAC SERVICE SRL

BF [ 1739516 ] Warning on numeric field with range set

BF [ 1834393 ] VNumber.setFocusable not working

See Also:

Serialized Form

Nested Class Summary

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	Description
static boolean	AUTO_POPUP	Automatically pop up calculator
protected int	m_displayType
static int	SIZE	Number of Columns (12)

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 java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor	Description
VNumber()	IDE Bean Constructor
VNumber(String columnName, boolean mandatory, boolean isReadOnly, boolean isUpdateable, int displayType, String title)	Create right aligned Number field.

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(ActionEvent e)	Action Listener
void	addActionListener(ActionListener l)	Add Action Listner
void	commitChanges()	Commit pending changes
void	dispose()	Dispose
protected void	fireActionPerformed()	Fire Action Event to listeners
void	focusGained(FocusEvent e)	Focus Gained
void	focusLost(FocusEvent e)	Data Binding to MTable (via GridController.vetoableChange).
String	getDisplay()	Return Display Value
GridField	getField()	Get Field/WindowNo for ValuePreference
Component	getFocusableComponent()	Get Focus Component
String	getTitle()	Get Title
Object	getValue()	Return Editor value
boolean	isDirty()	Are there any pending changes
boolean	isMandatory()	Is it mandatory
boolean	isReadWrite()	IsReadWrite
void	keyPressed(KeyEvent e)
void	keyReleased(KeyEvent e)	Key Listener
void	keyTyped(KeyEvent e)	Key Listener Interface
Object	minus(int minimum)	Minus - subtract one, but not below minimum.
Object	plus()	Plus - add one.
void	propertyChange(PropertyChangeEvent evt)	Property Change Listener
void	removeActionListener(ActionListener l)	Remove Action Listner
void	requestFocus()	Request Focus
boolean	requestFocusInWindow()	Request Focus In Window
void	rollbackChanges()	Rollback pending changes
void	selectAll()	Select all the number text.
void	setBackground(boolean error)	Set Background
void	setBackground(Color color)	Set Background
void	setColumns(int columns, int height)	Set no of Columns
void	setDisplayType(int displayType)	Set and check DisplayType
protected void	setDocument(Document doc)	Set Document
void	setField(GridField mField)	Set Field/WindowNo for ValuePreference
void	setFocusable(boolean value)
void	setForeground(Color fg)	Set Foreground
void	setMandatory(boolean mandatory)	Set Mandatory (and back bolor)
boolean	setRange(Double minValue, Double maxValue)	Set Range with min & max
boolean	setRange(String minValue, String maxValue)	Set Range with min & max = parse US style number w/o Gouping
void	setReadWrite(boolean value)	Set ReadWrite
void	setValue(Object value)	Set Editor to value
static String	startCalculator(Container jc, String value, DecimalFormat format, int displayType, String title)	Deprecated. Use startCalculator(Container,String,DecimalFormat,int,String,char) instead
static String	startCalculator(Container jc, String value, DecimalFormat format, int displayType, String title, char operator)	Invalid Entry - Start Calculator

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, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUI, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

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, 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, getAccessibleContext, 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, 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, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.compiere.swing.CEditor

setVisible

Methods inherited from interface org.compiere.grid.ed.VEditor

addVetoableChangeListener, getName, removeVetoableChangeListener, setBorder, setFont, setName

Field Detail

SIZE

public static final int SIZE

Number of Columns (12)

See Also:

Constant Field Values

AUTO_POPUP

public static final boolean AUTO_POPUP

Automatically pop up calculator

See Also:

Constant Field Values

m_displayType

protected int m_displayType

Constructor Detail

VNumber

public VNumber()

IDE Bean Constructor

VNumber

public VNumber(String columnName,
               boolean mandatory,
               boolean isReadOnly,
               boolean isUpdateable,
               int displayType,
               String title)

Create right aligned Number field. no popup, if WindowNo == 0 (for IDs)

Parameters:

columnName - column name

mandatory - mandatory

isReadOnly - read only

isUpdateable - updateable

displayType - display type

title - title

Method Detail

dispose

public void dispose()

Dispose

Specified by:

dispose in interface VEditor

setDocument

protected void setDocument(Document doc)

Set Document

Parameters:

doc - document

selectAll

public void selectAll()

Select all the number text.

setColumns

public void setColumns(int columns,
                       int height)

Set no of Columns

Parameters:

columns - columns

height - 0 to use default

setRange

public boolean setRange(Double minValue,
                        Double maxValue)

Set Range with min & max

Parameters:

minValue - min value

maxValue - max value

Returns:

true, if accepted

setRange

public boolean setRange(String minValue,
                        String maxValue)

Set Range with min & max = parse US style number w/o Gouping

Parameters:

minValue - min value

maxValue - max value

Returns:

true if accepted

setDisplayType

public void setDisplayType(int displayType)

Set and check DisplayType

Parameters:

displayType - display type

setReadWrite

public void setReadWrite(boolean value)

Set ReadWrite

Specified by:

setReadWrite in interface CEditor

Parameters:

value - value

isReadWrite

public boolean isReadWrite()

IsReadWrite

Specified by:

isReadWrite in interface CEditor

Returns:

true if rw

setMandatory

public void setMandatory(boolean mandatory)

Set Mandatory (and back bolor)

Specified by:

setMandatory in interface CEditor

Parameters:

mandatory - mandatory

isMandatory

public boolean isMandatory()

Is it mandatory

Specified by:

isMandatory in interface CEditor

Returns:

true if mandatory

setBackground

public void setBackground(Color color)

Set Background

Overrides:

setBackground in class JComponent

Parameters:

color - color

setBackground

public void setBackground(boolean error)

Set Background

Specified by:

setBackground in interface CEditor

Parameters:

error - error

setForeground

public void setForeground(Color fg)

Set Foreground

Specified by:

setForeground in interface VEditor

Overrides:

setForeground in class JComponent

Parameters:

fg - foreground

setValue

public void setValue(Object value)

Set Editor to value

Specified by:

setValue in interface CEditor

Parameters:

value - value

requestFocus

public void requestFocus()

Request Focus

Overrides:

requestFocus in class JComponent

requestFocusInWindow

public boolean requestFocusInWindow()

Request Focus In Window

Overrides:

requestFocusInWindow in class JComponent

Returns:

focus request

getFocusableComponent

public Component getFocusableComponent()

Get Focus Component

Specified by:

getFocusableComponent in interface VEditor

Returns:

component

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Property Change Listener

Specified by:

propertyChange in interface PropertyChangeListener

Parameters:

evt - event

getValue

public Object getValue()

Return Editor value

Specified by:

getValue in interface CEditor

Returns:

value value (big decimal or integer)

getDisplay

public String getDisplay()

Return Display Value

Specified by:

getDisplay in interface CEditor

Returns:

value

getTitle

public String getTitle()

Get Title

Returns:

title

plus

public Object plus()

Plus - add one. Also sets Value

Returns:

new value

minus

public Object minus(int minimum)

Minus - subtract one, but not below minimum. Also sets Value

Parameters:

minimum - minimum

Returns:

new value

actionPerformed

public void actionPerformed(ActionEvent e)

Action Listener

Specified by:

actionPerformed in interface ActionListener

Parameters:

e - event

keyTyped

public void keyTyped(KeyEvent e)

Key Listener Interface

Specified by:

keyTyped in interface KeyListener

Parameters:

e - event

keyPressed

public void keyPressed(KeyEvent e)

Specified by:

keyPressed in interface KeyListener

keyReleased

public void keyReleased(KeyEvent e)

Key Listener. - Escape - Restore old Text - firstChange - signal change

Specified by:

keyReleased in interface KeyListener

Parameters:

e - event

focusGained

public void focusGained(FocusEvent e)

Focus Gained

Specified by:

focusGained in interface FocusListener

Parameters:

e - event

focusLost

public void focusLost(FocusEvent e)

Data Binding to MTable (via GridController.vetoableChange).

Specified by:

focusLost in interface FocusListener

Parameters:

e - event

commitChanges

public void commitChanges()

Description copied from interface: VManagedEditor

Commit pending changes

Specified by:

commitChanges in interface VManagedEditor

startCalculator

public static String startCalculator(Container jc,
                                     String value,
                                     DecimalFormat format,
                                     int displayType,
                                     String title)

Deprecated.

Use startCalculator(Container,String,DecimalFormat,int,String,char) instead

Invalid Entry - Start Calculator

Parameters:

jc - parent

value - value

format - format

displayType - display type

title - title

Returns:

value

startCalculator

public static String startCalculator(Container jc,
                                     String value,
                                     DecimalFormat format,
                                     int displayType,
                                     String title,
                                     char operator)

Invalid Entry - Start Calculator

Parameters:

jc - parent

value - value

format - format

displayType - display type

title - title

operator - optional math operator +-/*

Returns:

value

setField

public void setField(GridField mField)

Set Field/WindowNo for ValuePreference

Specified by:

setField in interface VEditor

Parameters:

mField - field

getField

public GridField getField()

Description copied from interface: VEditor

Get Field/WindowNo for ValuePreference

Specified by:

getField in interface VEditor

Returns:

mField

setFocusable

public void setFocusable(boolean value)

Overrides:

setFocusable in class Component

removeActionListener

public void removeActionListener(ActionListener l)

Remove Action Listner

Parameters:

l - Action Listener

addActionListener

public void addActionListener(ActionListener l)

Add Action Listner

Specified by:

addActionListener in interface VEditor

Parameters:

l - Action Listener

fireActionPerformed

protected void fireActionPerformed()

Fire Action Event to listeners

isDirty

public boolean isDirty()

Description copied from interface: VManagedEditor

Are there any pending changes

Specified by:

isDirty in interface VManagedEditor

Returns:

boolean

rollbackChanges

public void rollbackChanges()

Description copied from interface: VManagedEditor

Rollback pending changes

Specified by:

rollbackChanges in interface VManagedEditor