- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
DefaultFormatter
- Enclosing class:
JFormattedTextField
AbstractFormatter
are used by
JFormattedTextField
to handle the conversion both
from an Object to a String, and back from a String to an Object.
AbstractFormatter
s can also enforce editing policies,
or navigation policies, or manipulate the
JFormattedTextField
in any way it sees fit to
enforce the desired policy.
An AbstractFormatter
can only be active in
one JFormattedTextField
at a time.
JFormattedTextField
invokes
install
when it is ready to use it followed
by uninstall
when done. Subclasses
that wish to install additional state should override
install
and message super appropriately.
Subclasses must override the conversion methods
stringToValue
and valueToString
. Optionally
they can override getActions
,
getNavigationFilter
and getDocumentFilter
to restrict the JFormattedTextField
in a particular
way.
Subclasses that allow the JFormattedTextField
to be in
a temporarily invalid state should invoke setEditValid
at the appropriate times.
- Since:
- 1.4
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected Object
clone()
Clones theAbstractFormatter
.protected Action[]
Subclass and override if you wish to provide a custom set ofAction
s.protected DocumentFilter
Subclass and override if you wish to provide aDocumentFilter
to restrict what can be input.protected JFormattedTextField
Returns the currentJFormattedTextField
theAbstractFormatter
is installed on.protected NavigationFilter
Subclass and override if you wish to provide a filter to restrict where the user can navigate to.void
Installs theAbstractFormatter
onto a particularJFormattedTextField
.protected void
This should be invoked when the user types an invalid character.protected void
setEditValid
(boolean valid) Invoke this to update theeditValid
property of theJFormattedTextField
.abstract Object
stringToValue
(String text) Parsestext
returning an arbitrary Object.void
Uninstalls any state theAbstractFormatter
may have installed on theJFormattedTextField
.abstract String
valueToString
(Object value) Returns the string value to display forvalue
.
-
Constructor Details
-
AbstractFormatter
protected AbstractFormatter()Constructor for subclasses to call.
-
-
Method Details
-
install
Installs theAbstractFormatter
onto a particularJFormattedTextField
. This will invokevalueToString
to convert the current value from theJFormattedTextField
to a String. This will then install theAction
s fromgetActions
, theDocumentFilter
returned fromgetDocumentFilter
and theNavigationFilter
returned fromgetNavigationFilter
onto theJFormattedTextField
.Subclasses will typically only need to override this if they wish to install additional listeners on the
JFormattedTextField
.If there is a
ParseException
in converting the current value to a String, this will set the text to an empty String, and mark theJFormattedTextField
as being in an invalid state.While this is a public method, this is typically only useful for subclassers of
JFormattedTextField
.JFormattedTextField
will invoke this method at the appropriate times when the value changes, or its internal state changes. You will only need to invoke this yourself if you are subclassingJFormattedTextField
and installing/uninstallingAbstractFormatter
at a different time thanJFormattedTextField
does.- Parameters:
ftf
- JFormattedTextField to format for, may be null indicating uninstall from current JFormattedTextField.
-
uninstall
public void uninstall()Uninstalls any state theAbstractFormatter
may have installed on theJFormattedTextField
. This resets theDocumentFilter
,NavigationFilter
and additionalAction
s installed on theJFormattedTextField
. -
stringToValue
Parsestext
returning an arbitrary Object. Some formatters may return null.- Parameters:
text
- String to convert- Returns:
- Object representation of text
- Throws:
ParseException
- if there is an error in the conversion
-
valueToString
Returns the string value to display forvalue
.- Parameters:
value
- Value to convert- Returns:
- String representation of value
- Throws:
ParseException
- if there is an error in the conversion
-
getFormattedTextField
Returns the currentJFormattedTextField
theAbstractFormatter
is installed on.- Returns:
- JFormattedTextField formatting for.
-
invalidEdit
protected void invalidEdit()This should be invoked when the user types an invalid character. This forwards the call to the current JFormattedTextField. -
setEditValid
protected void setEditValid(boolean valid) Invoke this to update theeditValid
property of theJFormattedTextField
. If you an enforce a policy such that theJFormattedTextField
is always in a valid state, you will never need to invoke this.- Parameters:
valid
- Valid state of the JFormattedTextField
-
getActions
Subclass and override if you wish to provide a custom set ofAction
s.install
will install these on theJFormattedTextField
'sActionMap
.- Returns:
- Array of Actions to install on JFormattedTextField
-
getDocumentFilter
Subclass and override if you wish to provide aDocumentFilter
to restrict what can be input.install
will install the returned value onto theJFormattedTextField
.- Implementation Requirements:
- The default implementation returns
null
. - Returns:
- DocumentFilter to restrict edits
-
clone
Clones theAbstractFormatter
. The returned instance is not associated with aJFormattedTextField
.- Overrides:
clone
in classObject
- Returns:
- Copy of the AbstractFormatter
- Throws:
CloneNotSupportedException
- if the object's class does not support theCloneable
interface. Subclasses that override theclone
method can also throw this exception to indicate that an instance cannot be cloned.- See Also:
-