Package io.jmix.ui.component.impl

Class PasswordFieldImpl

java.lang.Object

io.jmix.ui.component.impl.AbstractComponent<T>

io.jmix.ui.component.impl.AbstractValueComponent<T,P,V>

io.jmix.ui.component.impl.AbstractField<JmixPasswordField,String,String>

io.jmix.ui.component.impl.PasswordFieldImpl

All Implemented Interfaces:

AttachNotifier, Buffered, Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, HasValueSource<String>, Field<String>, HasContextHelp, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasInputPrompt, HasValidator<String>, HasValue<String>, PasswordField, Requirable, TextInputField<String>, TextInputField.HtmlNameSupported, TextInputField.MaxLengthLimited, TextInputField.TextChangeNotifier, Validatable, org.springframework.beans.factory.InitializingBean

public class PasswordFieldImpl
extends AbstractField<JmixPasswordField,String,String>
implements PasswordField, org.springframework.beans.factory.InitializingBean

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
protected CapsLockIndicator	capsLockIndicator

Fields inherited from class io.jmix.ui.component.impl.AbstractField

editable, parentEditableChangeListener, validators, VALIDATORS_LIST_INITIAL_CAPACITY

Fields inherited from class io.jmix.ui.component.impl.AbstractValueComponent

internalValue, uiTestIdsSupport, valueBinding

Fields inherited from class io.jmix.ui.component.impl.AbstractComponent

alignment, applicationContext, component, contextHelpIconClickHandler, contextHelpIconClickListener, descriptionAsHtml, element, frame, htmlSanitizerEnabled, icon, ICON_STYLE, id, parent

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

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

NAME

Constructor Summary

Constructors

Constructor	Description
PasswordFieldImpl()

Method Summary

Modifier and Type	Method	Description
Subscription	addTextChangeListener(Consumer<TextInputField.TextChangeEvent> listener)	Adds a listener that is fired when the component value is changed.
void	afterPropertiesSet()
void	commit()	Updates all changes since the previous commit to the data source.
protected void	componentValueChanged(String prevComponentValue, String newComponentValue, boolean isUserOriginated)
protected String	convertToModel(String componentRawValue)
protected String	convertToPresentation(String modelValue)
protected JmixPasswordField	createComponent()
void	discard()	Discards all changes since last commit.
protected void	fireTextChangeEvent(String newComponentValue)
void	focus()	Sets focus to this component
CapsLockIndicator	getCapsLockIndicator()
String	getHtmlName()
String	getInputPrompt()
int	getMaxLength()
int	getTabIndex()	Gets the tabulator index of the HasTabIndex component.
TextInputField.TextChangeEventMode	getTextChangeEventMode()
int	getTextChangeTimeout()	Gets the timeout used to fire TextInputField.TextChangeEvents and HasValue.ValueChangeEvents when the TextInputField.TextChangeNotifier.getTextChangeEventMode() is TextInputField.TextChangeEventMode.LAZY or TextInputField.TextChangeEventMode.TIMEOUT.
protected void	initComponent(JmixPasswordField component)
boolean	isAutocomplete()	Return autocomplete attribute value to specify saving it in browser.
boolean	isBuffered()
boolean	isEmpty()
boolean	isModified()	Tests if the value stored in the object has been modified since it was last updated from the data source.
void	setAutocomplete(Boolean value)	Set autocomplete attribute value to specify saving it in browser.
void	setBuffered(boolean buffered)	Sets the buffered mode.
void	setCapsLockIndicator(CapsLockIndicator capsLockIndicator)	Sets CapsLockIndicator component, that will be indicate when caps lock key is active.
void	setHtmlName(String htmlName)	Sets the given htmlName as a value of "name" HTML attribute.
void	setInputPrompt(String inputPrompt)	Sets the input prompt - a textual prompt that is displayed when the field would otherwise be empty, to prompt the user for input.
void	setMaxLength(int value)
void	setTabIndex(int tabIndex)	Sets the tabulator index of the Focusable component.
void	setTextChangeEventMode(TextInputField.TextChangeEventMode mode)	Sets the mode how the TextField triggers TextInputField.TextChangeEvents and HasValue.ValueChangeEvents.
void	setTextChangeTimeout(int timeout)	The text change timeout modifies how often text change events are communicated to the application when TextInputField.TextChangeNotifier.getTextChangeEventMode() is TextInputField.TextChangeEventMode.LAZY or TextInputField.TextChangeEventMode.TIMEOUT.
protected void	valueBindingConnected(ValueSource<String> valueSource)

Methods inherited from class io.jmix.ui.component.impl.AbstractField

addValidator, attachValueChangeListener, getDatatypeConversionErrorMsg, getDefaultRequiredMessage, getErrorMessage, getRequiredMessage, getValidators, isEditable, isRequired, isValid, removeValidator, setEditable, setEditableToComponent, setParent, setRequired, setRequiredMessage, setupComponentErrorProvider, triggerValidators, validate

