|
||||||||||
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
com.izforge.izpack.panels.RuleInputField
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
"N:4:4 - H:6:6 - AN:3:3 x A:5:5"
Nested Class Summary |
Nested classes inherited from class javax.swing.JComponent |
JComponent.AccessibleJComponent |
Nested classes inherited from class java.awt.Container |
Container.AccessibleAWTContainer |
Nested classes inherited from class java.awt.Component |
Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy |
Field Summary | |
static int |
DISPLAY_FORMAT
Used to specify the retsult format. |
static int |
ENCRYPTED
Used to specify the retsult format. |
static int |
PLAIN_STRING
Used to specify the retsult format. |
static int |
SPECIAL_SEPARATOR
Used to specify the retsult format. |
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 | |
RuleInputField(String format,
String preset,
String separator,
String validator,
Map validatorParams,
String processor,
int resultFormat,
Toolkit toolkit,
com.izforge.izpack.installer.InstallData idata)
Constructs a rule input field. |
|
RuleInputField(String format,
String preset,
String separator,
String validator,
String processor,
int resultFormat,
Toolkit toolkit,
com.izforge.izpack.installer.InstallData idata)
Constructs a rule input field. |
Method Summary | |
void |
caretUpdate(CaretEvent event)
Called when the caret position is updated. |
void |
focusGained(FocusEvent event)
Invoked when a component gains the keyboard focus. |
void |
focusLost(FocusEvent event)
Invoked when a component loses the keyboard focus. |
String |
getFieldContents(int index)
Returns the contents of the field indicated by index . |
int |
getNumFields()
Returns the number of sub-fields composing this RuleInputField . |
String |
getText()
Returns the field contents, assembled acording to the encryption and separator rules. |
Map |
getValidatorParams()
Returns the validator parameters, if any. |
boolean |
hasParams()
|
void |
keyPressed(KeyEvent event)
This method is invoked when a key has been pressed. |
void |
keyReleased(KeyEvent event)
This method is invoked when a key has been released. |
void |
keyTyped(KeyEvent event)
This method is invoked when a key has been typed. |
boolean |
validateContents()
This method validates the field content. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int PLAIN_STRING
public static final int DISPLAY_FORMAT
public static final int SPECIAL_SEPARATOR
public static final int ENCRYPTED
Constructor Detail |
public RuleInputField(String format, String preset, String separator, String validator, Map validatorParams, String processor, int resultFormat, Toolkit toolkit, com.izforge.izpack.installer.InstallData idata)
format
- a string that specifies the formatting and to a limited degree the behavior of
this field.preset
- a string that specifies preset values for specific sub-fields.separator
- a string to be used for separating the contents of individual fields in the
string returned by getText()
validator
- A string that specifies a class to perform validation services. The string
must completely identify the class, so that it can be instantiated. The class must implement
the RuleValidator
interface. If an attempt to instantiate this class fails, no
validation will be performed.validatorParams
- A java.util.Map
containing name/ value pairs, which
will be forwarded to the validator.processor
- A string that specifies a class to perform processing services. The string
must completely identify the class, so that it can be instantiated. The class must implement
the Processor
interface. If an attempt to instantiate this class fails, no
processing will be performed. Instead, the text is returned in the default formatting.resultFormat
- specifies in which format the resulting text should be returned, wehn
getText()
is called. The following values are legal:toolkit
- needed to gain access to beep()
public RuleInputField(String format, String preset, String separator, String validator, String processor, int resultFormat, Toolkit toolkit, com.izforge.izpack.installer.InstallData idata)
format
- a string that specifies the formatting and to a limited degree the behavior of
this field.preset
- a string that specifies preset values for specific sub-fields.separator
- a string to be used for separating the contents of individual fields in the
string returned by getText()
validator
- A string that specifies a class to perform validation services. The string
must completely identify the class, so that it can be instantiated. The class must implement
the RuleValidator
interface. If an attempt to instantiate this class fails, no
validation will be performed.processor
- A string that specifies a class to perform processing services. The string
must completely identify the class, so that it can be instantiated. The class must implement
the Processor
interface. If an attempt to instantiate this class fails, no
processing will be performed. Instead, the text is returned in the default formatting.resultFormat
- specifies in which format the resulting text should be returned, wehn
getText()
is called. The following values are legal:toolkit
- needed to gain access to beep()
Method Detail |
public boolean hasParams()
public int getNumFields()
RuleInputField
.
getNumFields
in interface ProcessingClient
public String getFieldContents(int index) throws IndexOutOfBoundsException
index
.
getFieldContents
in interface ProcessingClient
index
- the index of the sub-field from which the contents is requested.
IndexOutOfBoundsException
- if the index is out of bounds.public Map getValidatorParams()
hasParams()
method prior to invoking this method.
public String getText()
public boolean validateContents()
true
if the validation passes or no implementation of a validation
rule exists. Otherwise false
is returned.public void keyTyped(KeyEvent event)
keyTyped
in interface KeyListener
event
- the key event forwarded by the system.public void keyPressed(KeyEvent event)
keyPressed
in interface KeyListener
event
- the key event forwarded by the system.public void keyReleased(KeyEvent event)
keyReleased
in interface KeyListener
event
- the key event forwarded by the system.public void focusGained(FocusEvent event)
focusGained
in interface FocusListener
event
- the focus event forwardes by the sytem.public void focusLost(FocusEvent event)
focusLost
in interface FocusListener
event
- the focus event forwardes by the sytem.public void caretUpdate(CaretEvent event)
caretUpdate
in interface CaretListener
event
- the caret event received from the text field
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |