org.openswing.swing.table.columns.client
Class CodLookupColumn

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JPanel
                  extended byorg.openswing.swing.table.columns.client.Column
                      extended byorg.openswing.swing.table.columns.client.CodLookupColumn
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class CodLookupColumn
extends Column

Title: OpenSwing Framework

Description: Column of type lookup, i.e. it contains an input field for code validation and a lookup button (optional) to open a lookup grid frame.

Copyright: Copyright (C) 2006 Mauro Carniel

This file is part of OpenSwing Framework. This library is free software; you can redistribute it and/or modify it under the terms of the (LGPL) Lesser General Public License as published by the Free Software Foundation; GNU LESSER GENERAL PUBLIC LICENSE Version 2.1, February 1999 This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License for more details. You should have received a copy of the GNU Library General Public License along with this library; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. The author may be contacted at: maurocarniel@tin.it

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Field Summary
 
Fields inherited from class org.openswing.swing.table.columns.client.Column
autoFitColumn, TYPE_BUTTON, TYPE_CHECK, TYPE_COMBO, TYPE_COMBO_VO, TYPE_CURRENCY, TYPE_DATE, TYPE_DATE_TIME, TYPE_DEC, TYPE_FILE, TYPE_FORMATTED_TEXT, TYPE_IMAGE, TYPE_INT, TYPE_LINK, TYPE_LOOKUP, TYPE_MULTI_LINE_TEXT, TYPE_MULTIPLE_TYPE, TYPE_PERC, TYPE_PROGRESS_BAR, TYPE_SPINNER_LIST, TYPE_SPINNER_NUMBER, TYPE_TEXT, TYPE_TIME
 
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, 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
CodLookupColumn()
           
 
Method Summary
 void forceValidate()
          Force validation.
 void forceValidate(int rowNumber)
          Force validation.
 long getAutoCompletitionWaitTime()
           
 int getBottomMargin()
           
 javax.swing.table.TableCellEditor getCellEditor(GridController tableContainer, Grids grids)
           
 javax.swing.table.TableCellRenderer getCellRenderer(GridController tableContainer, Grids grids)
           
 int getColumnType()
           
 java.lang.String getControllerClassName()
           
 java.lang.String getControllerMethodName()
           
 int getLeftMargin()
           
 LookupController getLookupController()
           
 int getMaxCharacters()
           
 int getRightMargin()
           
 java.awt.ComponentOrientation getTextOrientation()
           
 int getTopMargin()
           
 boolean isAllowOnlyNumbers()
           
 boolean isCodePadding()
           
 boolean isEnableCodBox()
           
 boolean isHideButton()
           
 boolean isHideCodeBox()
           
 boolean isSelectDataOnEdit()
           
 boolean isZeroLengthAsNull()
           
 void setAllowOnlyNumbers(boolean allowOnlyNumbers)
          Allow numbers only in code field.
 void setAutoCompletitionWaitTime(long autoCompletitionWaitTime)
          Wait time before showing code auto completition feature for this lookup control.
 void setBottomMargin(int bottomMargin)
          Set component bottom margin, with respect to component container.
 void setCodePadding(boolean codePadding)
          Set code padding (related to maxCharacter property); default "false".
 void setControllerClassName(java.lang.String controllerClassName)
          Set the class name of the controller that must be invoked by pressing the "+" button.
 void setControllerMethodName(java.lang.String controllerMethodName)
          Set the method name defined in ClientFacade class, related to the controller that must be invoked by pressing the "+" button.
 void setEnableCodBox(boolean enableCodBox)
          Set if code field is editable.
 void setHideButton(boolean hideButton)
          Set button visibility.
 void setHideCodeBox(boolean hideCodeBox)
          Used to hide the code box.
 void setLeftMargin(int leftMargin)
          Set component left margin, with respect to component container.
 void setLookupController(LookupController lookupController)
          Set lookup controller.
 void setMaxCharacters(int maxCharacters)
          Set maximum characters number.
 void setRightMargin(int rightMargin)
          Set component right margin, with respect to component container.
 void setSelectDataOnEdit(boolean selectDataOnEdit)
          Define if data stored in cell must be selected when cell is set in edit
 void setTextOrientation(java.awt.ComponentOrientation orientation)
          Set the component orientation: from left to right or from right to left.
 void setTopMargin(int topMargin)
          Set component top margin, with respect to component container.
 void setZeroLengthAsNull(boolean zeroLengthAsNull)
          Set null value if code has zero length.
 
