Package org.sourceid.saml20.adapter.gui

Class TextAreaFieldDescriptor

java.lang.Object

org.sourceid.saml20.adapter.gui.FieldDescriptor

org.sourceid.saml20.adapter.gui.TextAreaFieldDescriptor

All Implemented Interfaces:

Serializable

public class TextAreaFieldDescriptor
extends FieldDescriptor

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

See Also:

GuiConfigDescriptor.addField(FieldDescriptor), GuiConfigDescriptor.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

Constructors

Constructor	Description
TextAreaFieldDescriptor(String name, String description, int rows, int columns)	Create a new TextAreaFieldDescriptor.

Method Summary

Modifier and Type	Method	Description
int	getColumns()	The number of columns.
int	getRows()	The number of rows.
boolean	isExpression()	Returns a boolean indicating if the text area is an expression in the user interface.
void	setExpression(boolean isExpression)	Sets whether this text area is an expression in the user interface.

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

addValidator, addValidator, getDefaultForLegacyConfig, getDefaultValue, getDescription, getFormattedValue, getLabel, getName, getValidationChain, isHidden, setDefaultForLegacyConfig, setDefaultValue, setHidden, setLabel

Methods inherited from class java.lang.Object

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

Constructor Detail

TextAreaFieldDescriptor

public TextAreaFieldDescriptor(String name,
                               String description,
                               int rows,
                               int columns)

Create a new TextAreaFieldDescriptor.

Parameters:

name - The field name (must be unique per AdapterConfigurationGuiDescriptor or TableDescriptor). This name will also be used as the label for the field in the administrative console. To ensure configuration can be read in future releases of a plugin, it is recommended to not change a field's name - instead use a label to rename it in the administrative console.

description - A helpful description of the field.

rows - The number of rows in the rendered text area.

columns - The number of columns in the rendered text area.

Method Detail

getRows

public int getRows()

The number of rows.

Returns:

the number of rows in the text area

getColumns

public int getColumns()

The number of columns.

Returns:

the number of columns in the text area

isExpression

public boolean isExpression()

Returns a boolean indicating if the text area is an expression in the user interface.

Returns:

true if the text area is an expression

setExpression

public void setExpression(boolean isExpression)

Sets whether this text area is an expression in the user interface.

Parameters:

isExpression - true if this text area should be an expression; false otherwise.