Класс JPasswordField

javax.swing.JPasswordField

Все реализуемые интерфейсы:: ImageObserver, MenuContainer, Serializable, Accessible, Scrollable, SwingConstants

@JavaBean(description="Allows the editing of a line of text but doesn't show the characters.") public class JPasswordField extends JTextField

JPasswordField — это легковесный компонент, позволяющий редактировать одну строку текста. При вводе символов отображается их представление, но исходные символы не показываются. Дополнительную информацию и примеры см. в разделе Использование текстовых полей учебника The Java Tutorial.

JPasswordField предназначен для обеспечения совместимости исходного кода с java.awt.TextField, используемым с набором echoChar. Он предоставляется отдельно, чтобы можно было безопасно изменять пользовательский интерфейс для JTextField, не затрагивая поля для ввода пароля.

ПРИМЕЧАНИЕ: По умолчанию JPasswordField отключает методы ввода, поскольку в противном случае вводимые символы могли бы быть видны во время их составления с помощью методов ввода. Если приложению необходима поддержка методов ввода, используйте унаследованный метод enableInputMethods(true).

Предупреждение: JPasswordField не показывает введённые символы, а вместо них отображает альтернативный текст или графические элементы. Однако это не предотвращает появление пароля в системной памяти. Сведения об обработке конфиденциальной информации, например текста пароля, см. в соответствующем разделе Рекомендаций по безопасному кодированию.

Предупреждение: Swing не является потокобезопасным. Дополнительные сведения см. в разделе Политика Swing в отношении потоков.

Предупреждение: Сериализованные объекты этого класса не будут совместимы с будущими выпусками Swing. Текущая поддержка сериализации подходит для кратковременного хранения или RMI между приложениями, работающими с одной и той же версией Swing. Начиная с версии 1.4, в пакет java.beans добавлена поддержка длительного хранения всех JavaBeans. См. XMLEncoder.

Начиная с версии:: 1.2

Краткое описание вложенных классов

Модификатор и тип	Класс	Описание
`protected class`	`JPasswordField.AccessibleJPasswordField`	Этот класс реализует поддержку специальных возможностей для класса `JPasswordField`.

Вложенные классы и интерфейсы, объявленные в классе JTextField

JTextField.AccessibleJTextField

Вложенные классы и интерфейсы, объявленные в классе JTextComponent

JTextComponent.AccessibleJTextComponent, JTextComponent.DropLocation, JTextComponent.KeyBinding

Вложенные классы и интерфейсы, объявленные в классе JComponent

JComponent.AccessibleJComponent

Вложенные классы и интерфейсы, объявленные в классе Container

Container.AccessibleAWTContainer

Вложенные классы и интерфейсы, объявленные в классе Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Краткое описание полей

Поля, объявленные в классе JTextField

notifyAction

Поля, объявленные в классе JTextComponent

DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY

Поля, объявленные в классе JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Поля, объявленные в классе Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Поля, объявленные в интерфейсе ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Поля, объявленные в интерфейсе SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Краткое описание конструкторов

Конструктор	Описание
`JPasswordField()`	Создаёт новый `JPasswordField` со стандартным документом, начальной строкой текста `null` и шириной в 0 столбцов.
`JPasswordField(int columns)`	Создаёт новый пустой `JPasswordField` с указанным числом столбцов.
`JPasswordField(String text)`	Создаёт новый `JPasswordField`, инициализированный указанным текстом.
`JPasswordField(String text, int columns)`	Создаёт новый `JPasswordField`, инициализированный указанным текстом и числом столбцов.
`JPasswordField(Document doc, String txt, int columns)`	Создаёт новый `JPasswordField`, использующий заданную модель хранения текста и указанное число столбцов.

Краткое описание методов

