Package io.jmix.ui.component

Interface PasswordField

All Superinterfaces:

Buffered, Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Field<String>, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasInputPrompt, HasValidator<String>, HasValue<String>, HasValueSource<String>, Requirable, TextInputField<String>, TextInputField.HtmlNameSupported, TextInputField.MaxLengthLimited, TextInputField.TextChangeNotifier, Validatable

All Known Implementing Classes:

PasswordFieldImpl

@StudioComponent(caption="PasswordField",
                 category="Components",
                 xmlElement="passwordField",
                 icon="io/jmix/ui/icon/component/passwordField.svg",
                 canvasBehaviour=INPUT_FIELD,
                 documentationURL="https://docs.jmix.io/jmix/%VERSION%/ui/vcl/components/password-field.html")
public interface PasswordField
extends TextInputField<String>, TextInputField.MaxLengthLimited, HasInputPrompt, TextInputField.TextChangeNotifier, TextInputField.HtmlNameSupported

A field that is used to enter secret text information like passwords. The entered text is not displayed on the screen.

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasValue

HasValue.ValueChangeEvent<V>

Nested classes/interfaces inherited from interface io.jmix.ui.component.TextInputField

TextInputField.CaseConversion, TextInputField.CaseConversionSupported, TextInputField.CursorPositionSupported, TextInputField.EnterPressEvent, TextInputField.EnterPressNotifier, TextInputField.HtmlNameSupported, TextInputField.MaxLengthLimited, TextInputField.TextChangeEvent, TextInputField.TextChangeEventMode, TextInputField.TextChangeNotifier, TextInputField.TextSelectionSupported, TextInputField.TrimSupported

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method	Description
CapsLockIndicator	getCapsLockIndicator()
boolean	isAutocomplete()	Return autocomplete attribute value to specify saving it in browser.
void	setAutocomplete(Boolean autocomplete)	Set autocomplete attribute value to specify saving it in browser.
void	setCapsLockIndicator(CapsLockIndicator capsLockIndicator)	Sets CapsLockIndicator component, that will be indicate when caps lock key is active.

Methods inherited from interface io.jmix.ui.component.Buffered

commit, discard, isBuffered, isModified, setBuffered

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.Component.Editable

isEditable, isEditableWithParent, setEditable

Methods inherited from interface io.jmix.ui.component.Component.Focusable

focus, getTabIndex, isFocusable, setFocusable, setTabIndex

Methods inherited from interface io.jmix.ui.component.Component.HasCaption

getCaption, setCaption

Methods inherited from interface io.jmix.ui.component.Component.HasDescription

getDescription, setDescription

Methods inherited from interface io.jmix.ui.component.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface io.jmix.ui.component.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface io.jmix.ui.component.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface io.jmix.ui.component.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface io.jmix.ui.component.HasHtmlSanitizer

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Methods inherited from interface io.jmix.ui.component.HasInputPrompt

getInputPrompt, setInputPrompt

Methods inherited from interface io.jmix.ui.component.HasValidator

addValidator, addValidators, getValidators, removeValidator

Methods inherited from interface io.jmix.ui.component.HasValue

addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, setValue

Methods inherited from interface io.jmix.ui.component.data.HasValueSource

getValueSource, setValueSource

Methods inherited from interface io.jmix.ui.component.Requirable

getRequiredMessage, isRequired, setRequired, setRequiredMessage

Methods inherited from interface io.jmix.ui.component.TextInputField.HtmlNameSupported

getHtmlName, setHtmlName

Methods inherited from interface io.jmix.ui.component.TextInputField.MaxLengthLimited

getMaxLength, setMaxLength

Methods inherited from interface io.jmix.ui.component.TextInputField.TextChangeNotifier

addTextChangeListener, getTextChangeEventMode, getTextChangeTimeout, setTextChangeEventMode, setTextChangeTimeout

Methods inherited from interface io.jmix.ui.component.Validatable

isValid, isValidateOnCommit, validate

Field Details

NAME

static final String NAME

See Also:

• Constant Field Values

Method Details

isAutocomplete

boolean isAutocomplete()

Return autocomplete attribute value to specify saving it in browser.

setAutocomplete

@StudioProperty(defaultValue="false")
void setAutocomplete(Boolean autocomplete)

Set autocomplete attribute value to specify saving it in browser. False value disables saving passwords in browser.

setCapsLockIndicator

@StudioProperty(type=COMPONENT_REF,
                options="io.jmix.ui.component.CapsLockIndicator")
void setCapsLockIndicator(@Nullable
 CapsLockIndicator capsLockIndicator)

Sets CapsLockIndicator component, that will be indicate when caps lock key is active.

Parameters:

capsLockIndicator - capsLockIndicator component

getCapsLockIndicator

@Nullable
CapsLockIndicator getCapsLockIndicator()

Returns:

capsLockIndicator component