Package io.jmix.ui.component

Interface CapsLockIndicator

All Superinterfaces:

Component

All Known Implementing Classes:

CapsLockIndicatorImpl

@StudioComponent(caption="CapsLockIndicator",
                 xmlElement="capsLockIndicator",
                 category="Components",
                 icon="io/jmix/ui/icon/component/capsLockIndicator.svg",
                 documentationURL="https://docs.jmix.io/jmix/%VERSION%/ui/vcl/components/caps-lock-indicator.html",
                 unsupportedProperties={"enable","responsive"})
public interface CapsLockIndicator
extends Component

Component shows if CapsLock key is enabled when user inputs password.

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

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
String	getCapsLockOffMessage()
String	getCapsLockOnMessage()
void	setCapsLockOffMessage(String capsLockOffMessage)	Sets the message that will be shown when caps lock key is not active.
void	setCapsLockOnMessage(String capsLockOnMessage)	Sets the message that will be shown when caps lock key is active.

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

Field Details

NAME

static final String NAME

See Also:

• Constant Field Values

Method Details

setCapsLockOnMessage

@StudioProperty(type=LOCALIZED_STRING)
void setCapsLockOnMessage(@Nullable
 String capsLockOnMessage)

Sets the message that will be shown when caps lock key is active.

Parameters:

capsLockOnMessage - text message

getCapsLockOnMessage

@Nullable
String getCapsLockOnMessage()

Returns:

message that is shown when caps lock key is active

setCapsLockOffMessage

@StudioProperty(type=LOCALIZED_STRING)
void setCapsLockOffMessage(@Nullable
 String capsLockOffMessage)

Sets the message that will be shown when caps lock key is not active.

Parameters:

capsLockOffMessage - text message

getCapsLockOffMessage

@Nullable
String getCapsLockOffMessage()

Returns:

message that is shown when caps lock key is not active