velox.api.layer0.credentialscomponents

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 and Description
protected boolean	isKey see CredentialsSerializationField.isKey
protected boolean	isListening Changing its value allows to suspend settingsChangedListeners in the onStatusChanged() method
protected java.lang.String	name A name for BaseCredentialsComponent.
protected java.util.List<java.lang.Runnable>	settingsChangedListeners Contains listeners to be triggered on settings change

Fields inherited from class velox.api.layer0.credentialscomponents.MultiCredentialsComponent

aliases, components, panel

Constructor Summary

Constructors

Constructor and Description
BaseCredentialsComponent(java.lang.String name, boolean isKey)

Method Summary

Modifier and Type	Method and Description
void	addSettingsChangedListener(java.lang.Runnable listener) Adds a listener to be triggered on settings change
java.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 Detail

name

protected java.lang.String name

A name for BaseCredentialsComponent. It will serve as a key for maps in CredentialsComponent.getValues() and CredentialsComponent.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 isKey

see CredentialsSerializationField.isKey

settingsChangedListeners

protected java.util.List<java.lang.Runnable> settingsChangedListeners

Contains listeners to be triggered on settings change

isListening

protected boolean isListening

Changing its value allows to suspend settingsChangedListeners in the onStatusChanged() method

Constructor Detail

BaseCredentialsComponent

public BaseCredentialsComponent(java.lang.String name,
                                boolean isKey)

Parameters:

name - see name

isKey - see CredentialsSerializationField.isKey

Method Detail

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 of settingsChangedListeners is triggered.

isKey

public boolean isKey()