javax.swing
类 JFormattedTextField

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.text.JTextComponent
                  javax.swing.JTextField
                      javax.swing.JFormattedTextField

所有已实现的接口：

ImageObserver, MenuContainer, Serializable, Accessible, Scrollable, SwingConstants

public class JFormattedTextField
extends JTextField

JFormattedTextField 扩展了 JTextField，添加了对格式化任意值的支持，以及一旦用户编辑了文本就检索特定对象的支持。以下代码说明了如何配置 JFormattedTextField 来编辑日期：

   JFormattedTextField ftf = new JFormattedTextField();
   ftf.setValue(new Date());
 

一旦创建了 JFormattedTextField，就可以通过添加 PropertyChangeListener 的方式来侦听编辑更改，并且使用属性名 value 来侦听 PropertyChangeEvent。

JFormattedTextField 允许配置在失去焦点时应该采取的措施。可能的值为：

JFormattedTextField 允许焦点离开，即使当前编辑的值是无效的也是如此。要在 JFormattedTextField 处于无效编辑状态时锁定焦点，可以附加一个 InputVerifier。以下代码片断显示了这种 InputVerifier 的可能实现：

 public class FormattedTextFieldVerifier extends InputVerifier {
     public boolean verify(JComponent input) {
         if (input instanceof JFormattedTextField) {
             JFormattedTextField ftf = (JFormattedTextField)input;
             AbstractFormatter formatter = ftf.getFormatter();
             if (formatter != null) {
                 String text = ftf.getText();
                 try {
                      formatter.stringToValue(text);
return true;
                  } catch (ParseException pe) {
                      return false;
                  }
              }
          }
return true;
      }
      public boolean shouldYieldFocus(JComponent input) {
          return verify(input);
      }
  }
 

或者，也可以调用 commitEdit，这也会提交该值。

JFormattedTextField 本身不执行格式化，而是通过从 JFormattedTextField.AbstractFormatterFactory 实例获得的 JFormattedTextField.AbstractFormatter 实例完成格式化。通过 install 方法的方式使 JFormattedTextField.AbstractFormatter 的实例处于激活状态时会通知它们，此时 JFormattedTextField.AbstractFormatter 可以安装其所需的任何内容，通常是 DocumentFilter。类似地，当 JFormattedTextField 不再需要 AbstractFormatter 时，它会调用 uninstall。

JFormattedTextField 通常在获得或丢失焦点时查询 AbstractFormatterFactory 以找到 AbstractFormat。但根据焦点丢失策略也可以更改此行为。如果焦点丢失策略是 JFormattedTextField.PERSIST 并且已编辑了 JFormattedTextField，则在值提交之前不会查询 AbstractFormatterFactory。类似地，如果焦点丢失策略是 JFormattedTextField.COMMIT 并且从 stringToValue 中抛出异常，则丢失或获得焦点时不查询 AbstractFormatterFactory。

JFormattedTextField.AbstractFormatter 还负责确定何时将值提交给 JFormattedTextField。某些 JFormattedTextField.AbstractFormatter 在每次编辑时都提供新值，而其他的则从不提交该值。可以强行从当前的 JFormattedTextField.AbstractFormatter 获得当前值，方法是调用 commitEdit。每当在 JFormattedTextField 中按下了 return 键，就调用 commitEdit。

如果尚未显式地设置 AbstractFormatterFactory，则在调用 setValue 后（假定 value 是非 null 的），根据 value 类型的 Class 设置该值。例如，在以下代码中将创建一个合适的 AbstractFormatterFactory 和 AbstractFormatter，以处理数字的格式化：

   JFormattedTextField tf = new JFormattedTextField();
   tf.setValue(new Number(100));
 

警告：由于 AbstractFormatter 通常在 Document 上安装一个 DocumentFilter，在 JFormattedTextField 上安装一个 NavigationFilter，所以您不应安装自己的过滤器。如果您安装了，则会看到奇怪的行为，因为将无法强制执行 AbstractFormatter 的编辑策略。

警告：Swing 不是线程安全的。有关更多信息，请参阅 Swing's Threading Policy。

警告：此类的序列化对象与以后的 Swing 版本不兼容。当前序列化支持适用于短期存储，或适用于在运行相同 Swing 版本的应用程序之间进行 RMI（Remote Method Invocation，远程方法调用）。从 1.4 版本开始，已在 java.beans 包中添加了支持所有 JavaBeans^TM 长期存储的功能。请参见 XMLEncoder。