Methods inherited from class org.openswing.swing.table.columns.client.Column
getAdditionalHeaderColumnName, getAdditionalHeaderColumnSpan, getColumnName, getDesignColumnType, getHeaderColumnName, getHeaderFont, getHeaderForegroundColor, getHeaderTextHorizontalAlignment, getHeaderTextVerticalAlignment, getListFilter, getMaxWidth, getMinWidth, getPreferredWidth, getSortingOrder, getSortVersus, getTable, getTextAlignment, isAutoFitColumn, isColumnDuplicable, isColumnFilterable, isColumnRequired, isColumnSelectable, isColumnSortable, isColumnVisible, isEditableOnEdit, isEditableOnInsert, setAdditionalHeaderColumnName, setAdditionalHeaderColumnSpan, setAutoFitColumn, setColumnDuplicable, setColumnFilterable, setColumnName, setColumnRequired, setColumnSelectable, setColumnSortable, setColumnVisible, setEditableOnEdit, setEditableOnInsert, setHeaderColumnName, setHeaderFont, setHeaderForegroundColor, setHeaderTextHorizontalAlignment, setHeaderTextVerticalAlignment, setListFilter, setMaxWidth, setMinWidth, setPreferredWidth, setSortingOrder, setSortVersus, setTable, setTextAlignment
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, 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
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CodLookupColumn

public CodLookupColumn()
Method Detail

getColumnType

public int getColumnType()
Overrides:
getColumnType in class Column
Returns:
column type

setMaxCharacters

public void setMaxCharacters(int maxCharacters)
Set maximum characters number.

Parameters:
maxCharacters - maximum characters number

getMaxCharacters

public int getMaxCharacters()
Returns:
maximum characters number

setHideButton

public void setHideButton(boolean hideButton)
Set button visibility.

Parameters:
hideButton - button visibility: true button is hidden, false button is visible

isHideButton

public boolean isHideButton()
Returns:
button visibility: true button is hidden, false button is visible

setEnableCodBox

public void setEnableCodBox(boolean enableCodBox)
Set if code field is editable.

Parameters:
enableCodBox - code field is editable

isEnableCodBox

public boolean isEnableCodBox()
Returns:
code field is editable

setLookupController

public void setLookupController(LookupController lookupController)
Set lookup controller.

Parameters:
lookupController - lookup controller

getLookupController

public LookupController getLookupController()
Returns:
lookup controller

isAllowOnlyNumbers

public boolean isAllowOnlyNumbers()
Returns:
allow numbers only in code field

isCodePadding

public boolean isCodePadding()
Returns:
code padding (related to maxCharacter property)

setCodePadding

public void setCodePadding(boolean codePadding)
Set code padding (related to maxCharacter property); default "false".

Parameters:
codePadding - code padding (related to maxCharacter property)

setAllowOnlyNumbers

public void setAllowOnlyNumbers(boolean allowOnlyNumbers)
Allow numbers only in code field.

Parameters:
allowOnlyNumbers - allow numbers only in code field

isZeroLengthAsNull

public boolean isZeroLengthAsNull()
Returns:
true if the control must return null value when code has zero length, false if the control must return "" when code has zero length

setZeroLengthAsNull

public void setZeroLengthAsNull(boolean zeroLengthAsNull)
Set null value if code has zero length.

Parameters:
zeroLengthAsNull - true if the control must return null value when code has zero length, false if the control must return "" when code has zero length

isHideCodeBox

public boolean isHideCodeBox()
Returns:
flag used to hide the code box

