org.opends.quicksetup.ui

Class LabelFieldDescriptor

java.lang.Object

org.opends.quicksetup.ui.LabelFieldDescriptor

public class LabelFieldDescriptor
extends Object

This is a commodity class used to couple a label and a text component with a FieldName. It is mainly used by the QuickSetupStepPanel classes to retrieve easily the labels and fields associated with a FieldName to provide its content or to mark the labels as valid or invalid. It is also used during the creation of the components as it describes the different properties.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LabelFieldDescriptor.FieldType This enum contains the different type of fields that can be associated with this LabelFieldDescriptor.
static class	LabelFieldDescriptor.LabelType This enum contains the different type of labels that can be associated with this LabelFieldDescriptor.

Constructor Summary

Constructors

Constructor and Description
LabelFieldDescriptor(org.forgerock.i18n.LocalizableMessage label, org.forgerock.i18n.LocalizableMessage tooltip, LabelFieldDescriptor.FieldType type, LabelFieldDescriptor.LabelType labelType, int size) Constructor of this LabelFieldDescriptor.

Method Summary

Modifier and Type	Method and Description
org.forgerock.i18n.LocalizableMessage	getLabel() Returns the String displayed by the label.
LabelFieldDescriptor.LabelType	getLabelType() Returns the label type.
int	getSize() Returns the size of the field.
org.forgerock.i18n.LocalizableMessage	getTooltip() Returns the tooltip used in the field.
LabelFieldDescriptor.FieldType	getType() Returns the field type.

Methods inherited from class java.lang.Object

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

Constructor Detail

LabelFieldDescriptor

public LabelFieldDescriptor(org.forgerock.i18n.LocalizableMessage label,
                            org.forgerock.i18n.LocalizableMessage tooltip,
                            LabelFieldDescriptor.FieldType type,
                            LabelFieldDescriptor.LabelType labelType,
                            int size)

Constructor of this LabelFieldDescriptor.

Parameters:

label - the String of the label.

tooltip - the tooltip of the field.

type - the type of field.

labelType - the type of label.

size - the size of the field.

Method Detail

getLabel

public org.forgerock.i18n.LocalizableMessage getLabel()

Returns the String displayed by the label.

Returns:

the String displayed by the label.

getSize

public int getSize()

Returns the size of the field.

Returns:

the size of the field.

getTooltip

public org.forgerock.i18n.LocalizableMessage getTooltip()

Returns the tooltip used in the field.

Returns:

the tooltip used in the field.

getType

public LabelFieldDescriptor.FieldType getType()

Returns the field type.

Returns:

the field type.

getLabelType

public LabelFieldDescriptor.LabelType getLabelType()

Returns the label type.

Returns:

the label type.