从以下版本开始：

1.4

COMMIT

public static final int COMMIT

标识丢失焦点时，应该调用 commitEdit 的常量。如果在提交新值的过程中抛出 ParseException，则将保留无效值。

另请参见：

setFocusLostBehavior(int), 常量字段值

COMMIT_OR_REVERT

public static final int COMMIT_OR_REVERT

标识丢失焦点时，应该调用 commitEdit 的常量。如果在提交新值的过程中抛出 ParseException，则将恢复原值。

另请参见：

setFocusLostBehavior(int), 常量字段值

REVERT

public static final int REVERT

标识丢失焦点时，应该将编辑的值恢复为 JFormattedTextField 上所设当前值的常量。

另请参见：

setFocusLostBehavior(int), 常量字段值

PERSIST

public static final int PERSIST

标识丢失焦点时，应该保留编辑值的常量。

另请参见：

setFocusLostBehavior(int), 常量字段值

JFormattedTextField

public JFormattedTextField()

创建一个没有 AbstractFormatterFactory 的 JFormattedTextField。使用 setMask 或 setFormatterFactory 配置 JFormattedTextField 以编辑特定的值类型。

JFormattedTextField

public JFormattedTextField(Object value)

创建一个具有指定值的 JFormattedTextField。这将根据 value 的类型创建一个 AbstractFormatterFactory。

参数：

value - JFormattedTextField 的初始值

JFormattedTextField

public JFormattedTextField(Format format)

创建一个 JFormattedTextField。format 包装在一个适当的 AbstractFormatter 中，然后该 AbstractFormatter 包装在一个 AbstractFormatterFactory 中。

参数：

format - 用于查找 AbstractFormatter 的 Format

JFormattedTextField

public JFormattedTextField(JFormattedTextField.AbstractFormatter formatter)

创建一个具有指定 AbstractFormatter 的 JFormattedTextField。该 AbstractFormatter 被放置在 AbstractFormatterFactory 中。

参数：

formatter - 进行格式化所使用的 AbstractFormatter。

JFormattedTextField

public JFormattedTextField(JFormattedTextField.AbstractFormatterFactory factory)

创建一个具有指定 AbstractFormatterFactory 的 JFormattedTextField。

参数：

factory - 用于进行格式化的 AbstractFormatterFactory。

JFormattedTextField

public JFormattedTextField(JFormattedTextField.AbstractFormatterFactory factory,
                           Object currentValue)

创建一个具有指定 AbstractFormatterFactory 和初始值的 JFormattedTextField。

参数：

factory - 用于进行格式化的 AbstractFormatterFactory。

currentValue - 要使用的初始值

setFocusLostBehavior

public void setFocusLostBehavior(int behavior)

设置丢失焦点时的行为。这是 JFormattedTextField.COMMIT_OR_REVERT、JFormattedTextField.REVERT、JFormattedTextField.COMMIT 或 JFormattedTextField.PERSIST 之一。注意，某些 AbstractFormatter 可能在出现更改时即进行下一步操作，所以该值无效。

如果传入的对象不是上述值之一，则将抛出 IllegalArgumentException。

此属性的默认值为 JFormattedTextField.COMMIT_OR_REVERT。

参数：

behavior - 标识丢失焦点时的行为

抛出：

IllegalArgumentException - 如果 behavior 不是某个已知值

getFocusLostBehavior

public int getFocusLostBehavior()

返回丢失焦点时的行为。这是 COMMIT_OR_REVERT、COMMIT、REVERT 或 PERSIST 之一。注意，某些 AbstractFormatter 可能在出现更改时即进行下一步操作，所以该值无效。

返回：

返回丢失焦点时的行为

setFormatterFactory

public void setFormatterFactory(JFormattedTextField.AbstractFormatterFactory tf)

设置 AbstractFormatterFactory。AbstractFormatterFactory 能够返回 AbstractFormatter 的实例，它可用于格式化要显示的某个值，以及强制执行编辑策略。

如果尚未通过此方法（或构造方法）显式地设置 AbstractFormatterFactory，则根据该值的 Class 使用 AbstractFormatterFactory，然后使用 AbstractFormatter。NumberFormatter 用于 Number，DateFormatter 用于 Dates，其他值将使用 DefaultFormatter。