Модификатор и тип	Метод	Описание
`void`	`copy()`	Вызывает `provideErrorFeedback` в текущем оформлении, что обычно приводит к звуковому сигналу ошибки.
`void`	`cut()`	Вызывает `provideErrorFeedback` в текущем оформлении, что обычно приводит к звуковому сигналу ошибки.
`boolean`	`echoCharIsSet()`	Возвращает true, если для этого `JPasswordField` задан символ отображения.
`AccessibleContext`	`getAccessibleContext()`	Возвращает `AccessibleContext`, связанный с этим `JPasswordField`.
`char`	`getEchoChar()`	Возвращает символ, используемый для отображения введённых символов.
`char[]`	`getPassword()`	Возвращает текст, содержащийся в этом `TextComponent`.
`String`	`getText()`	Устарело. Начиная с версии 1.2 платформы Java 2, заменено на `getPassword`.
`String`	`getText(int offs, int len)`	Устарело. Начиная с версии 1.2 платформы Java 2, заменено на `getPassword`.
`String`	`getUIClassID()`	Возвращает имя класса L&F, который отображает этот компонент.
`protected String`	`paramString()`	Возвращает строковое представление этого `JPasswordField`.
`void`	`setEchoChar(char c)`	Задаёт символ отображения для этого `JPasswordField`.
`void`	`setText(String t)`	Задаёт для этого `TextComponent` указанный текст.
`void`	`updateUI()`	Повторно загружает подключаемый пользовательский интерфейс.

Методы, объявленные в классе JTextField

actionPropertyChanged, addActionListener, configurePropertiesFromAction, createActionPropertyChangeListener, createDefaultModel, fireActionPerformed, getAction, getActionListeners, getActions, getColumns, getColumnWidth, getHorizontalAlignment, getHorizontalVisibility, getPreferredSize, getScrollOffset, isValidateRoot, postActionEvent, removeActionListener, scrollRectToVisible, setAction, setActionCommand, setColumns, setDocument, setFont, setHorizontalAlignment, setScrollOffset

Методы, объявленные в классе JTextComponent

addCaretListener, addKeymap, fireCaretUpdate, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getDropLocation, getDropMode, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getPreferredScrollableViewportSize, getPrintable, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getToolTipText, getUI, isEditable, loadKeymap, modelToView, modelToView2D, moveCaretPosition, paste, print, print, print, read, removeCaretListener, removeKeymap, replaceSelection, restoreComposedText, saveComposedText, select, selectAll, setCaret, setCaretColor, setCaretPosition, setDisabledTextColor, setDragEnabled, setDropMode, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setUI, viewToModel, viewToModel2D, write

Методы, объявленные в классе JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Методы, объявленные в классе Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Методы, объявленные в классе Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Методы, объявленные в классе Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Подробное описание конструкторов

JPasswordField

public JPasswordField()

Создаёт новый JPasswordField со стандартным документом, начальной строкой текста null и шириной в 0 столбцов.

JPasswordField

public JPasswordField(String text)

Создаёт новый JPasswordField, инициализированный указанным текстом. Для модели документа задаётся значение по умолчанию, а число столбцов устанавливается равным 0.

Параметры:: text — отображаемый текст; null, если текст отсутствует

JPasswordField

public JPasswordField(int columns)

Создаёт новый пустой JPasswordField с указанным числом столбцов. Создаётся стандартная модель, а начальная строка задаётся равной null.

Параметры:: columns — число столбцов >= 0

JPasswordField

public JPasswordField(String text, int columns)

Создаёт новый JPasswordField, инициализированный указанным текстом и числом столбцов. Для модели документа задаётся значение по умолчанию.

Параметры:: text — отображаемый текст; null, если текст отсутствует; columns — число столбцов >= 0

JPasswordField

public JPasswordField(Document doc, String txt, int columns)

Создаёт новый JPasswordField, использующий заданную модель хранения текста и указанное число столбцов. Через этот конструктор вызываются остальные конструкторы. В качестве символа отображения задаётся '*', но текущее оформление может изменить его. Если модель документа равна null, будет создана модель по умолчанию.

Параметры:: doc — используемое хранилище текста; txt — отображаемый текст; null, если текст отсутствует; columns — число столбцов, используемое для вычисления предпочтительной ширины, >= 0; если число столбцов равно нулю, предпочтительная ширина определяется реализацией компонента

Подробное описание методов

getUIClassID

@BeanProperty(bound=false) public String getUIClassID()

Возвращает имя класса L&F, который отображает этот компонент.

Переопределяет:

getUIClassID в классе JTextField

Возвращает:

строку "PasswordFieldUI"

См. также:

updateUI

public void updateUI()

Повторно загружает подключаемый пользовательский интерфейс. Ключ, используемый для получения нового интерфейса, — getUIClassID(). Тип пользовательского интерфейса — TextUI. После установки пользовательского интерфейса вызывается invalidate.

Переопределяет:

updateUI в классе JTextComponent

Начиная с версии:

1.6

См. также:

getEchoChar

public char getEchoChar()

