Home » openjdk-7 » javax » swing » text » [javadoc | source]
public class: DefaultFormatter [javadoc | source]

All Implemented Interfaces:
    Cloneable, Serializable

Direct Known Subclasses:
    MaskFormatter, NumberFormatter, DateFormatter, InternationalFormatter, DateEditorFormatter, NumberEditorFormatter

DefaultFormatter formats aribtrary objects. Formatting is done by invoking the toString method. In order to convert the value back to a String, your class must provide a constructor that takes a String argument. If no single argument constructor that takes a String is found, the returned value will be the String passed into stringToValue.

Instances of DefaultFormatter can not be used in multiple instances of JFormattedTextField. To obtain a copy of an already configured DefaultFormatter, use the clone method.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeansTM has been added to the java.beans package. Please see java.beans.XMLEncoder .

Nested Class Summary:
static class  DefaultFormatter.ReplaceHolder  ReplaceHolder is used to track where insert/remove/replace is going to happen. 
Field Summary
transient  ReplaceHolder replaceHolder    Used during replace to track the region to replace. 
 public DefaultFormatter() 
Method from javax.swing.text.DefaultFormatter Summary:
canReplace,   clone,   commitEdit,   getAllowsInvalid,   getCommitsOnValidEdit,   getDocumentFilter,   getInitialVisualPosition,   getNavigationFilter,   getNextCursorPosition,   getNextVisualPositionFrom,   getOverwriteMode,   getReplaceHolder,   getReplaceString,   getValueClass,   install,   isLegalInsertText,   isNavigatable,   isValidEdit,   moveDot,   positionCursorAtInitialLocation,   replace,   replace,   repositionCursor,   setAllowsInvalid,   setCommitsOnValidEdit,   setDot,   setOverwriteMode,   setValueClass,   stringToValue,   updateValue,   updateValue,   valueToString
Methods from javax.swing.JFormattedTextField$AbstractFormatter:
clone,   getActions,   getDocumentFilter,   getFormattedTextField,   getNavigationFilter,   install,   invalidEdit,   setEditValid,   stringToValue,   uninstall,   valueToString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.swing.text.DefaultFormatter Detail:
 boolean canReplace(ReplaceHolder rh) 
    Returns true if the edit described by rh will result in a legal value.
 public Object clone() throws CloneNotSupportedException 
    Creates a copy of the DefaultFormatter.
  void commitEdit() throws ParseException 
    Invokes commitEdit on the JFormattedTextField.
 public boolean getAllowsInvalid() 
    Returns whether or not the value being edited is allowed to be invalid for a length of time.
 public boolean getCommitsOnValidEdit() 
    Returns when edits are published back to the JFormattedTextField.
 protected DocumentFilter getDocumentFilter() 
    Returns the DocumentFilter used to restrict the characters that can be input into the JFormattedTextField.
 int getInitialVisualPosition() 
    Returns the initial location to position the cursor at. This forwards the call to getNextNavigatableChar.
 protected NavigationFilter getNavigationFilter() 
    Returns the NavigationFilter used to restrict where the cursor can be placed.
 int getNextCursorPosition(int offset,
    int direction) 
    Returns the next cursor position from offset by incrementing direction. This uses getNextNavigatableChar as well as constraining the location to the max position.
 int getNextVisualPositionFrom(JTextComponent text,
    int pos,
    Bias bias,
    int direction,
    Bias[] biasRet) throws BadLocationException 
    Finds the next navigatable character.
 public boolean getOverwriteMode() 
    Returns the behavior when inserting characters.
 ReplaceHolder getReplaceHolder(FilterBypass fb,
    int offset,
    int length,
    String text,
    AttributeSet attrs) 
    Returns the ReplaceHolder to track the replace of the specified text.
 String getReplaceString(int offset,
    int deleteLength,
    String replaceString) 
    A convenience methods to return the result of deleting deleteLength characters at offset and inserting replaceString at offset in the current text field.
 public Class<?> getValueClass() 
    Returns that class that is used to create new Objects.
 public  void install(JFormattedTextField ftf) 
    Installs the DefaultFormatter onto a particular JFormattedTextField. This will invoke valueToString to convert the current value from the JFormattedTextField to a String. This will then install the Actions from getActions, the DocumentFilter returned from getDocumentFilter and the NavigationFilter returned from getNavigationFilter onto the JFormattedTextField.

    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 the JFormattedTextField 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.

 boolean isLegalInsertText(String text) 
    Returns true if the text in text can be inserted. This does not mean the text will ultimately be inserted, it is used if text can trivially reject certain characters.
 boolean isNavigatable(int offset) 
    Subclasses should override this if they want cursor navigation to skip certain characters. A return value of false indicates the character at offset should be skipped when navigating throught the field.
 boolean isValidEdit(ReplaceHolder rh) 
  void moveDot(FilterBypass fb,
    int dot,
    Bias bias) 
    NavigationFilter method, subclasses that wish finer control should override this.
  void positionCursorAtInitialLocation() 
    Positions the cursor at the initial location.
 boolean replace(ReplaceHolder rh) throws BadLocationException 
    If the edit described by rh is legal, this will return true, commit the edit (if necessary) and update the cursor position. This forwards to canReplace and isLegalInsertText as necessary to determine if the edit is in fact legal.

    All of the DocumentFilter methods funnel into here, you should generally only have to override this.

  void replace(FilterBypass fb,
    int offset,
    int length,
    String text,
    AttributeSet attrs) throws BadLocationException 
    DocumentFilter method, funnels into replace.
  void repositionCursor(int offset,
    int direction) 
    Resets the cursor by using getNextCursorPosition.
 public  void setAllowsInvalid(boolean allowsInvalid) 
    Sets whether or not the value being edited is allowed to be invalid for a length of time (that is, stringToValue throws a ParseException). It is often convenient to allow the user to temporarily input an invalid value.
 public  void setCommitsOnValidEdit(boolean commit) 
    Sets when edits are published back to the JFormattedTextField. If true, commitEdit is invoked after every valid edit (any time the text is edited). On the other hand, if this is false than the DefaultFormatter does not publish edits back to the JFormattedTextField. As such, the only time the value of the JFormattedTextField will change is when commitEdit is invoked on JFormattedTextField, typically when enter is pressed or focus leaves the JFormattedTextField.
  void setDot(FilterBypass fb,
    int dot,
    Bias bias) 
    NavigationFilter method, subclasses that wish finer control should override this.
 public  void setOverwriteMode(boolean overwriteMode) 
    Configures the behavior when inserting characters. If overwriteMode is true (the default), new characters overwrite existing characters in the model.
 public  void setValueClass(Class<?> valueClass) 
    Sets that class that is used to create new Objects. If the passed in class does not have a single argument constructor that takes a String, String values will be used.
 public Object stringToValue(String string) throws ParseException 
    Converts the passed in String into an instance of getValueClass by way of the constructor that takes a String argument. If getValueClass returns null, the Class of the current value in the JFormattedTextField will be used. If this is null, a String will be returned. If the constructor thows an exception, a ParseException will be thrown. If there is no single argument String constructor, string will be returned.
  void updateValue() 
    Pushes the value to the JFormattedTextField if the current value is valid and invokes setEditValid based on the validity of the value.
  void updateValue(Object value) 
    Pushes the value to the editor if we are to commit on edits. If value is null, the current value will be obtained from the text component.
 public String valueToString(Object value) throws ParseException 
    Converts the passed in Object into a String by way of the toString method.