org.sourceid.saml20.adapter.gui
Class TextFieldDescriptor

java.lang.Object
  org.sourceid.saml20.adapter.gui.FieldDescriptor
      org.sourceid.saml20.adapter.gui.TextFieldDescriptor

All Implemented Interfaces:

java.io.Serializable

public class TextFieldDescriptor
extends FieldDescriptor

A field descriptor that will render a text field on the GUI configuration screen.

Author:

Brian Campbell

See Also:

AdapterConfigurationGuiDescriptor.addField(FieldDescriptor), AdapterConfigurationGuiDescriptor.addAdvancedField(FieldDescriptor), TableDescriptor.addRowField(FieldDescriptor), Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.sourceid.saml20.adapter.gui.FieldDescriptor

FieldDescriptor.FieldValidationWrapper

Constructor Summary

TextFieldDescriptor(java.lang.String name, java.lang.String description)
Create a new TextFieldDescriptor.

TextFieldDescriptor(java.lang.String name, java.lang.String description, boolean encrypted)
Create a new TextFieldDescriptor.

Method Summary

int	getSize() The display size of this field on the screen
boolean	isEncrypted() Encrypt this text field?
void	setSize(int size) Sets the display size of this field on the screen

Methods inherited from class org.sourceid.saml20.adapter.gui.FieldDescriptor

addValidator, addValidator, getDefaultValue, getDescription, getName, getValidationChain, setDefaultValue

Methods inherited from class java.lang.Object

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

Constructor Detail

TextFieldDescriptor

public TextFieldDescriptor(java.lang.String name,
                           java.lang.String description)

Create a new TextFieldDescriptor. This is same to using the constructor TextFieldDescriptor(String, String, boolean) with false for the last argument.

TextFieldDescriptor

public TextFieldDescriptor(java.lang.String name,
                           java.lang.String description,
                           boolean encrypted)

Create a new TextFieldDescriptor.

Parameters:

name - the field name (must be unique per AdapterConfigurationGuiDescriptor or TableDescriptor).

description - a helpful description of the field.

encrypted - should this field encrypt the value (render it as a password field in the GUI and encrypt the value in the backing configuration file).

Method Detail

isEncrypted

public boolean isEncrypted()

Encrypt this text field?

getSize

public int getSize()

The display size of this field on the screen

setSize

public void setSize(int size)

Sets the display size of this field on the screen