| javax.swing.JComponent
 com.izforge.izpack.panels.RuleInputField
| RuleInputField | | public class RuleInputField extends JComponent implements KeyListener,FocusListener,CaretListener,ProcessingClient(Code) | | This class assists the user in entering serial numbers.
Serial numbers, license number, CD keys and the like are often lenghty alpha-numerical numbers.
In many cases they are devided into multiple parts by dash or point separators. Entering these in
a single text field can be a frustrating experience for the user. This class provides a way of
presenting the user with an assembly of input fields that are arranged in the same way as the
key, with the separators already in place. Immideate testing for format compliance if performed
ans soon as each field is completed. In addition, the cursor is automatically advanced to make
entering numbers as painless as possible.
Formatting:
N:X:Y - numeric field, accepts digits only
H:X:Y - hex field, accepts only hexadecimal digits
A:X:Y - alpha field, accepts only letters, no digits
AN:X:Y- alpha-numeric field, accepts digits and letters
Example:
"N:4:4 - H:6:6 - AN:3:3 x A:5:5"
This formatting string will produce a serial number field consisting of four separate input
fields. The fisrt input field will accept four numeric digits, the second six hexa-decimal
digits, the third three alpha-numeric digits and the fourth five letters. The first three input
fields will be separated by '-' and the third and fourth by 'x'. The following snapshot was
obtained with this setting:
version:
0.0.1 / 10/19/02
author:
Elmar Grom |
| Field Summary | |
| final public static int | DISPLAY_FORMAT
Used to specify the retsult format. | | final public static int | ENCRYPTED
Used to specify the retsult format. | | final public static int | PLAIN_STRING
Used to specify the retsult format. | | final public static int | SPECIAL_SEPARATOR
Used to specify the retsult format. |
| Constructor Summary | |
| public | RuleInputField(String format, String preset, String separator, String validator, Map<String, String> validatorParams, String processor, int resultFormat, Toolkit toolkit, InstallData idata)
Constructs a rule input field.
Parameters:
format - a string that specifies the formatting and to a limited degree the behavior ofthis field.
Parameters:
preset - a string that specifies preset values for specific sub-fields.
Parameters:
separator - a string to be used for separating the contents of individual fields in thestring returned by getText()
Parameters:
validator - A string that specifies a class to perform validation services. | | public | RuleInputField(String format, String preset, String separator, String validator, String processor, int resultFormat, Toolkit toolkit, InstallData idata)
Constructs a rule input field.
Parameters:
format - a string that specifies the formatting and to a limited degree the behavior ofthis field.
Parameters:
preset - a string that specifies preset values for specific sub-fields.
Parameters:
separator - a string to be used for separating the contents of individual fields in thestring returned by getText()
Parameters:
validator - A string that specifies a class to perform validation services. |
| DISPLAY_FORMAT | | final public static int DISPLAY_FORMAT(Code) | | Used to specify the retsult format. This constant specifies to return the contents of all
fields together with all separators as specified in the field format concatenated into one
long string. In this case the resulting string looks just like the user saw it during data
entry
|
| ENCRYPTED | | final public static int ENCRYPTED(Code) | | Used to specify the retsult format. This constant specifies to return the contents of all
fields in a somehow modified way. How the content is modified depends on the operation
performed by a encryption service class. The class must be provided at object instatiation.
|
| PLAIN_STRING | | final public static int PLAIN_STRING(Code) | | Used to specify the retsult format. This constant specifies to return the contents of all
fields concatenated into one long string, with separation between each component.
|
| SPECIAL_SEPARATOR | | final public static int SPECIAL_SEPARATOR(Code) | | Used to specify the retsult format. This constant specifies to return the contents of all
fields concatenated into one long string, with a special separator string inserted in between
the individual components.
|
| RuleInputField | | public RuleInputField(String format, String preset, String separator, String validator, Map<String, String> validatorParams, String processor, int resultFormat, Toolkit toolkit, InstallData idata)(Code) | | Constructs a rule input field.
Parameters:
format - a string that specifies the formatting and to a limited degree the behavior ofthis field.
Parameters:
preset - a string that specifies preset values for specific sub-fields.
Parameters:
separator - a string to be used for separating the contents of individual fields in thestring returned by getText()
Parameters:
validator - A string that specifies a class to perform validation services. The stringmust completely identify the class, so that it can be instantiated. The class must implementthe RuleValidator interface. If an attempt to instantiate this class fails, novalidation will be performed.
Parameters:
validatorParams - A java.util.Map containing name/ value pairs, whichwill be forwarded to the validator.
Parameters:
processor - A string that specifies a class to perform processing services. The stringmust completely identify the class, so that it can be instantiated. The class must implementthe Processor interface. If an attempt to instantiate this class fails, noprocessing will be performed. Instead, the text is returned in the default formatting.
Parameters:
resultFormat - specifies in which format the resulting text should be returned, wehngetText() is called. The following values are legal:
- PLAIN_STRING
- DISPLAY_FORMAT
- SPECIAL_SEPARATOR
- ENCRYPTED
Parameters:
toolkit - needed to gain access to beep() |
| RuleInputField | | public RuleInputField(String format, String preset, String separator, String validator, String processor, int resultFormat, Toolkit toolkit, InstallData idata)(Code) | | Constructs a rule input field.
Parameters:
format - a string that specifies the formatting and to a limited degree the behavior ofthis field.
Parameters:
preset - a string that specifies preset values for specific sub-fields.
Parameters:
separator - a string to be used for separating the contents of individual fields in thestring returned by getText()
Parameters:
validator - A string that specifies a class to perform validation services. The stringmust completely identify the class, so that it can be instantiated. The class must implementthe RuleValidator interface. If an attempt to instantiate this class fails, novalidation will be performed.
Parameters:
processor - A string that specifies a class to perform processing services. The stringmust completely identify the class, so that it can be instantiated. The class must implementthe Processor interface. If an attempt to instantiate this class fails, noprocessing will be performed. Instead, the text is returned in the default formatting.
Parameters:
resultFormat - specifies in which format the resulting text should be returned, wehngetText() is called. The following values are legal:
- PLAIN_STRING
- DISPLAY_FORMAT
- SPECIAL_SEPARATOR
- ENCRYPTED
Parameters:
toolkit - needed to gain access to beep() |
| caretUpdate | | public void caretUpdate(CaretEvent event)(Code) | | Called when the caret position is updated.
Parameters:
event - the caret event received from the text field |
| focusGained | | public void focusGained(FocusEvent event)(Code) | | Invoked when a component gains the keyboard focus.
Parameters:
event - the focus event forwardes by the sytem. |
| focusLost | | public void focusLost(FocusEvent event)(Code) | | Invoked when a component loses the keyboard focus. This method does nothing, we are only
interested in 'focus gained' events.
Parameters:
event - the focus event forwardes by the sytem. |
| getFieldContents | | public String getFieldContents(int index) throws IndexOutOfBoundsException(Code) | | Returns the contents of the field indicated by index.
Parameters:
index - the index of the sub-field from which the contents is requested. the contents of the indicated sub-field.
exception:
IndexOutOfBoundsException - if the index is out of bounds. |
| getNumFields | | public int getNumFields()(Code) | | Returns the number of sub-fields composing this RuleInputField.
the number of sub-fields |
| getText | | public String getText()(Code) | | Returns the field contents, assembled acording to the encryption and separator rules.
the field contents |
| hasParams | | public boolean hasParams()(Code) | | |
| keyPressed | | public void keyPressed(KeyEvent event)(Code) | | This method is invoked when a key has been pressed. This method verifies the condition of the
input field in focus. Once the column count in the field has reached the specified maximum,
the rule specified for the field in question is invoked. In case the test result is positive,
focus is set to the next field. If hte test result is negative, the field content is marked
and the caret set to the start of the field.
Parameters:
event - the key event forwarded by the system. |
| keyReleased | | public void keyReleased(KeyEvent event)(Code) | | This method is invoked when a key has been released.
Parameters:
event - the key event forwarded by the system. |
| keyTyped | | public void keyTyped(KeyEvent event)(Code) | | This method is invoked when a key has been typed. The event occurs when a key press is
followed by a key release.
Parameters:
event - the key event forwarded by the system. |
| validateContents | | public boolean validateContents()(Code) | | This method validates the field content. Validating is performed through a user supplied
service class that provides the validation rules.
true if the validation passes or no implementation of a validationrule exists. Otherwise false is returned. |
| Methods inherited from javax.swing.JComponent | public void addAncestorListener(AncestorListener listener)(Code)(Java Doc)
public void addNotify()(Code)(Java Doc)
public synchronized void addVetoableChangeListener(VetoableChangeListener listener)(Code)(Java Doc)
public void computeVisibleRect(Rectangle visibleRect)(Code)(Java Doc)
public boolean contains(int x, int y)(Code)(Java Doc)
public JToolTip createToolTip()(Code)(Java Doc)
public void disable()(Code)(Java Doc)
public void enable()(Code)(Java Doc)
public void firePropertyChange(String propertyName, boolean oldValue, boolean newValue)(Code)(Java Doc)
public void firePropertyChange(String propertyName, int oldValue, int newValue)(Code)(Java Doc)
public void firePropertyChange(String propertyName, char oldValue, char newValue)(Code)(Java Doc)
protected void fireVetoableChange(String propertyName, Object oldValue, Object newValue) throws java.beans.PropertyVetoException(Code)(Java Doc)
public AccessibleContext getAccessibleContext()(Code)(Java Doc)
public ActionListener getActionForKeyStroke(KeyStroke aKeyStroke)(Code)(Java Doc)
final public ActionMap getActionMap()(Code)(Java Doc)
public float getAlignmentX()(Code)(Java Doc)
public float getAlignmentY()(Code)(Java Doc)
public AncestorListener[] getAncestorListeners()(Code)(Java Doc)
public boolean getAutoscrolls()(Code)(Java Doc)
public int getBaseline(int width, int height)(Code)(Java Doc)
public BaselineResizeBehavior getBaselineResizeBehavior()(Code)(Java Doc)
public Border getBorder()(Code)(Java Doc)
public Rectangle getBounds(Rectangle rv)(Code)(Java Doc)
final public Object getClientProperty(Object key)(Code)(Java Doc)
protected Graphics getComponentGraphics(Graphics g)(Code)(Java Doc)
public JPopupMenu getComponentPopupMenu()(Code)(Java Doc)
public int getConditionForKeyStroke(KeyStroke aKeyStroke)(Code)(Java Doc)
public int getDebugGraphicsOptions()(Code)(Java Doc)
public static Locale getDefaultLocale()(Code)(Java Doc)
public FontMetrics getFontMetrics(Font font)(Code)(Java Doc)
public Graphics getGraphics()(Code)(Java Doc)
public int getHeight()(Code)(Java Doc)
public boolean getInheritsPopupMenu()(Code)(Java Doc)
final public InputMap getInputMap(int condition)(Code)(Java Doc)
final public InputMap getInputMap()(Code)(Java Doc)
public InputVerifier getInputVerifier()(Code)(Java Doc)
public Insets getInsets()(Code)(Java Doc)
public Insets getInsets(Insets insets)(Code)(Java Doc)
public T[] getListeners(Class<T> listenerType)(Code)(Java Doc)
public Point getLocation(Point rv)(Code)(Java Doc)
public Dimension getMaximumSize()(Code)(Java Doc)
public Dimension getMinimumSize()(Code)(Java Doc)
public Component getNextFocusableComponent()(Code)(Java Doc)
public Point getPopupLocation(MouseEvent event)(Code)(Java Doc)
public Dimension getPreferredSize()(Code)(Java Doc)
public KeyStroke[] getRegisteredKeyStrokes()(Code)(Java Doc)
public JRootPane getRootPane()(Code)(Java Doc)
public Dimension getSize(Dimension rv)(Code)(Java Doc)
public Point getToolTipLocation(MouseEvent event)(Code)(Java Doc)
public String getToolTipText()(Code)(Java Doc)
public String getToolTipText(MouseEvent event)(Code)(Java Doc)
public Container getTopLevelAncestor()(Code)(Java Doc)
public TransferHandler getTransferHandler()(Code)(Java Doc)
public String getUIClassID()(Code)(Java Doc)
public boolean getVerifyInputWhenFocusTarget()(Code)(Java Doc)
public synchronized VetoableChangeListener[] getVetoableChangeListeners()(Code)(Java Doc)
public Rectangle getVisibleRect()(Code)(Java Doc)
public int getWidth()(Code)(Java Doc)
public int getX()(Code)(Java Doc)
public int getY()(Code)(Java Doc)
public void grabFocus()(Code)(Java Doc)
public boolean isDoubleBuffered()(Code)(Java Doc)
public static boolean isLightweightComponent(Component c)(Code)(Java Doc)
public boolean isManagingFocus()(Code)(Java Doc)
public boolean isOpaque()(Code)(Java Doc)
public boolean isOptimizedDrawingEnabled()(Code)(Java Doc)
final public boolean isPaintingForPrint()(Code)(Java Doc)
public boolean isPaintingTile()(Code)(Java Doc)
public boolean isRequestFocusEnabled()(Code)(Java Doc)
public boolean isValidateRoot()(Code)(Java Doc)
public void paint(Graphics g)(Code)(Java Doc)
protected void paintBorder(Graphics g)(Code)(Java Doc)
protected void paintChildren(Graphics g)(Code)(Java Doc)
protected void paintComponent(Graphics g)(Code)(Java Doc)
public void paintImmediately(int x, int y, int w, int h)(Code)(Java Doc)
public void paintImmediately(Rectangle r)(Code)(Java Doc)
protected String paramString()(Code)(Java Doc)
public void print(Graphics g)(Code)(Java Doc)
public void printAll(Graphics g)(Code)(Java Doc)
protected void printBorder(Graphics g)(Code)(Java Doc)
protected void printChildren(Graphics g)(Code)(Java Doc)
protected void printComponent(Graphics g)(Code)(Java Doc)
protected void processComponentKeyEvent(KeyEvent e)(Code)(Java Doc)
protected boolean processKeyBinding(KeyStroke ks, KeyEvent e, int condition, boolean pressed)(Code)(Java Doc)
protected void processKeyEvent(KeyEvent e)(Code)(Java Doc)
protected void processMouseEvent(MouseEvent e)(Code)(Java Doc)
protected void processMouseMotionEvent(MouseEvent e)(Code)(Java Doc)
final public void putClientProperty(Object key, Object value)(Code)(Java Doc)
public void registerKeyboardAction(ActionListener anAction, String aCommand, KeyStroke aKeyStroke, int aCondition)(Code)(Java Doc)
public void registerKeyboardAction(ActionListener anAction, KeyStroke aKeyStroke, int aCondition)(Code)(Java Doc)
public void removeAncestorListener(AncestorListener listener)(Code)(Java Doc)
public void removeNotify()(Code)(Java Doc)
public synchronized void removeVetoableChangeListener(VetoableChangeListener listener)(Code)(Java Doc)
public void repaint(long tm, int x, int y, int width, int height)(Code)(Java Doc)
public void repaint(Rectangle r)(Code)(Java Doc)
public boolean requestDefaultFocus()(Code)(Java Doc)
public void requestFocus()(Code)(Java Doc)
public boolean requestFocus(boolean temporary)(Code)(Java Doc)
public boolean requestFocusInWindow()(Code)(Java Doc)
protected boolean requestFocusInWindow(boolean temporary)(Code)(Java Doc)
public void resetKeyboardActions()(Code)(Java Doc)
public void reshape(int x, int y, int w, int h)(Code)(Java Doc)
public void revalidate()(Code)(Java Doc)
public void scrollRectToVisible(Rectangle aRect)(Code)(Java Doc)
final public void setActionMap(ActionMap am)(Code)(Java Doc)
public void setAlignmentX(float alignmentX)(Code)(Java Doc)
public void setAlignmentY(float alignmentY)(Code)(Java Doc)
public void setAutoscrolls(boolean autoscrolls)(Code)(Java Doc)
public void setBackground(Color bg)(Code)(Java Doc)
public void setBorder(Border border)(Code)(Java Doc)
public void setComponentPopupMenu(JPopupMenu popup)(Code)(Java Doc)
public void setDebugGraphicsOptions(int debugOptions)(Code)(Java Doc)
public static void setDefaultLocale(Locale l)(Code)(Java Doc)
public void setDoubleBuffered(boolean aFlag)(Code)(Java Doc)
public void setEnabled(boolean enabled)(Code)(Java Doc)
public void setFocusTraversalKeys(int id, Set<? extends AWTKeyStroke> keystrokes)(Code)(Java Doc)
public void setFont(Font font)(Code)(Java Doc)
public void setForeground(Color fg)(Code)(Java Doc)
public void setInheritsPopupMenu(boolean value)(Code)(Java Doc)
final public void setInputMap(int condition, InputMap map)(Code)(Java Doc)
public void setInputVerifier(InputVerifier inputVerifier)(Code)(Java Doc)
public void setMaximumSize(Dimension maximumSize)(Code)(Java Doc)
public void setMinimumSize(Dimension minimumSize)(Code)(Java Doc)
public void setNextFocusableComponent(Component aComponent)(Code)(Java Doc)
public void setOpaque(boolean isOpaque)(Code)(Java Doc)
public void setPreferredSize(Dimension preferredSize)(Code)(Java Doc)
public void setRequestFocusEnabled(boolean requestFocusEnabled)(Code)(Java Doc)
public void setToolTipText(String text)(Code)(Java Doc)
public void setTransferHandler(TransferHandler newHandler)(Code)(Java Doc)
protected void setUI(ComponentUI newUI)(Code)(Java Doc)
public void setVerifyInputWhenFocusTarget(boolean verifyInputWhenFocusTarget)(Code)(Java Doc)
public void setVisible(boolean aFlag)(Code)(Java Doc)
public void unregisterKeyboardAction(KeyStroke aKeyStroke)(Code)(Java Doc)
public void update(Graphics g)(Code)(Java Doc)
public void updateUI()(Code)(Java Doc)
|
|
|