Methods inherited from class io.jmix.ui.component.impl.AbstractValueComponent

addValueChangeListener, fieldValueEquals, getValue, getValueSource, setUiTestId, setUiTestIdsSupport, setValue, setValueSource, setValueToPresentation, valueBindingActivated

Methods inherited from class io.jmix.ui.component.impl.AbstractComponent

addAttachListener, addDetachListener, addStyleName, assignDebugId, attached, detached, getAlignment, getCaption, getComponent, getComposition, getContextHelpIconClickHandler, getContextHelpText, getDebugId, getDescription, getEventHub, getFrame, getHeight, getHeightSizeUnit, getHtmlSanitizer, getIcon, getIconName, getIconResource, getId, getParent, getStyleName, getUiComponentProperties, getUiProperties, getWidth, getWidthSizeUnit, getXmlDescriptor, hasSubscriptions, hasValidationError, isAttached, isCaptionAsHtml, isContextHelpTextHtmlEnabled, isDescriptionAsHtml, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, onContextHelpIconClick, publish, removeStyleName, sanitize, setAlignment, setApplicationContext, setCaption, setCaptionAsHtml, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled, setDebugId, setDescription, setDescriptionAsHtml, setEnabled, setFrame, setHeight, setHtmlSanitizerEnabled, setIcon, setIconFromSet, setId, setResponsive, setStyleName, setValidationError, setVisible, setWidth, setXmlDescriptor, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from class java.lang.Object

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

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

isFocusable, setFocusable

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.HasValidator

addValidator, addValidators, getValidators, removeValidator

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

addValueChangeListener, clear, getEmptyValue, getValue, 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.Validatable

isValid, isValidateOnCommit, validate

Field Details

capsLockIndicator

protected CapsLockIndicator capsLockIndicator

Constructor Details

PasswordFieldImpl

public PasswordFieldImpl()

Method Details

valueBindingConnected

protected void valueBindingConnected(ValueSource<String> valueSource)

Overrides:

valueBindingConnected in class AbstractValueComponent<JmixPasswordField,String,String>

createComponent

protected JmixPasswordField createComponent()

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

initComponent

protected void initComponent(JmixPasswordField component)

convertToPresentation

protected String convertToPresentation(@Nullable
 String modelValue)
                                throws ConversionException

Overrides:

convertToPresentation in class AbstractValueComponent<JmixPasswordField,String,String>

Throws:

ConversionException

convertToModel

@Nullable
protected String convertToModel(@Nullable
 String componentRawValue)
                         throws ConversionException

Overrides:

convertToModel in class AbstractValueComponent<JmixPasswordField,String,String>

Throws:

ConversionException

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface HasValue<String>

getMaxLength

public int getMaxLength()

Specified by:

getMaxLength in interface TextInputField.MaxLengthLimited

setMaxLength

public void setMaxLength(int value)

Specified by:

setMaxLength in interface TextInputField.MaxLengthLimited

isAutocomplete

public boolean isAutocomplete()

Description copied from interface: PasswordField

Return autocomplete attribute value to specify saving it in browser.

Specified by:

isAutocomplete in interface PasswordField

setAutocomplete

public void setAutocomplete(Boolean value)

Description copied from interface: PasswordField

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

Specified by:

setAutocomplete in interface PasswordField

focus

public void focus()

Description copied from interface: Component.Focusable

Sets focus to this component

Specified by:

focus in interface Component.Focusable

getTabIndex

public int getTabIndex()

Description copied from interface: Component.Focusable

Gets the tabulator index of the HasTabIndex component.

Specified by:

getTabIndex in interface Component.Focusable

Returns:

tab index set for the HasTabIndex component

setTabIndex

public void setTabIndex(int tabIndex)

Description copied from interface: Component.Focusable

Sets the tabulator index of the Focusable component. The tab index property is used to specify the order in which the fields are focused when the user presses the Tab key. Components with a defined tab index are focused sequentially first, and then the components with no tab index.

Specified by:

setTabIndex in interface Component.Focusable

Parameters:

tabIndex - tab index

commit

public void commit()

Description copied from interface: Buffered

Updates all changes since the previous commit to the data source.

Specified by:

commit in interface Buffered

Overrides:

commit in class AbstractValueComponent<JmixPasswordField,String,String>

discard

public void discard()

Description copied from interface: Buffered

Discards all changes since last commit. The object updates its value from the data source.

Specified by:

discard in interface Buffered

Overrides:

discard in class AbstractValueComponent<JmixPasswordField,String,String>

isBuffered

public boolean isBuffered()

Specified by:

isBuffered in interface Buffered

Overrides:

isBuffered in class AbstractValueComponent<JmixPasswordField,String,String>

Returns:

true if buffered mode is on, false otherwise

setBuffered