setHideCodeBox

public void setHideCodeBox(boolean hideCodeBox)
Used to hide the code box.

Parameters:
hideCodeBox - flag used to hide the code box

getControllerClassName

public final java.lang.String getControllerClassName()
Returns:
class name of the controller that must be invoked by pressing the "+" button

getControllerMethodName

public final java.lang.String getControllerMethodName()
Returns:
method name defined in ClientFacade class, related to the controller that must be invoked by pressing the "+" button

setControllerClassName

public final void setControllerClassName(java.lang.String controllerClassName)
Set the class name of the controller that must be invoked by pressing the "+" button.

Parameters:
controllerClassName - class name of the controller that must be invoked by pressing the "+" button

setControllerMethodName

public final void setControllerMethodName(java.lang.String controllerMethodName)
Set the method name defined in ClientFacade class, related to the controller that must be invoked by pressing the "+" button.

Parameters:
controllerMethodName - method name defined in ClientFacade class, related to the controller that must be invoked by pressing the "+" button

forceValidate

public final void forceValidate()
Force validation. This method can be called by the developer to force a code validation, without losting focus and based on the current selected row in grid.


getAutoCompletitionWaitTime

public final long getAutoCompletitionWaitTime()
Returns:
wait time (expressed in ms) before showing code auto completition feature for lookup controls; -1, to do not enable auto completition

setAutoCompletitionWaitTime

public final void setAutoCompletitionWaitTime(long autoCompletitionWaitTime)
Wait time before showing code auto completition feature for this lookup control.

Parameters:
autoCompletitionWaitTime - wait time (expressed in ms) before showing code auto completition feature for this lookup control; default value: -1 to do not enable auto completition

forceValidate

public final void forceValidate(int rowNumber)
Force validation. This method can be called by the developer to force a code validation, without losting focus.

Parameters:
rowNumber - row number used to determine where is the cell to validate

getBottomMargin

public final int getBottomMargin()
Returns:
component bottom margin, with respect to component container

getLeftMargin

public final int getLeftMargin()
Returns:
component left margin, with respect to component container

getRightMargin

public final int getRightMargin()
Returns:
component right margin, with respect to component container

getTopMargin

public final int getTopMargin()
Returns:
component top margin, with respect to component container

setTopMargin

public final void setTopMargin(int topMargin)
Set component top margin, with respect to component container.

Parameters:
topMargin - component top margin

setRightMargin

public final void setRightMargin(int rightMargin)
Set component right margin, with respect to component container.

Parameters:
rightMargin - component right margin

setLeftMargin

public final void setLeftMargin(int leftMargin)
Set component left margin, with respect to component container.

Parameters:
leftMargin - component left margin

setBottomMargin

public final void setBottomMargin(int bottomMargin)
Set component bottom margin, with respect to component container.

Parameters:
bottomMargin - component bottom margin

isSelectDataOnEdit

public final boolean isSelectDataOnEdit()
Returns:
falseto do not select data stored cell; true to automatically select data already stored in cell

setSelectDataOnEdit

public final void setSelectDataOnEdit(boolean selectDataOnEdit)
Define if data stored in cell must be selected when cell is set in edit

Parameters:
selectDataOnEdit - falseto do not select data stored cell; true to automatically select data already stored in cell

setTextOrientation

public final void setTextOrientation(java.awt.ComponentOrientation orientation)
Set the component orientation: from left to right or from right to left.

Parameters:
orientation - component orientation

getTextOrientation

public final java.awt.ComponentOrientation getTextOrientation()
Returns:
component orientation

getCellRenderer

public final javax.swing.table.TableCellRenderer getCellRenderer(GridController tableContainer,
                                                                 Grids grids)
Overrides:
getCellRenderer in class Column
Returns:
TableCellRenderer for this column

getCellEditor

public final javax.swing.table.TableCellEditor getCellEditor(GridController tableContainer,
                                                             Grids grids)
Overrides:
getCellEditor in class Column
Returns:
TableCellEditor for this column