Класс 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

Это лёгкий компонент, позволяющий редактировать одну строку текста, где отображение указывает, что что-то было введено, но не показывает исходные символы. Дополнительную информацию и примеры можно найти в Руководстве по использованию текстовых полей в учебнике Java.

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

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

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

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

С:
1.2
См. также:
Сериализованная форма

Вложенные классы

Модификатор и тип Класс Описание
protected class  JPasswordField.AccessibleJPasswordField

Этот класс реализует поддержку доступности для класса JPasswordField.

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

JTextField.AccessibleJTextField

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

JTextComponent.AccessibleJTextComponent, JTextComponent.DropLocation, JTextComponent.KeyBinding

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

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

Поля

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

notifyAction

Поля, объявленные в классе javax.swing.text.JTextComponent

DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY

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

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

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

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

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

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

Поля, объявленные в интерфейсе javax.swing.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, с документом по умолчанию, текстом для начала, и шириной колонки 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()

Устарело.

Начиная с Java 2 platform v1.2, заменено на getPassword.

String getText​(int offs, int len)

Устарело.

Начиная с Java 2 platform v1.2, заменено на getPassword.

String getUIClassID()

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

protected String paramString()

Возвращает строковое представление этого JPasswordField.

void setEchoChar​(char c)

Устанавливает символ эха для этого JPasswordField.

void updateUI()

Перезагружает подключаемый UI.

Методы, объявленные в классе javax.swing.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

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

addCaretListener, addKeymap, fireCaretUpdate, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getDropLocation, getDropMode, getFocusAccelerator, getHighlighter, 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, setText, setUI, viewToModel, viewToModel2D, write

Методы, объявленные в классе javax.swing.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, 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

Методы, объявленные в классе java.awt.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

Методы, объявленные в классе java.awt.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, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, 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

Методы, объявленные в классе java.lang.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, использующий заданную модель хранения текста и заданное количество столбцов. Это конструктор, посредством которого питаются другие конструкторы. Символ эха устанавливается в '*', но может быть изменён текущим Look and Feel. Если модель документа null, будет создана модель по умолчанию.

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

Методы

getUIClassID

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

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

Переопределяет:
getUIClassID в классе JTextField
Возвращает:
строку "PasswordFieldUI"
См. также:
JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

updateUI

public void updateUI()

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

Переопределяет:
updateUI в классе JTextComponent
С момента:
1.6
См. также:
JComponent.setUI(javax.swing.plaf.ComponentUI), UIManager.getLookAndFeel(), UIManager.getUI(javax.swing.JComponent)

getEchoChar

public char getEchoChar()

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

Возвращает:
символ эха, 0, если не задан
См. также:
setEchoChar(char), echoCharIsSet()

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(), getEchoChar()

echoCharIsSet

public boolean echoCharIsSet()

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

Возвращает:
true, если для эха установлен символ
См. также:
setEchoChar(char), getEchoChar()

cut

public void cut()

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

Переопределяет:
cut в классе JTextComponent
См. также:
Toolkit.getSystemClipboard(), Clipboard

copy

public void copy()

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

Переопределяет:
copy в классе JTextComponent
См. также:
Toolkit.getSystemClipboard(), Clipboard

getText

@Deprecated
public String getText()
Устарело.
С Java 2 platform v1.2, заменено на getPassword.

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

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

Переопределяет:
getText в классе JTextComponent
Возвращает:
текст
См. также:
JTextComponent.setText(java.lang.String)

getText

@Deprecated
public String getText(int offs,
                      int len)
               throws BadLocationException
Устарело.
С Java 2 platform v1.2, заменено на getPassword.

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

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

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

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, 2020, 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/11/docs/api/java.desktop/javax/swing/JPasswordField.html

Spec-Zone .ru
спецификации, руководства, описания, API