这是一个 JavaBeans 绑定 (bound) 属性。

参数：

tf - 用于查找 AbstractFormatter 实例的 AbstractFormatterFactory

getFormatterFactory

public JFormattedTextField.AbstractFormatterFactory getFormatterFactory()

返回当前的 AbstractFormatterFactory。

返回：

用于确定 AbstractFormatter 的 AbstractFormatterFactory

另请参见：

setFormatterFactory(javax.swing.JFormattedTextField.AbstractFormatterFactory)

setFormatter

protected void setFormatter(JFormattedTextField.AbstractFormatter format)

设置当前的 AbstractFormatter。

通常不应调用此方法，而是设置 AbstractFormatterFactory 或设置值。当 JFormattedTextField 的状态更改并且需要重置该值时，JFormattedTextField 将调用此方法。JFormattedTextField 传入从 AbstractFormatterFactory 所获得的 AbstractFormatter。

这是一个 JavaBeans 绑定属性。

参数：

format - 进行格式化所使用的 AbstractFormatter

另请参见：

setFormatterFactory(javax.swing.JFormattedTextField.AbstractFormatterFactory)

getFormatter

public JFormattedTextField.AbstractFormatter getFormatter()

返回用于格式化和分析当前值的 AbstractFormatter。

返回：

用于进行格式化的 AbstractFormatter

setValue

public void setValue(Object value)

设置值，该值由从当前 AbstractFormatterFactory 获得的 AbstractFormatter 进行格式化。如果尚未指定任何 AbstractFormatterFactory，则此方法会试图根据 value 的类型创建它。

此属性的默认值为 null。

这是一个 JavaBeans 绑定属性。

参数：

value - 要显示的当前值

getValue

public Object getValue()

返回最后一个有效值。根据 AbstractFormatter 的编辑策略，此方法可能不会返回当前值。可通过调用 commitEdit 后调用 getValue 来获得当前编辑的值。

返回：

最后一个有效值

commitEdit

public void commitEdit()
                throws ParseException

强制从 AbstractFormatter 获得当前值并将其设置为当前值。 如果当前没有已安装的 AbstractFormatter，则此方法无效。

抛出：

ParseException - 如果 AbstractFormatter 无法格式化当前值

isEditValid

public boolean isEditValid()

如果所编辑的当前值有效，则返回 true。此值由当前的 AbstractFormatter 进行管理，并且没有针对它的公共 setter。

返回：

如果所编辑的当前值有效，则返回 true。

invalidEdit

protected void invalidEdit()

用户输入无效值时调用。这就使得组件可以提供反馈。默认的实现是发出蜂鸣声。

processInputMethodEvent

protected void processInputMethodEvent(InputMethodEvent e)

处理所有的输入法事件，如 InputMethodEvent.INPUT_METHOD_TEXT_CHANGED 或 InputMethodEvent.CARET_POSITION_CHANGED。

覆盖：

类 JTextComponent 中的 processInputMethodEvent

参数：

e - InputMethodEvent

另请参见：

InputMethodEvent

processFocusEvent

protected void processFocusEvent(FocusEvent e)

处理所有的焦点事件，如 FocusEvent.FOCUS_GAINED 或 FocusEvent.FOCUS_LOST。

覆盖：

类 Component 中的 processFocusEvent

参数：

e - FocusEvent

另请参见：

FocusEvent

getActions

public Action[] getActions()

获取编辑器的命令列表。这是嵌入的 UI 所支持的命令列表，该 UI 通过编辑器本身支持的命令集进行扩充。这些命令对于绑定到事件是很有用的，例如在 keymap 中。

覆盖：

类 JTextField 中的 getActions

返回：

命令列表

getUIClassID

public String getUIClassID()

获得 UI 的类 ID。

覆盖：

类 JTextField 中的 getUIClassID

返回：

字符串 "FormattedTextFieldUI"

另请参见：

JComponent.getUIClassID()

setDocument

public void setDocument(Document doc)

将该编辑器与某个文本文档关联。使用当前已注册的工厂构建一个文档视图，重新确认后由编辑器显示该文档。PropertyChange 事件 ("document") 被传播到每个侦听器。

覆盖：

类 JTextField 中的 setDocument

参数：

doc - 要显示/编辑的文档

另请参见：

JTextComponent.getDocument()

版权所有 2007 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。另请参阅文档重新分发政策。