Class BaseCredentialsComponent
java.lang.Object
velox.api.layer0.credentialscomponents.MultiCredentialsComponent
velox.api.layer0.credentialscomponents.BaseCredentialsComponent
- All Implemented Interfaces:
CredentialsComponent
- Direct Known Subclasses:
CredentialsCheckbox
,CredentialsDropdown
,CredentialsTextField
public abstract class BaseCredentialsComponent extends MultiCredentialsComponent
An abstract implementation of
CredentialsComponent
.
It serves as a basis for a one-value component (like a text field or a check box)-
Field Summary
Fields Modifier and Type Field Description protected boolean
isKey
seeCredentialsSerializationField.isKey
protected boolean
isListening
Changing its value allows to suspendsettingsChangedListeners
in theonStatusChanged()
methodprotected java.lang.String
name
A name forBaseCredentialsComponent
.protected java.util.List<java.lang.Runnable>
settingsChangedListeners
Contains listeners to be triggered on settings changeFields inherited from class velox.api.layer0.credentialscomponents.MultiCredentialsComponent
aliases, components, panel
-
Constructor Summary
Constructors Constructor Description BaseCredentialsComponent(java.lang.String name, boolean isKey)
-
Method Summary
Modifier and Type Method Description void
addSettingsChangedListener(java.lang.Runnable listener)
Adds a listener to be triggered on settings changejava.lang.String
getName()
boolean
isKey()
protected void
onStatusChanged()
Defines behavior on field change.void
setName(java.lang.String name)
Methods inherited from class velox.api.layer0.credentialscomponents.MultiCredentialsComponent
addAlias, getAliases, getCompoundComponent
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface velox.api.layer0.credentialscomponents.CredentialsComponent
getValues, setValues
-
Field Details
-
name
protected java.lang.String nameA name forBaseCredentialsComponent
. It will serve as a key for maps inCredentialsComponent.getValues()
andCredentialsComponent.setValues(java.util.Map)
methods.Please note, field names should be unique in the connection scope.
Please also note, a
BaseCredentialsComponent
is a one-field component (a user is supposed to fill one field e.g. a textBox or pick a drop down element) In any multi-field component there should be a separate name for every field a user can configure. -
isKey
protected boolean isKeyseeCredentialsSerializationField.isKey
-
settingsChangedListeners
protected java.util.List<java.lang.Runnable> settingsChangedListenersContains listeners to be triggered on settings change -
isListening
protected boolean isListeningChanging its value allows to suspendsettingsChangedListeners
in theonStatusChanged()
method
-
-
Constructor Details
-
BaseCredentialsComponent
public BaseCredentialsComponent(java.lang.String name, boolean isKey)- Parameters:
name
- seename
isKey
- seeCredentialsSerializationField.isKey
-
-
Method Details
-
getName
public java.lang.String getName() -
setName
public void setName(java.lang.String name) -
addSettingsChangedListener
public void addSettingsChangedListener(java.lang.Runnable listener)Adds a listener to be triggered on settings change -
onStatusChanged
protected void onStatusChanged()Defines behavior on field change. Normally, every listener ofsettingsChangedListeners
is triggered. -
isKey
public boolean isKey()
-