Возвращает символ, используемый для отображения введённых символов. По умолчанию используется '*'. Значение по умолчанию может отличаться в зависимости от текущего оформления. Например, в оформлении Metal/Ocean по умолчанию используется символ маркера.

Возвращает:

символ отображения; 0, если он не задан

См. также:

setEchoChar

@BeanProperty(bound=false, visualUpdate=true, description="character to display in place of the real characters") public void setEchoChar(char c)

Задаёт символ отображения для этого JPasswordField. Следует учитывать, что это лишь рекомендация, поскольку установленное представление может использовать любые графические средства для отображения поля. Значение 0 означает, что текст должен отображаться по мере ввода, как в стандартном JTextField.

Параметры:

c — отображаемый символ

См. также:

echoCharIsSet

public boolean echoCharIsSet()

Возвращает true, если для этого JPasswordField задан символ отображения. Символ считается заданным, если символ отображения не равен 0.

Возвращает:

true, если символ отображения задан

См. также:

cut

public void cut()

Вызывает provideErrorFeedback в текущем оформлении, что обычно приводит к звуковому сигналу ошибки. Обычное поведение — передача выделенного диапазона связанной текстовой модели в системный буфер обмена и удаление его содержимого из модели — неприемлемо для поля пароля.

Переопределяет:

cut в классе JTextComponent

См. также:

copy

public void copy()

Вызывает provideErrorFeedback в текущем оформлении, что обычно приводит к звуковому сигналу ошибки. Обычное поведение — передача выделенного диапазона связанной текстовой модели в системный буфер обмена с сохранением содержимого в модели — неприемлемо для поля пароля.

Переопределяет:

copy в классе JTextComponent

См. также:

getText

@Deprecated public String getText()

Устарело.

Начиная с версии 1.2 платформы Java 2, заменено на getPassword.

Возвращает текст, содержащийся в этом TextComponent. Если базовый документ равен null, будет выдано NullPointerException.

По соображениям безопасности этот метод устарел. Вместо него используйте метод * getPassword.

Переопределяет:

getText в классе JTextComponent

Возвращает:

текст

См. также:

getText

@Deprecated public String getText(int offs, int len) throws BadLocationException

Устарело.

Начиная с версии 1.2 платформы Java 2, заменено на getPassword.

Извлекает часть текста, представленного компонентом. Возвращает пустую строку, если длина равна 0.

По соображениям безопасности этот метод устарел. Вместо него используйте метод getPassword.

Переопределяет:: getText в классе JTextComponent
Параметры:: offs — смещение >= 0; len — длина >= 0
Возвращает:: текст
Выбрасывает:: BadLocationException — если смещение или длина заданы неверно

setText

@BeanProperty(bound=false, description="the text of this component") public void setText(String t)

Описание скопировано из класса: JTextComponent

Задаёт для этого TextComponent указанный текст. Если текст равен null или пуст, это равносильно простому удалению старого текста. После вставки текста положение каретки определяется реализацией класса каретки.

Обратите внимание, что текст не является связанным свойством, поэтому при его изменении событие PropertyChangeEvent не генерируется. Чтобы отслеживать изменения текста, используйте DocumentListener.

Переопределяет:

setText в классе JTextComponent

Параметры:

t — новый текст

См. также:

getPassword

@BeanProperty(bound=false) public char[] getPassword()

Возвращает текст, содержащийся в этом TextComponent. Если базовый документ равен null, будет выдано NullPointerException. Для повышения безопасности рекомендуется после использования очистить возвращённый массив символов, присвоив каждому символу значение ноль.

Возвращает:: текст

paramString

protected String paramString()

Возвращает строковое представление этого JPasswordField. Этот метод предназначен только для отладки; содержимое и формат возвращаемой строки могут различаться в разных реализациях. Возвращаемая строка может быть пустой, но не может быть null.

Переопределяет:: paramString в классе JTextField
Возвращает:: строковое представление этого JPasswordField

getAccessibleContext

@BeanProperty(bound=false) public AccessibleContext getAccessibleContext()

Возвращает AccessibleContext, связанный с этим JPasswordField. Для полей пароля AccessibleContext имеет вид AccessibleJPasswordField. При необходимости создаётся новый экземпляр AccessibleJPasswordField.

Определён в:: getAccessibleContext в интерфейсе Accessible
Переопределяет:: getAccessibleContext в классе JTextField
Возвращает:: AccessibleJPasswordField, выполняющий роль AccessibleContext этого JPasswordField

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/25/docs/api/java.desktop/javax/swing/JPasswordField.html