|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
org.openswing.swing.client.BaseInputControl
org.openswing.swing.client.CodLookupControl
Title: OpenSwing Framework
Description: Lookup input Control used to digit a code. A code can be an alphanumeric or a numeric value. When focus is lost from this control, a code validation is executed (only if the specified code is changed). It contains also a lookup button, i.e. a button which allows to view a lookup grid of codes: the user can select a code from the lookup grid and this code will be set in the code input field. It optionally contains also a "+" button, used to call a controller class, related to the code registry, i.e. the registry that allows to insert/update/delete codes referred by the lookup.
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
Nested Class Summary |
Nested classes inherited from class javax.swing.JComponent |
javax.swing.JComponent.AccessibleJComponent |
Field Summary |
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 | |
CodLookupControl()
Costructor. |
Method Summary | |
void |
addActionListener(java.awt.event.ActionListener listener)
Adds the specified action listener to receive action events from this textfield. |
void |
addFocusListener(java.awt.event.FocusListener listener)
Adds the specified focus listener to receive focus events from this component when this component gains input focus. |
void |
addNotify()
Check if Form has been setted. |
long |
getAutoCompletitionWaitTime()
|
javax.swing.JComponent |
getBindingComponent()
|
CodBox |
getCodBox()
|
int |
getColumns()
|
java.lang.String |
getControllerClassName()
|
java.lang.String |
getControllerMethodName()
|
java.lang.Object |
getLookupCodeParentValue()
|
LookupController |
getLookupController()
|
int |
getMaxCharacters()
|
java.awt.ComponentOrientation |
getTextOrientation()
|
java.lang.Object |
getValue()
|
ValueObject |
getValueObject()
|
boolean |
isAllowOnlyNumbers()
|
boolean |
isCodBoxVisible()
|
boolean |
isEnableCodBox()
|
boolean |
isEnabled()
|
boolean |
isLookupButtonVisible()
|
void |
removeActionListener(java.awt.event.ActionListener listener)
Removes the specified action listener so that it no longer receives action events from this textfield. |
void |
removeFocusListener(java.awt.event.FocusListener listener)
Removes the specified focus listener so that it no longer receives focus events from this component. |
void |
setAllowOnlyNumbers(boolean allowOnlyNumbers)
Define if the cod box allows numeric values only. |
void |
setAutoCompletitionWaitTime(long autoCompletitionWaitTime)
Wait time before showing code auto completition feature for this lookup control. |
void |
setCodBoxVisible(boolean codBoxVisible)
Set code input field visibility. |
void |
setColumns(int columns)
Set code input field columns. |
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 |
setEnabled(boolean enabled)
Callback called when the code input field abilitation is changed. |
void |
setLookupButtonVisible(boolean lookupButtonVisible)
Set lookup button visibility. |
void |
setLookupController(LookupController controller)
Set lookup controller. |
void |
setMaxCharacters(int maxCharacters)
Set the maximum code length. |
void |
setTextOrientation(java.awt.ComponentOrientation o)
Set the component orientation: from left to right or from right to left. |
void |
setValue(java.lang.Object code)
Select the combo item related to the specified code. |
void |
setValue(java.lang.String attributeName,
java.lang.Object value)
Method called by LookupController to update parent v.o. |
void |
validateCode(java.lang.String code)
Method that listen validation code event fired by the code input field: it validates the code. |
Methods inherited from class org.openswing.swing.client.BaseInputControl |
addValueChangedListener, getAttributeName, getFont, getLinkLabel, getTextAlignment, getToolTipText, getValueChangeListeners, isCanCopy, isChanged, isEnabledOnEdit, isEnabledOnInsert, isRequired, removeValueChangedListener, requestFocus, setAttributeName, setCanCopy, setChanged, setEnabledOnEdit, setEnabledOnInsert, setFont, setLinkLabel, setRequired, setTextAlignment, setToolTipText |
Methods inherited from class javax.swing.JPanel |
getAccessibleContext, getUI, getUIClassID, setUI, updateUI |
Methods inherited from class javax.swing.JComponent |
addAncestorListener, 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, 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, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, 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, 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, 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, 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, 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 |
Methods inherited from interface org.openswing.swing.client.InputControl |
addValueChangedListener, getAttributeName, getLinkLabel, getValueChangeListeners, isCanCopy, isChanged, isEnabledOnEdit, isEnabledOnInsert, isRequired, removeValueChangedListener, setAttributeName, setCanCopy, setChanged, setEnabledOnEdit, setEnabledOnInsert, setLinkLabel |
Methods inherited from interface org.openswing.swing.client.AutoCompletitionInputControl |
addAncestorListener, getHeight, getLocationOnScreen, getWidth |
Constructor Detail |
public CodLookupControl()
Method Detail |
public javax.swing.JComponent getBindingComponent()
getBindingComponent
in class BaseInputControl
public final java.lang.Object getValue()
getValue
in interface InputControl
getValue
in class BaseInputControl
public final void setValue(java.lang.Object code)
setValue
in interface InputControl
setValue
in class BaseInputControl
code
- used to retrieve the corresponding item and to select that item in the combopublic final int getMaxCharacters()
public final void setMaxCharacters(int maxCharacters)
maxCharacters
- maximum code lengthpublic final boolean isCodBoxVisible()
public final void setCodBoxVisible(boolean codBoxVisible)
codBoxVisible
- code input field visibilitypublic final int getColumns()
public final void setColumns(int columns)
columns
- code input field columnspublic final LookupController getLookupController()
public final void validateCode(java.lang.String code) throws RestoreFocusOnInvalidCodeException
validateCode
in interface CodBoxContainer
code
- code to validate
RestoreFocusOnInvalidCodeException
public final void setEnabled(boolean enabled)
CodBoxContainer
setEnabled
in interface CodBoxContainer
setEnabled
in class BaseInputControl
public final boolean isEnabled()
isEnabled
in interface InputControl
isEnabled
in class BaseInputControl
public final CodBox getCodBox()
public final void setLookupController(LookupController controller)
controller
- lookup controller.public final void addNotify()
public final void addFocusListener(java.awt.event.FocusListener listener)
l
is null
,
no exception is thrown and no action is performed.
addFocusListener
in interface InputControl
FocusEvent
,
FocusListener
,
removeFocusListener(java.awt.event.FocusListener)
,
Component.getFocusListeners()
public final void removeFocusListener(java.awt.event.FocusListener listener)
l
is null
,
no exception is thrown and no action is performed.
removeFocusListener
in interface InputControl
FocusEvent
,
FocusListener
,
addFocusListener(java.awt.event.FocusListener)
,
Component.getFocusListeners()
public final void addActionListener(java.awt.event.ActionListener listener)
public final void removeActionListener(java.awt.event.ActionListener listener)
public final boolean isAllowOnlyNumbers()
public final void setAllowOnlyNumbers(boolean allowOnlyNumbers)
allowOnlyNumbers
- define if the cod box allows numeric values onlypublic void setEnableCodBox(boolean enableCodBox)
enableCodBox
- code field is editablepublic boolean isEnableCodBox()
public void setValue(java.lang.String attributeName, java.lang.Object value)
setValue
in interface LookupParent
attributeName
- attribute name in the parent v.o. that must be updatedvalue
- updated valuepublic ValueObject getValueObject()
getValueObject
in interface LookupParent
public java.lang.Object getLookupCodeParentValue()
getLookupCodeParentValue
in interface LookupParent
public final java.lang.String getControllerClassName()
public final java.lang.String getControllerMethodName()
public final void setControllerClassName(java.lang.String controllerClassName)
controllerClassName
- class name of the controller that must be invoked by pressing the "+" buttonpublic final void setControllerMethodName(java.lang.String controllerMethodName)
controllerMethodName
- method name defined in ClientFacade class, related to the controller that must be invoked by pressing the "+" buttonpublic final long getAutoCompletitionWaitTime()
-1
, to do not enable auto completitionpublic final void setAutoCompletitionWaitTime(long autoCompletitionWaitTime)
autoCompletitionWaitTime
- wait time (expressed in ms) before showing code auto completition feature for this lookup control; default value: -1
to do not enable auto completitionpublic final boolean isLookupButtonVisible()
public final void setLookupButtonVisible(boolean lookupButtonVisible)
public final void setTextOrientation(java.awt.ComponentOrientation o)
o
- component orientationpublic final java.awt.ComponentOrientation getTextOrientation()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |