org.compiere.grid.ed
Class VLookup

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              org.compiere.grid.ed.VLookup

All Implemented Interfaces:

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

public class VLookup
extends JComponent
implements VEditor, ActionListener, FocusListener

Lookup Visual Field.

When r/o - display a Label When STABLE - display a ComboBox Otherwise show Selection Dialog

Special handling of BPartner and Product

Version:

$Id: VLookup.java,v 1.5 2006/10/06 00:42:38 jjanke Exp $

Author:

Jorg Janke

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

static int	DISPLAY_LENGTH Display Length for Lookups (15)
static int	FIELD_HIGHT Field Height (20)

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

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

Constructor Summary

VLookup(String columnName, boolean mandatory, boolean isReadOnly, boolean isUpdateable, Lookup lookup)
Detail Constructor

Method Summary

void	actionPerformed(ActionEvent e) Action Listener - data binding
void	addActionListener(ActionListener listener) Action Listener Interface
static VLookup	createBPartner(int WindowNo) Create Optional BPartner Search Lookup
static VLookup	createProduct(int WindowNo) Create Optional Product Search Lookup
static VLookup	createUser(int WindowNo) Create Optional User Search Lookup
void	disableValisation() Disable Validation
void	dispose() Dispose
void	focusGained(FocusEvent e) Focus Listener for ComboBoxes with missing Validation or invalid entries - Requery listener for updated list
void	focusLost(FocusEvent e) Reset Selection List
static String[]	getDirectAccessSQL(Ctx ctx, String m_columnName, Lookup m_lookup, String text)
String	getDisplay() Return editor display
GridField	getField() Get Field
Component	getFocusableComponent() Get Focus Component
Object	getValue() Return Editor value (Integer)
static String	getWhereClause(Ctx ctx, String columnName, Lookup lookup) Get Where Clause
boolean	isMandatory() Is it mandatory
boolean	isReadWrite() IsEditable
void	propertyChange(PropertyChangeEvent evt) Property Change Listener
int	refresh() Refresh Query
void	removeActionListener(ActionListener listener) Action Listener Interface
void	requestFocus() Request Focus
boolean	requestFocusInWindow() Request Focus In Window
void	setBackground(boolean error) Set Background
void	setBackground(Color color) Set Background
void	setEnabled(boolean enabled) Set enabled
void	setField(GridField mField) Set Field/WindowNo for ValuePreference
void	setForeground(Color fg) Set Foreground
void	setMandatory(boolean mandatory) Set Mandatory (and back color)
void	setReadWrite(boolean value) Set ReadWrite
void	setToolTipText(String text) Set ToolTip
void	setValue(Object value) Set Editor to value

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, 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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, setFocusTraversalKeys, setFont, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, 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, transferFocusBackward, 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, 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, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

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

addVetoableChangeListener, getName, removeVetoableChangeListener, setBorder, setFont, setName

Methods inherited from interface org.compiere.swing.CEditor

setVisible

Field Detail

DISPLAY_LENGTH

public static final int DISPLAY_LENGTH

Display Length for Lookups (15)

See Also:

Constant Field Values

FIELD_HIGHT

public static int FIELD_HIGHT

Field Height (20)

Constructor Detail

VLookup

public VLookup(String columnName,
               boolean mandatory,
               boolean isReadOnly,
               boolean isUpdateable,
               Lookup lookup)

Detail Constructor

Parameters:

columnName - column

mandatory - mandatory

isReadOnly - read only

isUpdateable - updateable

lookup - lookup

Method Detail

createBPartner

public static VLookup createBPartner(int WindowNo)

Create Optional BPartner Search Lookup

Parameters:

WindowNo - window

Returns:

VLookup

createProduct

public static VLookup createProduct(int WindowNo)

Create Optional Product Search Lookup

Parameters:

WindowNo - window

Returns:

VLookup

createUser

public static VLookup createUser(int WindowNo)

Create Optional User Search Lookup

Parameters:

WindowNo - window

Returns:

VLookup

dispose

public void dispose()

Dispose

Specified by:

dispose in interface VEditor

setReadWrite

public void setReadWrite(boolean value)

Set ReadWrite

Specified by:

setReadWrite in interface CEditor

Parameters:

value - ReadWrite

setEnabled

public void setEnabled(boolean enabled)

Set enabled

Overrides:

setEnabled in class JComponent

Parameters:

enabled - enabled

isReadWrite

public boolean isReadWrite()

IsEditable

Specified by:

isReadWrite in interface CEditor

Returns:

is lookup ReadWrite

setMandatory

public void setMandatory(boolean mandatory)

Set Mandatory (and back color)

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 color

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

setValue

public void setValue(Object value)

Set Editor to value

Specified by:

setValue in interface CEditor

Parameters:

value - new Value

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Property Change Listener

Specified by:

propertyChange in interface PropertyChangeListener

Parameters:

evt - PropertyChangeEvent

getValue

public Object getValue()

Return Editor value (Integer)

Specified by:

getValue in interface CEditor

Returns:

value

getDisplay

public String getDisplay()

Return editor display

Specified by:

getDisplay in interface CEditor

Returns:

display value

setField

public void setField(GridField mField)

Set Field/WindowNo for ValuePreference

Specified by:

setField in interface VEditor

Parameters:

mField - Model Field for Lookup

getField

public GridField getField()

Get Field

Specified by:

getField in interface VEditor

Returns:

gridField

actionPerformed

public void actionPerformed(ActionEvent e)

Action Listener - data binding

Specified by:

actionPerformed in interface ActionListener

Parameters:

e - ActionEvent

addActionListener

public void addActionListener(ActionListener listener)

Action Listener Interface

Specified by:

addActionListener in interface VEditor

Parameters:

listener - listener

removeActionListener

public void removeActionListener(ActionListener listener)

Action Listener Interface

Specified by:

removeActionListener in interface VEditor

Parameters:

listener -

getWhereClause

public static String getWhereClause(Ctx ctx,
                                    String columnName,
                                    Lookup lookup)

Get Where Clause

Parameters:

ctx - context

columnName - column name

lookup - lookup

Returns:

where clause or ""

getDirectAccessSQL

public static String[] getDirectAccessSQL(Ctx ctx,
                                          String m_columnName,
                                          Lookup m_lookup,
                                          String text)

Parameters:

ctx -

m_columnName -

m_lookup -

text -

Returns:

An array of 3 Strings; 0=SQL, 1=m_tableName, 2=m_keyColumnName

focusGained

public void focusGained(FocusEvent e)

Focus Listener for ComboBoxes with missing Validation or invalid entries - Requery listener for updated list

Specified by:

focusGained in interface FocusListener

Parameters:

e - FocusEvent

focusLost

public void focusLost(FocusEvent e)

Reset Selection List

Specified by:

focusLost in interface FocusListener

Parameters:

e - FocusEvent

setToolTipText

public void setToolTipText(String text)

Set ToolTip

Overrides:

setToolTipText in class JComponent

Parameters:

text - tool tip text

refresh

public int refresh()

Refresh Query

Returns:

count

disableValisation

public void disableValisation()

Disable Validation