public void setBuffered(boolean buffered)

Description copied from interface: Buffered

Sets the buffered mode.

When in buffered mode, an internal buffer will be used to store changes until Buffered.commit() is called. Calling Buffered.discard() will revert the internal buffer to the value of the data source.

When in non-buffered mode both read and write operations will be done directly on the data source. In this mode the Buffered.commit() and Buffered.discard() methods serve no purpose.

Specified by:

setBuffered in interface Buffered

Overrides:

setBuffered in class AbstractValueComponent<JmixPasswordField,String,String>

Parameters:

buffered - true if buffered mode should be turned on, false otherwise

isModified

public boolean isModified()

Description copied from interface: Buffered

Tests if the value stored in the object has been modified since it was last updated from the data source.

Specified by:

isModified in interface Buffered

Overrides:

isModified in class AbstractValueComponent<JmixPasswordField,String,String>

Returns:

true if the value in the object has been modified since the last data source update, false if not.

setCapsLockIndicator

public void setCapsLockIndicator(@Nullable
 CapsLockIndicator capsLockIndicator)

Description copied from interface: PasswordField

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

Specified by:

setCapsLockIndicator in interface PasswordField

Parameters:

capsLockIndicator - capsLockIndicator component

componentValueChanged

protected void componentValueChanged(String prevComponentValue,
 String newComponentValue,
 boolean isUserOriginated)

Overrides:

componentValueChanged in class AbstractValueComponent<JmixPasswordField,String,String>

fireTextChangeEvent

protected void fireTextChangeEvent(String newComponentValue)

setTextChangeTimeout

public void setTextChangeTimeout(int timeout)

Description copied from interface: TextInputField.TextChangeNotifier

The text change timeout modifies how often text change events are communicated to the application when TextInputField.TextChangeNotifier.getTextChangeEventMode() is TextInputField.TextChangeEventMode.LAZY or TextInputField.TextChangeEventMode.TIMEOUT.

Specified by:

setTextChangeTimeout in interface TextInputField.TextChangeNotifier

Parameters:

timeout - timeout in milliseconds

addTextChangeListener

public Subscription addTextChangeListener(Consumer<TextInputField.TextChangeEvent> listener)

Description copied from interface: TextInputField.TextChangeNotifier

Adds a listener that is fired when the component value is changed.

Specified by:

addTextChangeListener in interface TextInputField.TextChangeNotifier

Parameters:

listener - a listener to add

Returns:

a Subscription object

getTextChangeTimeout

public int getTextChangeTimeout()

Description copied from interface: TextInputField.TextChangeNotifier

Gets the timeout used to fire TextInputField.TextChangeEvents and HasValue.ValueChangeEvents when the TextInputField.TextChangeNotifier.getTextChangeEventMode() is TextInputField.TextChangeEventMode.LAZY or TextInputField.TextChangeEventMode.TIMEOUT.

Specified by:

getTextChangeTimeout in interface TextInputField.TextChangeNotifier

Returns:

timeout in milliseconds

getTextChangeEventMode

public TextInputField.TextChangeEventMode getTextChangeEventMode()

Specified by:

getTextChangeEventMode in interface TextInputField.TextChangeNotifier

Returns:

the mode used to trigger TextInputField.TextChangeEvents and HasValue.ValueChangeEvents.

setTextChangeEventMode

public void setTextChangeEventMode(TextInputField.TextChangeEventMode mode)

Description copied from interface: TextInputField.TextChangeNotifier

Sets the mode how the TextField triggers TextInputField.TextChangeEvents and HasValue.ValueChangeEvents.

Specified by:

setTextChangeEventMode in interface TextInputField.TextChangeNotifier

Parameters:

mode - the new mode

getCapsLockIndicator

@Nullable
public CapsLockIndicator getCapsLockIndicator()

Specified by:

getCapsLockIndicator in interface PasswordField

Returns:

capsLockIndicator component

getInputPrompt

@Nullable
public String getInputPrompt()

Specified by:

getInputPrompt in interface HasInputPrompt

Returns:

current input prompt.

setInputPrompt

public void setInputPrompt(@Nullable
 String inputPrompt)

Description copied from interface: HasInputPrompt

Sets the input prompt - a textual prompt that is displayed when the field would otherwise be empty, to prompt the user for input.

Specified by:

setInputPrompt in interface HasInputPrompt

Parameters:

inputPrompt - input prompt

setHtmlName

public void setHtmlName(@Nullable
 String htmlName)

Description copied from interface: TextInputField.HtmlNameSupported

Sets the given htmlName as a value of "name" HTML attribute.

Specified by:

setHtmlName in interface TextInputField.HtmlNameSupported

Parameters:

htmlName - name

getHtmlName

@Nullable
public String getHtmlName()

Specified by:

getHtmlName in interface TextInputField.HtmlNameSupported

Returns:

a value of "name" HTML attribute